Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoTSecureTunneling.OpenTunnel

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new tunnel, and returns two client access tokens for clients to use to connect to the AWS IoT Secure Tunneling proxy server.

Synopsis

data OpenTunnel = OpenTunnel' {
- destinationConfig :: Maybe DestinationConfig
- description :: Maybe Text
- timeoutConfig :: Maybe TimeoutConfig
- tags :: Maybe (NonEmpty Tag)
}
newOpenTunnel :: OpenTunnel
openTunnel_destinationConfig :: Lens' OpenTunnel (Maybe DestinationConfig)
openTunnel_description :: Lens' OpenTunnel (Maybe Text)
openTunnel_timeoutConfig :: Lens' OpenTunnel (Maybe TimeoutConfig)
openTunnel_tags :: Lens' OpenTunnel (Maybe (NonEmpty Tag))
data OpenTunnelResponse = OpenTunnelResponse' {
- sourceAccessToken :: Maybe (Sensitive Text)
- tunnelArn :: Maybe Text
- destinationAccessToken :: Maybe (Sensitive Text)
- tunnelId :: Maybe Text
- httpStatus :: Int
}
newOpenTunnelResponse :: Int -> OpenTunnelResponse
openTunnelResponse_sourceAccessToken :: Lens' OpenTunnelResponse (Maybe Text)
openTunnelResponse_tunnelArn :: Lens' OpenTunnelResponse (Maybe Text)
openTunnelResponse_destinationAccessToken :: Lens' OpenTunnelResponse (Maybe Text)
openTunnelResponse_tunnelId :: Lens' OpenTunnelResponse (Maybe Text)
openTunnelResponse_httpStatus :: Lens' OpenTunnelResponse Int

Creating a Request

data OpenTunnel Source #

See: newOpenTunnel smart constructor.

Constructors

OpenTunnel'
Fields destinationConfig :: Maybe DestinationConfig The destination configuration for the OpenTunnel request. description :: Maybe Text A short text description of the tunnel. timeoutConfig :: Maybe TimeoutConfig Timeout configuration for a tunnel. tags :: Maybe (NonEmpty Tag) A collection of tag metadata.

Instances

Instances details

Eq OpenTunnel Source #
Instance details Defined in Amazonka.IoTSecureTunneling.OpenTunnel Methods (==) :: OpenTunnel -> OpenTunnel -> Bool # (/=) :: OpenTunnel -> OpenTunnel -> Bool #
Read OpenTunnel Source #
Instance details Defined in Amazonka.IoTSecureTunneling.OpenTunnel Methods readsPrec :: Int -> ReadS OpenTunnel # readList :: ReadS [OpenTunnel] # readPrec :: ReadPrec OpenTunnel # readListPrec :: ReadPrec [OpenTunnel] #
Show OpenTunnel Source #
Instance details Defined in Amazonka.IoTSecureTunneling.OpenTunnel Methods showsPrec :: Int -> OpenTunnel -> ShowS # show :: OpenTunnel -> String # showList :: [OpenTunnel] -> ShowS #
Generic OpenTunnel Source #
Instance details Defined in Amazonka.IoTSecureTunneling.OpenTunnel Associated Types type Rep OpenTunnel :: Type -> Type # Methods from :: OpenTunnel -> Rep OpenTunnel x # to :: Rep OpenTunnel x -> OpenTunnel #
NFData OpenTunnel Source #
Instance details Defined in Amazonka.IoTSecureTunneling.OpenTunnel Methods rnf :: OpenTunnel -> () #
Hashable OpenTunnel Source #
Instance details Defined in Amazonka.IoTSecureTunneling.OpenTunnel Methods hashWithSalt :: Int -> OpenTunnel -> Int # hash :: OpenTunnel -> Int #
ToJSON OpenTunnel Source #
Instance details Defined in Amazonka.IoTSecureTunneling.OpenTunnel Methods toJSON :: OpenTunnel -> Value # toEncoding :: OpenTunnel -> Encoding # toJSONList :: [OpenTunnel] -> Value # toEncodingList :: [OpenTunnel] -> Encoding #
AWSRequest OpenTunnel Source #
Instance details Defined in Amazonka.IoTSecureTunneling.OpenTunnel Associated Types type AWSResponse OpenTunnel # Methods request :: OpenTunnel -> Request OpenTunnel # response :: MonadResource m => Logger -> Service -> Proxy OpenTunnel -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse OpenTunnel))) #
ToHeaders OpenTunnel Source #
Instance details Defined in Amazonka.IoTSecureTunneling.OpenTunnel Methods toHeaders :: OpenTunnel -> [Header] #
ToPath OpenTunnel Source #
Instance details Defined in Amazonka.IoTSecureTunneling.OpenTunnel Methods toPath :: OpenTunnel -> ByteString #
ToQuery OpenTunnel Source #
Instance details Defined in Amazonka.IoTSecureTunneling.OpenTunnel Methods toQuery :: OpenTunnel -> QueryString #
type Rep OpenTunnel Source #
Instance details Defined in Amazonka.IoTSecureTunneling.OpenTunnel type Rep OpenTunnel = D1 ('MetaData "OpenTunnel" "Amazonka.IoTSecureTunneling.OpenTunnel" "libZSservicesZSamazonka-iotsecuretunnelingZSamazonka-iotsecuretunneling" 'False) (C1 ('MetaCons "OpenTunnel'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "destinationConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DestinationConfig)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "timeoutConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeoutConfig)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))))))
type AWSResponse OpenTunnel Source #
Instance details Defined in Amazonka.IoTSecureTunneling.OpenTunnel type AWSResponse OpenTunnel = OpenTunnelResponse

newOpenTunnel :: OpenTunnel Source #

Create a value of OpenTunnel with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:destinationConfig:OpenTunnel', openTunnel_destinationConfig - The destination configuration for the OpenTunnel request.

$sel:description:OpenTunnel', openTunnel_description - A short text description of the tunnel.

$sel:timeoutConfig:OpenTunnel', openTunnel_timeoutConfig - Timeout configuration for a tunnel.

$sel:tags:OpenTunnel', openTunnel_tags - A collection of tag metadata.

Request Lenses

openTunnel_destinationConfig :: Lens' OpenTunnel (Maybe DestinationConfig) Source #

The destination configuration for the OpenTunnel request.

openTunnel_description :: Lens' OpenTunnel (Maybe Text) Source #

A short text description of the tunnel.

openTunnel_timeoutConfig :: Lens' OpenTunnel (Maybe TimeoutConfig) Source #

Timeout configuration for a tunnel.

openTunnel_tags :: Lens' OpenTunnel (Maybe (NonEmpty Tag)) Source #

A collection of tag metadata.

Destructuring the Response

data OpenTunnelResponse Source #

See: newOpenTunnelResponse smart constructor.

Constructors

OpenTunnelResponse'

Fields

sourceAccessToken :: Maybe (Sensitive Text)
The access token the source local proxy uses to connect to AWS IoT Secure Tunneling.
tunnelArn :: Maybe Text
The Amazon Resource Name for the tunnel. The tunnel ARN format is arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id>
destinationAccessToken :: Maybe (Sensitive Text)
The access token the destination local proxy uses to connect to AWS IoT Secure Tunneling.
tunnelId :: Maybe Text
A unique alpha-numeric tunnel ID.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq OpenTunnelResponse Source #
Instance details Defined in Amazonka.IoTSecureTunneling.OpenTunnel Methods (==) :: OpenTunnelResponse -> OpenTunnelResponse -> Bool # (/=) :: OpenTunnelResponse -> OpenTunnelResponse -> Bool #
Show OpenTunnelResponse Source #
Instance details Defined in Amazonka.IoTSecureTunneling.OpenTunnel Methods showsPrec :: Int -> OpenTunnelResponse -> ShowS # show :: OpenTunnelResponse -> String # showList :: [OpenTunnelResponse] -> ShowS #
Generic OpenTunnelResponse Source #
Instance details Defined in Amazonka.IoTSecureTunneling.OpenTunnel Associated Types type Rep OpenTunnelResponse :: Type -> Type # Methods from :: OpenTunnelResponse -> Rep OpenTunnelResponse x # to :: Rep OpenTunnelResponse x -> OpenTunnelResponse #
NFData OpenTunnelResponse Source #
Instance details Defined in Amazonka.IoTSecureTunneling.OpenTunnel Methods rnf :: OpenTunnelResponse -> () #
type Rep OpenTunnelResponse Source #
Instance details Defined in Amazonka.IoTSecureTunneling.OpenTunnel type Rep OpenTunnelResponse = D1 ('MetaData "OpenTunnelResponse" "Amazonka.IoTSecureTunneling.OpenTunnel" "libZSservicesZSamazonka-iotsecuretunnelingZSamazonka-iotsecuretunneling" 'False) (C1 ('MetaCons "OpenTunnelResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sourceAccessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "tunnelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "destinationAccessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "tunnelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newOpenTunnelResponse Source #

Arguments

:: Int	`$sel:httpStatus:OpenTunnelResponse'`
-> OpenTunnelResponse

Create a value of OpenTunnelResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sourceAccessToken:OpenTunnelResponse', openTunnelResponse_sourceAccessToken - The access token the source local proxy uses to connect to AWS IoT Secure Tunneling.

$sel:tunnelArn:OpenTunnelResponse', openTunnelResponse_tunnelArn - The Amazon Resource Name for the tunnel. The tunnel ARN format is arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id>

$sel:destinationAccessToken:OpenTunnelResponse', openTunnelResponse_destinationAccessToken - The access token the destination local proxy uses to connect to AWS IoT Secure Tunneling.

$sel:tunnelId:OpenTunnelResponse', openTunnelResponse_tunnelId - A unique alpha-numeric tunnel ID.

$sel:httpStatus:OpenTunnelResponse', openTunnelResponse_httpStatus - The response's http status code.

Response Lenses

openTunnelResponse_sourceAccessToken :: Lens' OpenTunnelResponse (Maybe Text) Source #

The access token the source local proxy uses to connect to AWS IoT Secure Tunneling.

openTunnelResponse_tunnelArn :: Lens' OpenTunnelResponse (Maybe Text) Source #

The Amazon Resource Name for the tunnel. The tunnel ARN format is arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id>

openTunnelResponse_destinationAccessToken :: Lens' OpenTunnelResponse (Maybe Text) Source #

The access token the destination local proxy uses to connect to AWS IoT Secure Tunneling.

openTunnelResponse_tunnelId :: Lens' OpenTunnelResponse (Maybe Text) Source #

A unique alpha-numeric tunnel ID.

openTunnelResponse_httpStatus :: Lens' OpenTunnelResponse Int Source #

The response's http status code.