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.Types

Contents

Service Configuration
Errors
ConnectionStatus
TunnelStatus
ConnectionState
DestinationConfig
Tag
TimeoutConfig
Tunnel
TunnelSummary

Description

Synopsis

defaultService :: Service
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
newtype ConnectionStatus where
- ConnectionStatus' {
  - fromConnectionStatus :: Text
  }
- pattern ConnectionStatus_CONNECTED :: ConnectionStatus
- pattern ConnectionStatus_DISCONNECTED :: ConnectionStatus
newtype TunnelStatus where
- TunnelStatus' {
  - fromTunnelStatus :: Text
  }
- pattern TunnelStatus_CLOSED :: TunnelStatus
- pattern TunnelStatus_OPEN :: TunnelStatus
data ConnectionState = ConnectionState' {
- status :: Maybe ConnectionStatus
- lastUpdatedAt :: Maybe POSIX
}
newConnectionState :: ConnectionState
connectionState_status :: Lens' ConnectionState (Maybe ConnectionStatus)
connectionState_lastUpdatedAt :: Lens' ConnectionState (Maybe UTCTime)
data DestinationConfig = DestinationConfig' {
- thingName :: Maybe Text
- services :: NonEmpty Text
}
newDestinationConfig :: NonEmpty Text -> DestinationConfig
destinationConfig_thingName :: Lens' DestinationConfig (Maybe Text)
destinationConfig_services :: Lens' DestinationConfig (NonEmpty Text)
data Tag = Tag' {
- key :: Text
- value :: Text
}
newTag :: Text -> Text -> Tag
tag_key :: Lens' Tag Text
tag_value :: Lens' Tag Text
data TimeoutConfig = TimeoutConfig' {
- maxLifetimeTimeoutMinutes :: Maybe Natural
}
newTimeoutConfig :: TimeoutConfig
timeoutConfig_maxLifetimeTimeoutMinutes :: Lens' TimeoutConfig (Maybe Natural)
data Tunnel = Tunnel' {
- status :: Maybe TunnelStatus
- lastUpdatedAt :: Maybe POSIX
- createdAt :: Maybe POSIX
- tunnelArn :: Maybe Text
- sourceConnectionState :: Maybe ConnectionState
- destinationConnectionState :: Maybe ConnectionState
- tunnelId :: Maybe Text
- destinationConfig :: Maybe DestinationConfig
- description :: Maybe Text
- timeoutConfig :: Maybe TimeoutConfig
- tags :: Maybe (NonEmpty Tag)
}
newTunnel :: Tunnel
tunnel_status :: Lens' Tunnel (Maybe TunnelStatus)
tunnel_lastUpdatedAt :: Lens' Tunnel (Maybe UTCTime)
tunnel_createdAt :: Lens' Tunnel (Maybe UTCTime)
tunnel_tunnelArn :: Lens' Tunnel (Maybe Text)
tunnel_sourceConnectionState :: Lens' Tunnel (Maybe ConnectionState)
tunnel_destinationConnectionState :: Lens' Tunnel (Maybe ConnectionState)
tunnel_tunnelId :: Lens' Tunnel (Maybe Text)
tunnel_destinationConfig :: Lens' Tunnel (Maybe DestinationConfig)
tunnel_description :: Lens' Tunnel (Maybe Text)
tunnel_timeoutConfig :: Lens' Tunnel (Maybe TimeoutConfig)
tunnel_tags :: Lens' Tunnel (Maybe (NonEmpty Tag))
data TunnelSummary = TunnelSummary' {
- status :: Maybe TunnelStatus
- lastUpdatedAt :: Maybe POSIX
- createdAt :: Maybe POSIX
- tunnelArn :: Maybe Text
- tunnelId :: Maybe Text
- description :: Maybe Text
}
newTunnelSummary :: TunnelSummary
tunnelSummary_status :: Lens' TunnelSummary (Maybe TunnelStatus)
tunnelSummary_lastUpdatedAt :: Lens' TunnelSummary (Maybe UTCTime)
tunnelSummary_createdAt :: Lens' TunnelSummary (Maybe UTCTime)
tunnelSummary_tunnelArn :: Lens' TunnelSummary (Maybe Text)
tunnelSummary_tunnelId :: Lens' TunnelSummary (Maybe Text)
tunnelSummary_description :: Lens' TunnelSummary (Maybe Text)

Service Configuration

defaultService :: Service Source #

API version 2018-10-05 of the Amazon IoT Secure Tunneling SDK configuration.

Errors

_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Thrown when an operation is attempted on a resource that does not exist.

_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Thrown when a tunnel limit is exceeded.

ConnectionStatus

newtype ConnectionStatus Source #

Constructors

ConnectionStatus'
Fields fromConnectionStatus :: Text

Bundled Patterns

pattern ConnectionStatus_CONNECTED :: ConnectionStatus
pattern ConnectionStatus_DISCONNECTED :: ConnectionStatus

Instances

Instances details

Eq ConnectionStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus Methods (==) :: ConnectionStatus -> ConnectionStatus -> Bool # (/=) :: ConnectionStatus -> ConnectionStatus -> Bool #
Ord ConnectionStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus Methods compare :: ConnectionStatus -> ConnectionStatus -> Ordering # (<) :: ConnectionStatus -> ConnectionStatus -> Bool # (<=) :: ConnectionStatus -> ConnectionStatus -> Bool # (>) :: ConnectionStatus -> ConnectionStatus -> Bool # (>=) :: ConnectionStatus -> ConnectionStatus -> Bool # max :: ConnectionStatus -> ConnectionStatus -> ConnectionStatus # min :: ConnectionStatus -> ConnectionStatus -> ConnectionStatus #
Read ConnectionStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus Methods readsPrec :: Int -> ReadS ConnectionStatus # readList :: ReadS [ConnectionStatus] # readPrec :: ReadPrec ConnectionStatus # readListPrec :: ReadPrec [ConnectionStatus] #
Show ConnectionStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus Methods showsPrec :: Int -> ConnectionStatus -> ShowS # show :: ConnectionStatus -> String # showList :: [ConnectionStatus] -> ShowS #
Generic ConnectionStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus Associated Types type Rep ConnectionStatus :: Type -> Type # Methods from :: ConnectionStatus -> Rep ConnectionStatus x # to :: Rep ConnectionStatus x -> ConnectionStatus #
NFData ConnectionStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus Methods rnf :: ConnectionStatus -> () #
Hashable ConnectionStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus Methods hashWithSalt :: Int -> ConnectionStatus -> Int # hash :: ConnectionStatus -> Int #
ToJSON ConnectionStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus Methods toJSON :: ConnectionStatus -> Value # toEncoding :: ConnectionStatus -> Encoding # toJSONList :: [ConnectionStatus] -> Value # toEncodingList :: [ConnectionStatus] -> Encoding #
ToJSONKey ConnectionStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus Methods toJSONKey :: ToJSONKeyFunction ConnectionStatus # toJSONKeyList :: ToJSONKeyFunction [ConnectionStatus] #
FromJSON ConnectionStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus Methods parseJSON :: Value -> Parser ConnectionStatus # parseJSONList :: Value -> Parser [ConnectionStatus] #
FromJSONKey ConnectionStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus Methods fromJSONKey :: FromJSONKeyFunction ConnectionStatus # fromJSONKeyList :: FromJSONKeyFunction [ConnectionStatus] #
ToLog ConnectionStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus Methods build :: ConnectionStatus -> ByteStringBuilder #
ToHeader ConnectionStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus Methods toHeader :: HeaderName -> ConnectionStatus -> [Header] #
ToQuery ConnectionStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus Methods toQuery :: ConnectionStatus -> QueryString #
FromXML ConnectionStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus Methods parseXML :: [Node] -> Either String ConnectionStatus #
ToXML ConnectionStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus Methods toXML :: ConnectionStatus -> XML #
ToByteString ConnectionStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus Methods toBS :: ConnectionStatus -> ByteString #
FromText ConnectionStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus Methods fromText :: Text -> Either String ConnectionStatus #
ToText ConnectionStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus Methods toText :: ConnectionStatus -> Text #
type Rep ConnectionStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus type Rep ConnectionStatus = D1 ('MetaData "ConnectionStatus" "Amazonka.IoTSecureTunneling.Types.ConnectionStatus" "libZSservicesZSamazonka-iotsecuretunnelingZSamazonka-iotsecuretunneling" 'True) (C1 ('MetaCons "ConnectionStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromConnectionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

TunnelStatus

newtype TunnelStatus Source #

Constructors

TunnelStatus'
Fields fromTunnelStatus :: Text

Bundled Patterns

pattern TunnelStatus_CLOSED :: TunnelStatus
pattern TunnelStatus_OPEN :: TunnelStatus

Instances

Instances details

Eq TunnelStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus Methods (==) :: TunnelStatus -> TunnelStatus -> Bool # (/=) :: TunnelStatus -> TunnelStatus -> Bool #
Ord TunnelStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus Methods compare :: TunnelStatus -> TunnelStatus -> Ordering # (<) :: TunnelStatus -> TunnelStatus -> Bool # (<=) :: TunnelStatus -> TunnelStatus -> Bool # (>) :: TunnelStatus -> TunnelStatus -> Bool # (>=) :: TunnelStatus -> TunnelStatus -> Bool # max :: TunnelStatus -> TunnelStatus -> TunnelStatus # min :: TunnelStatus -> TunnelStatus -> TunnelStatus #
Read TunnelStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus Methods readsPrec :: Int -> ReadS TunnelStatus # readList :: ReadS [TunnelStatus] # readPrec :: ReadPrec TunnelStatus # readListPrec :: ReadPrec [TunnelStatus] #
Show TunnelStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus Methods showsPrec :: Int -> TunnelStatus -> ShowS # show :: TunnelStatus -> String # showList :: [TunnelStatus] -> ShowS #
Generic TunnelStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus Associated Types type Rep TunnelStatus :: Type -> Type # Methods from :: TunnelStatus -> Rep TunnelStatus x # to :: Rep TunnelStatus x -> TunnelStatus #
NFData TunnelStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus Methods rnf :: TunnelStatus -> () #
Hashable TunnelStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus Methods hashWithSalt :: Int -> TunnelStatus -> Int # hash :: TunnelStatus -> Int #
ToJSON TunnelStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus Methods toJSON :: TunnelStatus -> Value # toEncoding :: TunnelStatus -> Encoding # toJSONList :: [TunnelStatus] -> Value # toEncodingList :: [TunnelStatus] -> Encoding #
ToJSONKey TunnelStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus Methods toJSONKey :: ToJSONKeyFunction TunnelStatus # toJSONKeyList :: ToJSONKeyFunction [TunnelStatus] #
FromJSON TunnelStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus Methods parseJSON :: Value -> Parser TunnelStatus # parseJSONList :: Value -> Parser [TunnelStatus] #
FromJSONKey TunnelStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus Methods fromJSONKey :: FromJSONKeyFunction TunnelStatus # fromJSONKeyList :: FromJSONKeyFunction [TunnelStatus] #
ToLog TunnelStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus Methods build :: TunnelStatus -> ByteStringBuilder #
ToHeader TunnelStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus Methods toHeader :: HeaderName -> TunnelStatus -> [Header] #
ToQuery TunnelStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus Methods toQuery :: TunnelStatus -> QueryString #
FromXML TunnelStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus Methods parseXML :: [Node] -> Either String TunnelStatus #
ToXML TunnelStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus Methods toXML :: TunnelStatus -> XML #
ToByteString TunnelStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus Methods toBS :: TunnelStatus -> ByteString #
FromText TunnelStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus Methods fromText :: Text -> Either String TunnelStatus #
ToText TunnelStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus Methods toText :: TunnelStatus -> Text #
type Rep TunnelStatus Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus type Rep TunnelStatus = D1 ('MetaData "TunnelStatus" "Amazonka.IoTSecureTunneling.Types.TunnelStatus" "libZSservicesZSamazonka-iotsecuretunnelingZSamazonka-iotsecuretunneling" 'True) (C1 ('MetaCons "TunnelStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromTunnelStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ConnectionState

data ConnectionState Source #

The state of a connection.

See: newConnectionState smart constructor.

Constructors

ConnectionState'
Fields status :: Maybe ConnectionStatus The connection status of the tunnel. Valid values are `CONNECTED` and `DISCONNECTED`. lastUpdatedAt :: Maybe POSIX The last time the connection status was updated.

Instances

Instances details

Eq ConnectionState Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.ConnectionState Methods (==) :: ConnectionState -> ConnectionState -> Bool # (/=) :: ConnectionState -> ConnectionState -> Bool #
Read ConnectionState Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.ConnectionState Methods readsPrec :: Int -> ReadS ConnectionState # readList :: ReadS [ConnectionState] # readPrec :: ReadPrec ConnectionState # readListPrec :: ReadPrec [ConnectionState] #
Show ConnectionState Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.ConnectionState Methods showsPrec :: Int -> ConnectionState -> ShowS # show :: ConnectionState -> String # showList :: [ConnectionState] -> ShowS #
Generic ConnectionState Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.ConnectionState Associated Types type Rep ConnectionState :: Type -> Type # Methods from :: ConnectionState -> Rep ConnectionState x # to :: Rep ConnectionState x -> ConnectionState #
NFData ConnectionState Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.ConnectionState Methods rnf :: ConnectionState -> () #
Hashable ConnectionState Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.ConnectionState Methods hashWithSalt :: Int -> ConnectionState -> Int # hash :: ConnectionState -> Int #
FromJSON ConnectionState Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.ConnectionState Methods parseJSON :: Value -> Parser ConnectionState # parseJSONList :: Value -> Parser [ConnectionState] #
type Rep ConnectionState Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.ConnectionState type Rep ConnectionState = D1 ('MetaData "ConnectionState" "Amazonka.IoTSecureTunneling.Types.ConnectionState" "libZSservicesZSamazonka-iotsecuretunnelingZSamazonka-iotsecuretunneling" 'False) (C1 ('MetaCons "ConnectionState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectionStatus)) :*: S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))

newConnectionState :: ConnectionState Source #

Create a value of ConnectionState 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:status:ConnectionState', connectionState_status - The connection status of the tunnel. Valid values are CONNECTED and DISCONNECTED.

$sel:lastUpdatedAt:ConnectionState', connectionState_lastUpdatedAt - The last time the connection status was updated.

connectionState_status :: Lens' ConnectionState (Maybe ConnectionStatus) Source #

The connection status of the tunnel. Valid values are CONNECTED and DISCONNECTED.

connectionState_lastUpdatedAt :: Lens' ConnectionState (Maybe UTCTime) Source #

The last time the connection status was updated.

DestinationConfig

data DestinationConfig Source #

The destination configuration.

See: newDestinationConfig smart constructor.

Constructors

DestinationConfig'

Fields

thingName :: Maybe Text
The name of the IoT thing to which you want to connect.
services :: NonEmpty Text
A list of service names that identity the target application. The AWS IoT client running on the destination device reads this value and uses it to look up a port or an IP address and a port. The AWS IoT client instantiates the local proxy which uses this information to connect to the destination application.

Instances

Instances details

Eq DestinationConfig Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.DestinationConfig Methods (==) :: DestinationConfig -> DestinationConfig -> Bool # (/=) :: DestinationConfig -> DestinationConfig -> Bool #
Read DestinationConfig Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.DestinationConfig Methods readsPrec :: Int -> ReadS DestinationConfig # readList :: ReadS [DestinationConfig] # readPrec :: ReadPrec DestinationConfig # readListPrec :: ReadPrec [DestinationConfig] #
Show DestinationConfig Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.DestinationConfig Methods showsPrec :: Int -> DestinationConfig -> ShowS # show :: DestinationConfig -> String # showList :: [DestinationConfig] -> ShowS #
Generic DestinationConfig Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.DestinationConfig Associated Types type Rep DestinationConfig :: Type -> Type # Methods from :: DestinationConfig -> Rep DestinationConfig x # to :: Rep DestinationConfig x -> DestinationConfig #
NFData DestinationConfig Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.DestinationConfig Methods rnf :: DestinationConfig -> () #
Hashable DestinationConfig Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.DestinationConfig Methods hashWithSalt :: Int -> DestinationConfig -> Int # hash :: DestinationConfig -> Int #
ToJSON DestinationConfig Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.DestinationConfig Methods toJSON :: DestinationConfig -> Value # toEncoding :: DestinationConfig -> Encoding # toJSONList :: [DestinationConfig] -> Value # toEncodingList :: [DestinationConfig] -> Encoding #
FromJSON DestinationConfig Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.DestinationConfig Methods parseJSON :: Value -> Parser DestinationConfig # parseJSONList :: Value -> Parser [DestinationConfig] #
type Rep DestinationConfig Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.DestinationConfig type Rep DestinationConfig = D1 ('MetaData "DestinationConfig" "Amazonka.IoTSecureTunneling.Types.DestinationConfig" "libZSservicesZSamazonka-iotsecuretunnelingZSamazonka-iotsecuretunneling" 'False) (C1 ('MetaCons "DestinationConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "thingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "services") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))

newDestinationConfig Source #

Arguments

:: NonEmpty Text	`$sel:services:DestinationConfig'`
-> DestinationConfig

Create a value of DestinationConfig 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:thingName:DestinationConfig', destinationConfig_thingName - The name of the IoT thing to which you want to connect.

$sel:services:DestinationConfig', destinationConfig_services - A list of service names that identity the target application. The AWS IoT client running on the destination device reads this value and uses it to look up a port or an IP address and a port. The AWS IoT client instantiates the local proxy which uses this information to connect to the destination application.

destinationConfig_thingName :: Lens' DestinationConfig (Maybe Text) Source #

The name of the IoT thing to which you want to connect.

destinationConfig_services :: Lens' DestinationConfig (NonEmpty Text) Source #

A list of service names that identity the target application. The AWS IoT client running on the destination device reads this value and uses it to look up a port or an IP address and a port. The AWS IoT client instantiates the local proxy which uses this information to connect to the destination application.

Tag

data Tag Source #

An arbitary key/value pair used to add searchable metadata to secure tunnel resources.

See: newTag smart constructor.

Constructors

Tag'
Fields key :: Text The key of the tag. value :: Text The value of the tag.

Instances

Instances details

Eq Tag Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.Tag Methods (==) :: Tag -> Tag -> Bool # (/=) :: Tag -> Tag -> Bool #
Read Tag Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.Tag Methods readsPrec :: Int -> ReadS Tag # readList :: ReadS [Tag] # readPrec :: ReadPrec Tag # readListPrec :: ReadPrec [Tag] #
Show Tag Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.Tag Methods showsPrec :: Int -> Tag -> ShowS # show :: Tag -> String # showList :: [Tag] -> ShowS #
Generic Tag Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.Tag Associated Types type Rep Tag :: Type -> Type # Methods from :: Tag -> Rep Tag x # to :: Rep Tag x -> Tag #
NFData Tag Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.Tag Methods rnf :: Tag -> () #
Hashable Tag Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.Tag Methods hashWithSalt :: Int -> Tag -> Int # hash :: Tag -> Int #
ToJSON Tag Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.Tag Methods toJSON :: Tag -> Value # toEncoding :: Tag -> Encoding # toJSONList :: [Tag] -> Value # toEncodingList :: [Tag] -> Encoding #
FromJSON Tag Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.Tag Methods parseJSON :: Value -> Parser Tag # parseJSONList :: Value -> Parser [Tag] #
type Rep Tag Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.IoTSecureTunneling.Types.Tag" "libZSservicesZSamazonka-iotsecuretunnelingZSamazonka-iotsecuretunneling" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newTag Source #

Arguments

:: Text	`$sel:key:Tag'`
-> Text	`$sel:value:Tag'`
-> Tag

Create a value of Tag 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:key:Tag', tag_key - The key of the tag.

$sel:value:Tag', tag_value - The value of the tag.

tag_key :: Lens' Tag Text Source #

The key of the tag.

tag_value :: Lens' Tag Text Source #

The value of the tag.

TimeoutConfig

data TimeoutConfig Source #

Tunnel timeout configuration.

See: newTimeoutConfig smart constructor.

Constructors

TimeoutConfig'
Fields maxLifetimeTimeoutMinutes :: Maybe Natural The maximum amount of time (in minutes) a tunnel can remain open. If not specified, maxLifetimeTimeoutMinutes defaults to 720 minutes. Valid values are from 1 minute to 12 hours (720 minutes)

Instances

Instances details

Eq TimeoutConfig Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TimeoutConfig Methods (==) :: TimeoutConfig -> TimeoutConfig -> Bool # (/=) :: TimeoutConfig -> TimeoutConfig -> Bool #
Read TimeoutConfig Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TimeoutConfig Methods readsPrec :: Int -> ReadS TimeoutConfig # readList :: ReadS [TimeoutConfig] # readPrec :: ReadPrec TimeoutConfig # readListPrec :: ReadPrec [TimeoutConfig] #
Show TimeoutConfig Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TimeoutConfig Methods showsPrec :: Int -> TimeoutConfig -> ShowS # show :: TimeoutConfig -> String # showList :: [TimeoutConfig] -> ShowS #
Generic TimeoutConfig Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TimeoutConfig Associated Types type Rep TimeoutConfig :: Type -> Type # Methods from :: TimeoutConfig -> Rep TimeoutConfig x # to :: Rep TimeoutConfig x -> TimeoutConfig #
NFData TimeoutConfig Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TimeoutConfig Methods rnf :: TimeoutConfig -> () #
Hashable TimeoutConfig Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TimeoutConfig Methods hashWithSalt :: Int -> TimeoutConfig -> Int # hash :: TimeoutConfig -> Int #
ToJSON TimeoutConfig Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TimeoutConfig Methods toJSON :: TimeoutConfig -> Value # toEncoding :: TimeoutConfig -> Encoding # toJSONList :: [TimeoutConfig] -> Value # toEncodingList :: [TimeoutConfig] -> Encoding #
FromJSON TimeoutConfig Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TimeoutConfig Methods parseJSON :: Value -> Parser TimeoutConfig # parseJSONList :: Value -> Parser [TimeoutConfig] #
type Rep TimeoutConfig Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TimeoutConfig type Rep TimeoutConfig = D1 ('MetaData "TimeoutConfig" "Amazonka.IoTSecureTunneling.Types.TimeoutConfig" "libZSservicesZSamazonka-iotsecuretunnelingZSamazonka-iotsecuretunneling" 'False) (C1 ('MetaCons "TimeoutConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxLifetimeTimeoutMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))

newTimeoutConfig :: TimeoutConfig Source #

Create a value of TimeoutConfig 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:maxLifetimeTimeoutMinutes:TimeoutConfig', timeoutConfig_maxLifetimeTimeoutMinutes - The maximum amount of time (in minutes) a tunnel can remain open. If not specified, maxLifetimeTimeoutMinutes defaults to 720 minutes. Valid values are from 1 minute to 12 hours (720 minutes)

timeoutConfig_maxLifetimeTimeoutMinutes :: Lens' TimeoutConfig (Maybe Natural) Source #

The maximum amount of time (in minutes) a tunnel can remain open. If not specified, maxLifetimeTimeoutMinutes defaults to 720 minutes. Valid values are from 1 minute to 12 hours (720 minutes)

Tunnel

data Tunnel Source #

A connection between a source computer and a destination device.

See: newTunnel smart constructor.

Constructors

Tunnel'

Fields

status :: Maybe TunnelStatus
The status of a tunnel. Valid values are: Open and Closed.
lastUpdatedAt :: Maybe POSIX
The last time the tunnel was updated.
createdAt :: Maybe POSIX
The time when the tunnel was created.
tunnelArn :: Maybe Text
The Amazon Resource Name (ARN) of a tunnel. The tunnel ARN format is arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id>
sourceConnectionState :: Maybe ConnectionState
The connection state of the source application.
destinationConnectionState :: Maybe ConnectionState
The connection state of the destination application.
tunnelId :: Maybe Text
A unique alpha-numeric ID that identifies a tunnel.
destinationConfig :: Maybe DestinationConfig
The destination configuration that specifies the thing name of the destination device and a service name that the local proxy uses to connect to the destination application.
description :: Maybe Text
A description of the tunnel.
timeoutConfig :: Maybe TimeoutConfig
Timeout configuration for the tunnel.
tags :: Maybe (NonEmpty Tag)
A list of tag metadata associated with the secure tunnel.

Instances

Instances details

Eq Tunnel Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.Tunnel Methods (==) :: Tunnel -> Tunnel -> Bool # (/=) :: Tunnel -> Tunnel -> Bool #
Read Tunnel Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.Tunnel Methods readsPrec :: Int -> ReadS Tunnel # readList :: ReadS [Tunnel] # readPrec :: ReadPrec Tunnel # readListPrec :: ReadPrec [Tunnel] #
Show Tunnel Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.Tunnel Methods showsPrec :: Int -> Tunnel -> ShowS # show :: Tunnel -> String # showList :: [Tunnel] -> ShowS #
Generic Tunnel Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.Tunnel Associated Types type Rep Tunnel :: Type -> Type # Methods from :: Tunnel -> Rep Tunnel x # to :: Rep Tunnel x -> Tunnel #
NFData Tunnel Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.Tunnel Methods rnf :: Tunnel -> () #
Hashable Tunnel Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.Tunnel Methods hashWithSalt :: Int -> Tunnel -> Int # hash :: Tunnel -> Int #
FromJSON Tunnel Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.Tunnel Methods parseJSON :: Value -> Parser Tunnel # parseJSONList :: Value -> Parser [Tunnel] #
type Rep Tunnel Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.Tunnel type Rep Tunnel = D1 ('MetaData "Tunnel" "Amazonka.IoTSecureTunneling.Types.Tunnel" "libZSservicesZSamazonka-iotsecuretunnelingZSamazonka-iotsecuretunneling" 'False) (C1 ('MetaCons "Tunnel'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TunnelStatus)) :: S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "tunnelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sourceConnectionState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectionState))))) :: ((S1 ('MetaSel ('Just "destinationConnectionState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectionState)) :: (S1 ('MetaSel ('Just "tunnelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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))))))))

newTunnel :: Tunnel Source #

Create a value of Tunnel 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:status:Tunnel', tunnel_status - The status of a tunnel. Valid values are: Open and Closed.

$sel:lastUpdatedAt:Tunnel', tunnel_lastUpdatedAt - The last time the tunnel was updated.

$sel:createdAt:Tunnel', tunnel_createdAt - The time when the tunnel was created.

$sel:tunnelArn:Tunnel', tunnel_tunnelArn - The Amazon Resource Name (ARN) of a tunnel. The tunnel ARN format is arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id>

$sel:sourceConnectionState:Tunnel', tunnel_sourceConnectionState - The connection state of the source application.

$sel:destinationConnectionState:Tunnel', tunnel_destinationConnectionState - The connection state of the destination application.

$sel:tunnelId:Tunnel', tunnel_tunnelId - A unique alpha-numeric ID that identifies a tunnel.

$sel:destinationConfig:Tunnel', tunnel_destinationConfig - The destination configuration that specifies the thing name of the destination device and a service name that the local proxy uses to connect to the destination application.

$sel:description:Tunnel', tunnel_description - A description of the tunnel.

$sel:timeoutConfig:Tunnel', tunnel_timeoutConfig - Timeout configuration for the tunnel.

$sel:tags:Tunnel', tunnel_tags - A list of tag metadata associated with the secure tunnel.

tunnel_status :: Lens' Tunnel (Maybe TunnelStatus) Source #

The status of a tunnel. Valid values are: Open and Closed.

tunnel_lastUpdatedAt :: Lens' Tunnel (Maybe UTCTime) Source #

The last time the tunnel was updated.

tunnel_createdAt :: Lens' Tunnel (Maybe UTCTime) Source #

The time when the tunnel was created.

tunnel_tunnelArn :: Lens' Tunnel (Maybe Text) Source #

The Amazon Resource Name (ARN) of a tunnel. The tunnel ARN format is arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id>

tunnel_sourceConnectionState :: Lens' Tunnel (Maybe ConnectionState) Source #

The connection state of the source application.

tunnel_destinationConnectionState :: Lens' Tunnel (Maybe ConnectionState) Source #

The connection state of the destination application.

tunnel_tunnelId :: Lens' Tunnel (Maybe Text) Source #

A unique alpha-numeric ID that identifies a tunnel.

tunnel_destinationConfig :: Lens' Tunnel (Maybe DestinationConfig) Source #

The destination configuration that specifies the thing name of the destination device and a service name that the local proxy uses to connect to the destination application.

tunnel_description :: Lens' Tunnel (Maybe Text) Source #

A description of the tunnel.

tunnel_timeoutConfig :: Lens' Tunnel (Maybe TimeoutConfig) Source #

Timeout configuration for the tunnel.

tunnel_tags :: Lens' Tunnel (Maybe (NonEmpty Tag)) Source #

A list of tag metadata associated with the secure tunnel.

TunnelSummary

data TunnelSummary Source #

Information about the tunnel.

See: newTunnelSummary smart constructor.

Constructors

TunnelSummary'

Fields

status :: Maybe TunnelStatus
The status of a tunnel. Valid values are: Open and Closed.
lastUpdatedAt :: Maybe POSIX
The time the tunnel was last updated.
createdAt :: Maybe POSIX
The time the tunnel was created.
tunnelArn :: Maybe Text
The Amazon Resource Name of the tunnel. The tunnel ARN format is arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id>
tunnelId :: Maybe Text
The unique alpha-numeric identifier for the tunnel.
description :: Maybe Text
A description of the tunnel.

Instances

Instances details

Eq TunnelSummary Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TunnelSummary Methods (==) :: TunnelSummary -> TunnelSummary -> Bool # (/=) :: TunnelSummary -> TunnelSummary -> Bool #
Read TunnelSummary Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TunnelSummary Methods readsPrec :: Int -> ReadS TunnelSummary # readList :: ReadS [TunnelSummary] # readPrec :: ReadPrec TunnelSummary # readListPrec :: ReadPrec [TunnelSummary] #
Show TunnelSummary Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TunnelSummary Methods showsPrec :: Int -> TunnelSummary -> ShowS # show :: TunnelSummary -> String # showList :: [TunnelSummary] -> ShowS #
Generic TunnelSummary Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TunnelSummary Associated Types type Rep TunnelSummary :: Type -> Type # Methods from :: TunnelSummary -> Rep TunnelSummary x # to :: Rep TunnelSummary x -> TunnelSummary #
NFData TunnelSummary Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TunnelSummary Methods rnf :: TunnelSummary -> () #
Hashable TunnelSummary Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TunnelSummary Methods hashWithSalt :: Int -> TunnelSummary -> Int # hash :: TunnelSummary -> Int #
FromJSON TunnelSummary Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TunnelSummary Methods parseJSON :: Value -> Parser TunnelSummary # parseJSONList :: Value -> Parser [TunnelSummary] #
type Rep TunnelSummary Source #
Instance details Defined in Amazonka.IoTSecureTunneling.Types.TunnelSummary type Rep TunnelSummary = D1 ('MetaData "TunnelSummary" "Amazonka.IoTSecureTunneling.Types.TunnelSummary" "libZSservicesZSamazonka-iotsecuretunnelingZSamazonka-iotsecuretunneling" 'False) (C1 ('MetaCons "TunnelSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TunnelStatus)) :: (S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: (S1 ('MetaSel ('Just "tunnelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tunnelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newTunnelSummary :: TunnelSummary Source #

Create a value of TunnelSummary 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:status:TunnelSummary', tunnelSummary_status - The status of a tunnel. Valid values are: Open and Closed.

$sel:lastUpdatedAt:TunnelSummary', tunnelSummary_lastUpdatedAt - The time the tunnel was last updated.

$sel:createdAt:TunnelSummary', tunnelSummary_createdAt - The time the tunnel was created.

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

$sel:tunnelId:TunnelSummary', tunnelSummary_tunnelId - The unique alpha-numeric identifier for the tunnel.

$sel:description:TunnelSummary', tunnelSummary_description - A description of the tunnel.

tunnelSummary_status :: Lens' TunnelSummary (Maybe TunnelStatus) Source #

The status of a tunnel. Valid values are: Open and Closed.

tunnelSummary_lastUpdatedAt :: Lens' TunnelSummary (Maybe UTCTime) Source #

The time the tunnel was last updated.

tunnelSummary_createdAt :: Lens' TunnelSummary (Maybe UTCTime) Source #

The time the tunnel was created.

tunnelSummary_tunnelArn :: Lens' TunnelSummary (Maybe Text) Source #

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

tunnelSummary_tunnelId :: Lens' TunnelSummary (Maybe Text) Source #

The unique alpha-numeric identifier for the tunnel.

tunnelSummary_description :: Lens' TunnelSummary (Maybe Text) Source #

A description of the tunnel.