Amazonka.IoTSecureTunneling.Types

Service Configuration

defaultService :: Service

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

Errors

_LimitExceededException :: AsError a => Fold a ServiceError

Thrown when a tunnel limit is exceeded.

_ResourceNotFoundException :: AsError a => Fold a ServiceError

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

ClientMode

newtype ClientMode

Constructors

ClientMode'

Fields

• fromClientMode :: Text

Bundled Patterns

pattern ClientMode_ALL :: ClientMode

pattern ClientMode_DESTINATION :: ClientMode

pattern ClientMode_SOURCE :: ClientMode

Instances

FromJSON ClientMode

Defined in Amazonka.IoTSecureTunneling.Types.ClientMode

Methods

parseJSON :: Value -> Parser ClientMode

parseJSONList :: Value -> Parser [ClientMode]

FromJSONKey ClientMode

Defined in Amazonka.IoTSecureTunneling.Types.ClientMode

Methods

fromJSONKey :: FromJSONKeyFunction ClientMode

fromJSONKeyList :: FromJSONKeyFunction [ClientMode]

ToJSON ClientMode

Defined in Amazonka.IoTSecureTunneling.Types.ClientMode

Methods

toJSON :: ClientMode -> Value

toEncoding :: ClientMode -> Encoding

toJSONList :: [ClientMode] -> Value

toEncodingList :: [ClientMode] -> Encoding

ToJSONKey ClientMode

Defined in Amazonka.IoTSecureTunneling.Types.ClientMode

Methods

toJSONKey :: ToJSONKeyFunction ClientMode

toJSONKeyList :: ToJSONKeyFunction [ClientMode]

ToByteString ClientMode

Defined in Amazonka.IoTSecureTunneling.Types.ClientMode

Methods

toBS :: ClientMode -> ByteString

ToHeader ClientMode

Defined in Amazonka.IoTSecureTunneling.Types.ClientMode

Methods

toHeader :: HeaderName -> ClientMode -> [Header]

ToLog ClientMode

Defined in Amazonka.IoTSecureTunneling.Types.ClientMode

Methods

build :: ClientMode -> ByteStringBuilder

ToQuery ClientMode

Defined in Amazonka.IoTSecureTunneling.Types.ClientMode

Methods

toQuery :: ClientMode -> QueryString

FromText ClientMode

Defined in Amazonka.IoTSecureTunneling.Types.ClientMode

Methods

fromText :: Text -> Either String ClientMode

ToText ClientMode

Defined in Amazonka.IoTSecureTunneling.Types.ClientMode

Methods

toText :: ClientMode -> Text

FromXML ClientMode

Defined in Amazonka.IoTSecureTunneling.Types.ClientMode

Methods

parseXML :: [Node] -> Either String ClientMode

ToXML ClientMode

Defined in Amazonka.IoTSecureTunneling.Types.ClientMode

Methods

toXML :: ClientMode -> XML

Generic ClientMode

Defined in Amazonka.IoTSecureTunneling.Types.ClientMode

Associated Types

type Rep ClientMode :: Type -> Type

Methods

from :: ClientMode -> Rep ClientMode x

to :: Rep ClientMode x -> ClientMode

Read ClientMode

Defined in Amazonka.IoTSecureTunneling.Types.ClientMode

Methods

readsPrec :: Int -> ReadS ClientMode

readList :: ReadS [ClientMode]

readPrec :: ReadPrec ClientMode

readListPrec :: ReadPrec [ClientMode]

Show ClientMode

Defined in Amazonka.IoTSecureTunneling.Types.ClientMode

Methods

showsPrec :: Int -> ClientMode -> ShowS

show :: ClientMode -> String

showList :: [ClientMode] -> ShowS

NFData ClientMode

Defined in Amazonka.IoTSecureTunneling.Types.ClientMode

Methods

rnf :: ClientMode -> ()

Eq ClientMode

Defined in Amazonka.IoTSecureTunneling.Types.ClientMode

Methods

(==) :: ClientMode -> ClientMode -> Bool

(/=) :: ClientMode -> ClientMode -> Bool

Ord ClientMode

Defined in Amazonka.IoTSecureTunneling.Types.ClientMode

Methods

compare :: ClientMode -> ClientMode -> Ordering

(<) :: ClientMode -> ClientMode -> Bool

(<=) :: ClientMode -> ClientMode -> Bool

(>) :: ClientMode -> ClientMode -> Bool

(>=) :: ClientMode -> ClientMode -> Bool

max :: ClientMode -> ClientMode -> ClientMode

min :: ClientMode -> ClientMode -> ClientMode

Hashable ClientMode

Defined in Amazonka.IoTSecureTunneling.Types.ClientMode

Methods

hashWithSalt :: Int -> ClientMode -> Int

hash :: ClientMode -> Int

type Rep ClientMode

Defined in Amazonka.IoTSecureTunneling.Types.ClientMode

type Rep ClientMode = D1 ('MetaData "ClientMode" "Amazonka.IoTSecureTunneling.Types.ClientMode" "amazonka-iotsecuretunneling-2.0-B7tp11579Ld35NvrM5xQuK" 'True) (C1 ('MetaCons "ClientMode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromClientMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ConnectionStatus

newtype ConnectionStatus

Constructors

ConnectionStatus'

Fields

• fromConnectionStatus :: Text

Bundled Patterns

pattern ConnectionStatus_CONNECTED :: ConnectionStatus

pattern ConnectionStatus_DISCONNECTED :: ConnectionStatus

Instances

FromJSON ConnectionStatus

Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus

Methods

parseJSON :: Value -> Parser ConnectionStatus

parseJSONList :: Value -> Parser [ConnectionStatus]

FromJSONKey ConnectionStatus

Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus

Methods

fromJSONKey :: FromJSONKeyFunction ConnectionStatus

fromJSONKeyList :: FromJSONKeyFunction [ConnectionStatus]

ToJSON ConnectionStatus

Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus

Methods

toJSON :: ConnectionStatus -> Value

toEncoding :: ConnectionStatus -> Encoding

toJSONList :: [ConnectionStatus] -> Value

toEncodingList :: [ConnectionStatus] -> Encoding

ToJSONKey ConnectionStatus

Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus

Methods

toJSONKey :: ToJSONKeyFunction ConnectionStatus

toJSONKeyList :: ToJSONKeyFunction [ConnectionStatus]

ToByteString ConnectionStatus

Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus

Methods

toBS :: ConnectionStatus -> ByteString

ToHeader ConnectionStatus

Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus

Methods

toHeader :: HeaderName -> ConnectionStatus -> [Header]

ToLog ConnectionStatus

Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus

Methods

build :: ConnectionStatus -> ByteStringBuilder

ToQuery ConnectionStatus

Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus

Methods

toQuery :: ConnectionStatus -> QueryString

FromText ConnectionStatus

Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus

Methods

fromText :: Text -> Either String ConnectionStatus

ToText ConnectionStatus

Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus

Methods

toText :: ConnectionStatus -> Text

FromXML ConnectionStatus

Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus

Methods

parseXML :: [Node] -> Either String ConnectionStatus

ToXML ConnectionStatus

Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus

Methods

toXML :: ConnectionStatus -> XML

Generic ConnectionStatus

Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus

Associated Types

type Rep ConnectionStatus :: Type -> Type

Methods

from :: ConnectionStatus -> Rep ConnectionStatus x

to :: Rep ConnectionStatus x -> ConnectionStatus

Read ConnectionStatus

Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus

Methods

readsPrec :: Int -> ReadS ConnectionStatus

readList :: ReadS [ConnectionStatus]

readPrec :: ReadPrec ConnectionStatus

readListPrec :: ReadPrec [ConnectionStatus]

Show ConnectionStatus

Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus

Methods

showsPrec :: Int -> ConnectionStatus -> ShowS

show :: ConnectionStatus -> String

showList :: [ConnectionStatus] -> ShowS

NFData ConnectionStatus

Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus

Methods

rnf :: ConnectionStatus -> ()

Eq ConnectionStatus

Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus

Methods

(==) :: ConnectionStatus -> ConnectionStatus -> Bool

(/=) :: ConnectionStatus -> ConnectionStatus -> Bool

Ord ConnectionStatus

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

Hashable ConnectionStatus

Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus

Methods

hashWithSalt :: Int -> ConnectionStatus -> Int

hash :: ConnectionStatus -> Int

type Rep ConnectionStatus

Defined in Amazonka.IoTSecureTunneling.Types.ConnectionStatus

type Rep ConnectionStatus = D1 ('MetaData "ConnectionStatus" "Amazonka.IoTSecureTunneling.Types.ConnectionStatus" "amazonka-iotsecuretunneling-2.0-B7tp11579Ld35NvrM5xQuK" 'True) (C1 ('MetaCons "ConnectionStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromConnectionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

TunnelStatus

newtype TunnelStatus

Constructors

TunnelStatus'

Fields

• fromTunnelStatus :: Text

Bundled Patterns

pattern TunnelStatus_CLOSED :: TunnelStatus

pattern TunnelStatus_OPEN :: TunnelStatus

Instances

FromJSON TunnelStatus

Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus

Methods

parseJSON :: Value -> Parser TunnelStatus

parseJSONList :: Value -> Parser [TunnelStatus]

FromJSONKey TunnelStatus

Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus

Methods

fromJSONKey :: FromJSONKeyFunction TunnelStatus

fromJSONKeyList :: FromJSONKeyFunction [TunnelStatus]

ToJSON TunnelStatus

Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus

Methods

toJSON :: TunnelStatus -> Value

toEncoding :: TunnelStatus -> Encoding

toJSONList :: [TunnelStatus] -> Value

toEncodingList :: [TunnelStatus] -> Encoding

ToJSONKey TunnelStatus

Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus

Methods

toJSONKey :: ToJSONKeyFunction TunnelStatus

toJSONKeyList :: ToJSONKeyFunction [TunnelStatus]

ToByteString TunnelStatus

Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus

Methods

toBS :: TunnelStatus -> ByteString

ToHeader TunnelStatus

Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus

Methods

toHeader :: HeaderName -> TunnelStatus -> [Header]

ToLog TunnelStatus

Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus

Methods

build :: TunnelStatus -> ByteStringBuilder

ToQuery TunnelStatus

Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus

Methods

toQuery :: TunnelStatus -> QueryString

FromText TunnelStatus

Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus

Methods

fromText :: Text -> Either String TunnelStatus

ToText TunnelStatus

Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus

Methods

toText :: TunnelStatus -> Text

FromXML TunnelStatus

Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus

Methods

parseXML :: [Node] -> Either String TunnelStatus

ToXML TunnelStatus

Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus

Methods

toXML :: TunnelStatus -> XML

Generic TunnelStatus

Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus

Associated Types

type Rep TunnelStatus :: Type -> Type

Methods

from :: TunnelStatus -> Rep TunnelStatus x

to :: Rep TunnelStatus x -> TunnelStatus

Read TunnelStatus

Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus

Methods

readsPrec :: Int -> ReadS TunnelStatus

readList :: ReadS [TunnelStatus]

readPrec :: ReadPrec TunnelStatus

readListPrec :: ReadPrec [TunnelStatus]

Show TunnelStatus

Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus

Methods

showsPrec :: Int -> TunnelStatus -> ShowS

show :: TunnelStatus -> String

showList :: [TunnelStatus] -> ShowS

NFData TunnelStatus

Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus

Methods

rnf :: TunnelStatus -> ()

Eq TunnelStatus

Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus

Methods

(==) :: TunnelStatus -> TunnelStatus -> Bool

(/=) :: TunnelStatus -> TunnelStatus -> Bool

Ord TunnelStatus

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

Hashable TunnelStatus

Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus

Methods

hashWithSalt :: Int -> TunnelStatus -> Int

hash :: TunnelStatus -> Int

type Rep TunnelStatus

Defined in Amazonka.IoTSecureTunneling.Types.TunnelStatus

type Rep TunnelStatus = D1 ('MetaData "TunnelStatus" "Amazonka.IoTSecureTunneling.Types.TunnelStatus" "amazonka-iotsecuretunneling-2.0-B7tp11579Ld35NvrM5xQuK" 'True) (C1 ('MetaCons "TunnelStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromTunnelStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ConnectionState

data ConnectionState

The state of a connection.

See: newConnectionState smart constructor.

Constructors

ConnectionState'

Fields

• lastUpdatedAt :: Maybe POSIX

  The last time the connection status was updated.

• status :: Maybe ConnectionStatus

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

Instances

FromJSON ConnectionState

Defined in Amazonka.IoTSecureTunneling.Types.ConnectionState

Methods

parseJSON :: Value -> Parser ConnectionState

parseJSONList :: Value -> Parser [ConnectionState]

Generic ConnectionState

Defined in Amazonka.IoTSecureTunneling.Types.ConnectionState

Associated Types

type Rep ConnectionState :: Type -> Type

Methods

from :: ConnectionState -> Rep ConnectionState x

to :: Rep ConnectionState x -> ConnectionState

Read ConnectionState

Defined in Amazonka.IoTSecureTunneling.Types.ConnectionState

Methods

readsPrec :: Int -> ReadS ConnectionState

readList :: ReadS [ConnectionState]

readPrec :: ReadPrec ConnectionState

readListPrec :: ReadPrec [ConnectionState]

Show ConnectionState

Defined in Amazonka.IoTSecureTunneling.Types.ConnectionState

Methods

showsPrec :: Int -> ConnectionState -> ShowS

show :: ConnectionState -> String

showList :: [ConnectionState] -> ShowS

NFData ConnectionState

Defined in Amazonka.IoTSecureTunneling.Types.ConnectionState

Methods

rnf :: ConnectionState -> ()

Eq ConnectionState

Defined in Amazonka.IoTSecureTunneling.Types.ConnectionState

Methods

(==) :: ConnectionState -> ConnectionState -> Bool

(/=) :: ConnectionState -> ConnectionState -> Bool

Hashable ConnectionState

Defined in Amazonka.IoTSecureTunneling.Types.ConnectionState

Methods

hashWithSalt :: Int -> ConnectionState -> Int

hash :: ConnectionState -> Int

type Rep ConnectionState

Defined in Amazonka.IoTSecureTunneling.Types.ConnectionState

type Rep ConnectionState = D1 ('MetaData "ConnectionState" "Amazonka.IoTSecureTunneling.Types.ConnectionState" "amazonka-iotsecuretunneling-2.0-B7tp11579Ld35NvrM5xQuK" 'False) (C1 ('MetaCons "ConnectionState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectionStatus))))

newConnectionState :: ConnectionState

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:lastUpdatedAt:ConnectionState', connectionState_lastUpdatedAt - The last time the connection status was updated.

$sel:status:ConnectionState', connectionState_status - The connection status of the tunnel. Valid values are CONNECTED and DISCONNECTED.

connectionState_lastUpdatedAt :: Lens' ConnectionState (Maybe UTCTime)

The last time the connection status was updated.

connectionState_status :: Lens' ConnectionState (Maybe ConnectionStatus)

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

DestinationConfig

data DestinationConfig

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 identify the target application. The 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 IoT client instantiates the local proxy, which uses this information to connect to the destination application.

Instances

FromJSON DestinationConfig

Defined in Amazonka.IoTSecureTunneling.Types.DestinationConfig

Methods

parseJSON :: Value -> Parser DestinationConfig

parseJSONList :: Value -> Parser [DestinationConfig]

ToJSON DestinationConfig

Defined in Amazonka.IoTSecureTunneling.Types.DestinationConfig

Methods

toJSON :: DestinationConfig -> Value

toEncoding :: DestinationConfig -> Encoding

toJSONList :: [DestinationConfig] -> Value

toEncodingList :: [DestinationConfig] -> Encoding

Generic DestinationConfig

Defined in Amazonka.IoTSecureTunneling.Types.DestinationConfig

Associated Types

type Rep DestinationConfig :: Type -> Type

Methods

from :: DestinationConfig -> Rep DestinationConfig x

to :: Rep DestinationConfig x -> DestinationConfig

Read DestinationConfig

Defined in Amazonka.IoTSecureTunneling.Types.DestinationConfig

Methods

readsPrec :: Int -> ReadS DestinationConfig

readList :: ReadS [DestinationConfig]

readPrec :: ReadPrec DestinationConfig

readListPrec :: ReadPrec [DestinationConfig]

Show DestinationConfig

Defined in Amazonka.IoTSecureTunneling.Types.DestinationConfig

Methods

showsPrec :: Int -> DestinationConfig -> ShowS

show :: DestinationConfig -> String

showList :: [DestinationConfig] -> ShowS

NFData DestinationConfig

Defined in Amazonka.IoTSecureTunneling.Types.DestinationConfig

Methods

rnf :: DestinationConfig -> ()

Eq DestinationConfig

Defined in Amazonka.IoTSecureTunneling.Types.DestinationConfig

Methods

(==) :: DestinationConfig -> DestinationConfig -> Bool

(/=) :: DestinationConfig -> DestinationConfig -> Bool

Hashable DestinationConfig

Defined in Amazonka.IoTSecureTunneling.Types.DestinationConfig

Methods

hashWithSalt :: Int -> DestinationConfig -> Int

hash :: DestinationConfig -> Int

type Rep DestinationConfig

Defined in Amazonka.IoTSecureTunneling.Types.DestinationConfig

type Rep DestinationConfig = D1 ('MetaData "DestinationConfig" "Amazonka.IoTSecureTunneling.Types.DestinationConfig" "amazonka-iotsecuretunneling-2.0-B7tp11579Ld35NvrM5xQuK" '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

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 identify the target application. The 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 IoT client instantiates the local proxy, which uses this information to connect to the destination application.

destinationConfig_thingName :: Lens' DestinationConfig (Maybe Text)

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

destinationConfig_services :: Lens' DestinationConfig (NonEmpty Text)

A list of service names that identify the target application. The 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 IoT client instantiates the local proxy, which uses this information to connect to the destination application.

Tag

data Tag

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

FromJSON Tag

Defined in Amazonka.IoTSecureTunneling.Types.Tag

Methods

parseJSON :: Value -> Parser Tag

parseJSONList :: Value -> Parser [Tag]

ToJSON Tag

Defined in Amazonka.IoTSecureTunneling.Types.Tag

Methods

toJSON :: Tag -> Value

toEncoding :: Tag -> Encoding

toJSONList :: [Tag] -> Value

toEncodingList :: [Tag] -> Encoding

Generic Tag

Defined in Amazonka.IoTSecureTunneling.Types.Tag

Associated Types

type Rep Tag :: Type -> Type

Methods

from :: Tag -> Rep Tag x

to :: Rep Tag x -> Tag

Read Tag

Defined in Amazonka.IoTSecureTunneling.Types.Tag

Methods

readsPrec :: Int -> ReadS Tag

readList :: ReadS [Tag]

readPrec :: ReadPrec Tag

readListPrec :: ReadPrec [Tag]

Show Tag

Defined in Amazonka.IoTSecureTunneling.Types.Tag

Methods

showsPrec :: Int -> Tag -> ShowS

show :: Tag -> String

showList :: [Tag] -> ShowS

NFData Tag

Defined in Amazonka.IoTSecureTunneling.Types.Tag

Methods

rnf :: Tag -> ()

Eq Tag

Defined in Amazonka.IoTSecureTunneling.Types.Tag

Methods

(==) :: Tag -> Tag -> Bool

(/=) :: Tag -> Tag -> Bool

Hashable Tag

Defined in Amazonka.IoTSecureTunneling.Types.Tag

Methods

hashWithSalt :: Int -> Tag -> Int

hash :: Tag -> Int

type Rep Tag

Defined in Amazonka.IoTSecureTunneling.Types.Tag

type Rep Tag = D1 ('MetaData "Tag" "Amazonka.IoTSecureTunneling.Types.Tag" "amazonka-iotsecuretunneling-2.0-B7tp11579Ld35NvrM5xQuK" '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

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

The key of the tag.

tag_value :: Lens' Tag Text

The value of the tag.

TimeoutConfig

data TimeoutConfig

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

FromJSON TimeoutConfig

Defined in Amazonka.IoTSecureTunneling.Types.TimeoutConfig

Methods

parseJSON :: Value -> Parser TimeoutConfig

parseJSONList :: Value -> Parser [TimeoutConfig]

ToJSON TimeoutConfig

Defined in Amazonka.IoTSecureTunneling.Types.TimeoutConfig

Methods

toJSON :: TimeoutConfig -> Value

toEncoding :: TimeoutConfig -> Encoding

toJSONList :: [TimeoutConfig] -> Value

toEncodingList :: [TimeoutConfig] -> Encoding

Generic TimeoutConfig

Defined in Amazonka.IoTSecureTunneling.Types.TimeoutConfig

Associated Types

type Rep TimeoutConfig :: Type -> Type

Methods

from :: TimeoutConfig -> Rep TimeoutConfig x

to :: Rep TimeoutConfig x -> TimeoutConfig

Read TimeoutConfig

Defined in Amazonka.IoTSecureTunneling.Types.TimeoutConfig

Methods

readsPrec :: Int -> ReadS TimeoutConfig

readList :: ReadS [TimeoutConfig]

readPrec :: ReadPrec TimeoutConfig

readListPrec :: ReadPrec [TimeoutConfig]

Show TimeoutConfig

Defined in Amazonka.IoTSecureTunneling.Types.TimeoutConfig

Methods

showsPrec :: Int -> TimeoutConfig -> ShowS

show :: TimeoutConfig -> String

showList :: [TimeoutConfig] -> ShowS

NFData TimeoutConfig

Defined in Amazonka.IoTSecureTunneling.Types.TimeoutConfig

Methods

rnf :: TimeoutConfig -> ()

Eq TimeoutConfig

Defined in Amazonka.IoTSecureTunneling.Types.TimeoutConfig

Methods

(==) :: TimeoutConfig -> TimeoutConfig -> Bool

(/=) :: TimeoutConfig -> TimeoutConfig -> Bool

Hashable TimeoutConfig

Defined in Amazonka.IoTSecureTunneling.Types.TimeoutConfig

Methods

hashWithSalt :: Int -> TimeoutConfig -> Int

hash :: TimeoutConfig -> Int

type Rep TimeoutConfig

Defined in Amazonka.IoTSecureTunneling.Types.TimeoutConfig

type Rep TimeoutConfig = D1 ('MetaData "TimeoutConfig" "Amazonka.IoTSecureTunneling.Types.TimeoutConfig" "amazonka-iotsecuretunneling-2.0-B7tp11579Ld35NvrM5xQuK" 'False) (C1 ('MetaCons "TimeoutConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxLifetimeTimeoutMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))

newTimeoutConfig :: TimeoutConfig

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)

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

A connection between a source computer and a destination device.

See: newTunnel smart constructor.

Constructors

Tunnel'

Fields

• createdAt :: Maybe POSIX

  The time when the tunnel was created.

• description :: Maybe Text

  A description of the 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.

• destinationConnectionState :: Maybe ConnectionState

  The connection state of the destination application.

• lastUpdatedAt :: Maybe POSIX

  The last time the tunnel was updated.

• sourceConnectionState :: Maybe ConnectionState

  The connection state of the source application.

• status :: Maybe TunnelStatus

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

• tags :: Maybe (NonEmpty Tag)

  A list of tag metadata associated with the secure tunnel.

• timeoutConfig :: Maybe TimeoutConfig

  Timeout configuration for the tunnel.

• tunnelArn :: Maybe Text

  The Amazon Resource Name (ARN) of a tunnel.

• tunnelId :: Maybe Text

  A unique alpha-numeric ID that identifies a tunnel.

Instances

FromJSON Tunnel

Defined in Amazonka.IoTSecureTunneling.Types.Tunnel

Methods

parseJSON :: Value -> Parser Tunnel

parseJSONList :: Value -> Parser [Tunnel]

Generic Tunnel

Defined in Amazonka.IoTSecureTunneling.Types.Tunnel

Associated Types

type Rep Tunnel :: Type -> Type

Methods

from :: Tunnel -> Rep Tunnel x

to :: Rep Tunnel x -> Tunnel

Read Tunnel

Defined in Amazonka.IoTSecureTunneling.Types.Tunnel

Methods

readsPrec :: Int -> ReadS Tunnel

readList :: ReadS [Tunnel]

readPrec :: ReadPrec Tunnel

readListPrec :: ReadPrec [Tunnel]

Show Tunnel

Defined in Amazonka.IoTSecureTunneling.Types.Tunnel

Methods

showsPrec :: Int -> Tunnel -> ShowS

show :: Tunnel -> String

showList :: [Tunnel] -> ShowS

NFData Tunnel

Defined in Amazonka.IoTSecureTunneling.Types.Tunnel

Methods

rnf :: Tunnel -> ()

Eq Tunnel

Defined in Amazonka.IoTSecureTunneling.Types.Tunnel

Methods

(==) :: Tunnel -> Tunnel -> Bool

(/=) :: Tunnel -> Tunnel -> Bool

Hashable Tunnel

Defined in Amazonka.IoTSecureTunneling.Types.Tunnel

Methods

hashWithSalt :: Int -> Tunnel -> Int

hash :: Tunnel -> Int

type Rep Tunnel

Defined in Amazonka.IoTSecureTunneling.Types.Tunnel

type Rep Tunnel = D1 ('MetaData "Tunnel" "Amazonka.IoTSecureTunneling.Types.Tunnel" "amazonka-iotsecuretunneling-2.0-B7tp11579Ld35NvrM5xQuK" 'False) (C1 ('MetaCons "Tunnel'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "destinationConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DestinationConfig)) :*: (S1 ('MetaSel ('Just "destinationConnectionState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectionState)) :*: S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: ((S1 ('MetaSel ('Just "sourceConnectionState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectionState)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TunnelStatus)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))))) :*: (S1 ('MetaSel ('Just "timeoutConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeoutConfig)) :*: (S1 ('MetaSel ('Just "tunnelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tunnelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newTunnel :: Tunnel

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:createdAt:Tunnel', tunnel_createdAt - The time when the tunnel was created.

$sel:description:Tunnel', tunnel_description - A description of the 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:destinationConnectionState:Tunnel', tunnel_destinationConnectionState - The connection state of the destination application.

Tunnel, tunnel_lastUpdatedAt - The last time the tunnel was updated.

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

Tunnel, tunnel_status - The status of a tunnel. Valid values are: Open and Closed.

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

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

$sel:tunnelArn:Tunnel', tunnel_tunnelArn - The Amazon Resource Name (ARN) of a tunnel.

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

tunnel_createdAt :: Lens' Tunnel (Maybe UTCTime)

The time when the tunnel was created.

tunnel_description :: Lens' Tunnel (Maybe Text)

A description of the tunnel.

tunnel_destinationConfig :: Lens' Tunnel (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.

tunnel_destinationConnectionState :: Lens' Tunnel (Maybe ConnectionState)

The connection state of the destination application.

tunnel_lastUpdatedAt :: Lens' Tunnel (Maybe UTCTime)

The last time the tunnel was updated.

tunnel_sourceConnectionState :: Lens' Tunnel (Maybe ConnectionState)

The connection state of the source application.

tunnel_status :: Lens' Tunnel (Maybe TunnelStatus)

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

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

A list of tag metadata associated with the secure tunnel.

tunnel_timeoutConfig :: Lens' Tunnel (Maybe TimeoutConfig)

Timeout configuration for the tunnel.

tunnel_tunnelArn :: Lens' Tunnel (Maybe Text)

The Amazon Resource Name (ARN) of a tunnel.

tunnel_tunnelId :: Lens' Tunnel (Maybe Text)

A unique alpha-numeric ID that identifies a tunnel.

TunnelSummary

data TunnelSummary

Information about the tunnel.

See: newTunnelSummary smart constructor.

Constructors

TunnelSummary'

Fields

• createdAt :: Maybe POSIX

  The time the tunnel was created.

• description :: Maybe Text

  A description of the tunnel.

• lastUpdatedAt :: Maybe POSIX

  The time the tunnel was last updated.

• status :: Maybe TunnelStatus

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

• tunnelArn :: Maybe Text

  The Amazon Resource Name of the tunnel.

• tunnelId :: Maybe Text

  The unique alpha-numeric identifier for the tunnel.

Instances

FromJSON TunnelSummary

Defined in Amazonka.IoTSecureTunneling.Types.TunnelSummary

Methods

parseJSON :: Value -> Parser TunnelSummary

parseJSONList :: Value -> Parser [TunnelSummary]

Generic TunnelSummary

Defined in Amazonka.IoTSecureTunneling.Types.TunnelSummary

Associated Types

type Rep TunnelSummary :: Type -> Type

Methods

from :: TunnelSummary -> Rep TunnelSummary x

to :: Rep TunnelSummary x -> TunnelSummary

Read TunnelSummary

Defined in Amazonka.IoTSecureTunneling.Types.TunnelSummary

Methods

readsPrec :: Int -> ReadS TunnelSummary

readList :: ReadS [TunnelSummary]

readPrec :: ReadPrec TunnelSummary

readListPrec :: ReadPrec [TunnelSummary]

Show TunnelSummary

Defined in Amazonka.IoTSecureTunneling.Types.TunnelSummary

Methods

showsPrec :: Int -> TunnelSummary -> ShowS

show :: TunnelSummary -> String

showList :: [TunnelSummary] -> ShowS

NFData TunnelSummary

Defined in Amazonka.IoTSecureTunneling.Types.TunnelSummary

Methods

rnf :: TunnelSummary -> ()

Eq TunnelSummary

Defined in Amazonka.IoTSecureTunneling.Types.TunnelSummary

Methods

(==) :: TunnelSummary -> TunnelSummary -> Bool

(/=) :: TunnelSummary -> TunnelSummary -> Bool

Hashable TunnelSummary

Defined in Amazonka.IoTSecureTunneling.Types.TunnelSummary

Methods

hashWithSalt :: Int -> TunnelSummary -> Int

hash :: TunnelSummary -> Int

type Rep TunnelSummary

Defined in Amazonka.IoTSecureTunneling.Types.TunnelSummary

type Rep TunnelSummary = D1 ('MetaData "TunnelSummary" "Amazonka.IoTSecureTunneling.Types.TunnelSummary" "amazonka-iotsecuretunneling-2.0-B7tp11579Ld35NvrM5xQuK" 'False) (C1 ('MetaCons "TunnelSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TunnelStatus)) :*: (S1 ('MetaSel ('Just "tunnelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tunnelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newTunnelSummary :: TunnelSummary

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:createdAt:TunnelSummary', tunnelSummary_createdAt - The time the tunnel was created.

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

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

$sel:status:TunnelSummary', tunnelSummary_status - The status of a tunnel. Valid values are: Open and Closed.

$sel:tunnelArn:TunnelSummary', tunnelSummary_tunnelArn - The Amazon Resource Name of the tunnel.

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

tunnelSummary_createdAt :: Lens' TunnelSummary (Maybe UTCTime)

The time the tunnel was created.

tunnelSummary_description :: Lens' TunnelSummary (Maybe Text)

A description of the tunnel.

tunnelSummary_lastUpdatedAt :: Lens' TunnelSummary (Maybe UTCTime)

The time the tunnel was last updated.

tunnelSummary_status :: Lens' TunnelSummary (Maybe TunnelStatus)

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

tunnelSummary_tunnelArn :: Lens' TunnelSummary (Maybe Text)

The Amazon Resource Name of the tunnel.

tunnelSummary_tunnelId :: Lens' TunnelSummary (Maybe Text)

The unique alpha-numeric identifier for the tunnel.