| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.IoTSecureTunneling.Lens
Description
Synopsis
- closeTunnel_delete :: Lens' CloseTunnel (Maybe Bool)
- closeTunnel_tunnelId :: Lens' CloseTunnel Text
- closeTunnelResponse_httpStatus :: Lens' CloseTunnelResponse Int
- describeTunnel_tunnelId :: Lens' DescribeTunnel Text
- describeTunnelResponse_tunnel :: Lens' DescribeTunnelResponse (Maybe Tunnel)
- describeTunnelResponse_httpStatus :: Lens' DescribeTunnelResponse Int
- listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (NonEmpty Tag))
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- listTunnels_maxResults :: Lens' ListTunnels (Maybe Natural)
- listTunnels_nextToken :: Lens' ListTunnels (Maybe Text)
- listTunnels_thingName :: Lens' ListTunnels (Maybe Text)
- listTunnelsResponse_nextToken :: Lens' ListTunnelsResponse (Maybe Text)
- listTunnelsResponse_tunnelSummaries :: Lens' ListTunnelsResponse (Maybe [TunnelSummary])
- listTunnelsResponse_httpStatus :: Lens' ListTunnelsResponse Int
- openTunnel_description :: Lens' OpenTunnel (Maybe Text)
- openTunnel_destinationConfig :: Lens' OpenTunnel (Maybe DestinationConfig)
- openTunnel_tags :: Lens' OpenTunnel (Maybe (NonEmpty Tag))
- openTunnel_timeoutConfig :: Lens' OpenTunnel (Maybe TimeoutConfig)
- openTunnelResponse_destinationAccessToken :: Lens' OpenTunnelResponse (Maybe Text)
- openTunnelResponse_sourceAccessToken :: Lens' OpenTunnelResponse (Maybe Text)
- openTunnelResponse_tunnelArn :: Lens' OpenTunnelResponse (Maybe Text)
- openTunnelResponse_tunnelId :: Lens' OpenTunnelResponse (Maybe Text)
- openTunnelResponse_httpStatus :: Lens' OpenTunnelResponse Int
- rotateTunnelAccessToken_destinationConfig :: Lens' RotateTunnelAccessToken (Maybe DestinationConfig)
- rotateTunnelAccessToken_tunnelId :: Lens' RotateTunnelAccessToken Text
- rotateTunnelAccessToken_clientMode :: Lens' RotateTunnelAccessToken ClientMode
- rotateTunnelAccessTokenResponse_destinationAccessToken :: Lens' RotateTunnelAccessTokenResponse (Maybe Text)
- rotateTunnelAccessTokenResponse_sourceAccessToken :: Lens' RotateTunnelAccessTokenResponse (Maybe Text)
- rotateTunnelAccessTokenResponse_tunnelArn :: Lens' RotateTunnelAccessTokenResponse (Maybe Text)
- rotateTunnelAccessTokenResponse_httpStatus :: Lens' RotateTunnelAccessTokenResponse Int
- tagResource_resourceArn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource (NonEmpty Tag)
- tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
- untagResource_resourceArn :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource [Text]
- untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
- connectionState_lastUpdatedAt :: Lens' ConnectionState (Maybe UTCTime)
- connectionState_status :: Lens' ConnectionState (Maybe ConnectionStatus)
- destinationConfig_thingName :: Lens' DestinationConfig (Maybe Text)
- destinationConfig_services :: Lens' DestinationConfig (NonEmpty Text)
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- timeoutConfig_maxLifetimeTimeoutMinutes :: Lens' TimeoutConfig (Maybe Natural)
- tunnel_createdAt :: Lens' Tunnel (Maybe UTCTime)
- tunnel_description :: Lens' Tunnel (Maybe Text)
- tunnel_destinationConfig :: Lens' Tunnel (Maybe DestinationConfig)
- tunnel_destinationConnectionState :: Lens' Tunnel (Maybe ConnectionState)
- tunnel_lastUpdatedAt :: Lens' Tunnel (Maybe UTCTime)
- tunnel_sourceConnectionState :: Lens' Tunnel (Maybe ConnectionState)
- tunnel_status :: Lens' Tunnel (Maybe TunnelStatus)
- tunnel_tags :: Lens' Tunnel (Maybe (NonEmpty Tag))
- tunnel_timeoutConfig :: Lens' Tunnel (Maybe TimeoutConfig)
- tunnel_tunnelArn :: Lens' Tunnel (Maybe Text)
- tunnel_tunnelId :: Lens' Tunnel (Maybe Text)
- tunnelSummary_createdAt :: Lens' TunnelSummary (Maybe UTCTime)
- tunnelSummary_description :: Lens' TunnelSummary (Maybe Text)
- tunnelSummary_lastUpdatedAt :: Lens' TunnelSummary (Maybe UTCTime)
- tunnelSummary_status :: Lens' TunnelSummary (Maybe TunnelStatus)
- tunnelSummary_tunnelArn :: Lens' TunnelSummary (Maybe Text)
- tunnelSummary_tunnelId :: Lens' TunnelSummary (Maybe Text)
Operations
CloseTunnel
closeTunnel_delete :: Lens' CloseTunnel (Maybe Bool) Source #
When set to true, IoT Secure Tunneling deletes the tunnel data immediately.
closeTunnel_tunnelId :: Lens' CloseTunnel Text Source #
The ID of the tunnel to close.
closeTunnelResponse_httpStatus :: Lens' CloseTunnelResponse Int Source #
The response's http status code.
DescribeTunnel
describeTunnel_tunnelId :: Lens' DescribeTunnel Text Source #
The tunnel to describe.
describeTunnelResponse_tunnel :: Lens' DescribeTunnelResponse (Maybe Tunnel) Source #
The tunnel being described.
describeTunnelResponse_httpStatus :: Lens' DescribeTunnelResponse Int Source #
The response's http status code.
ListTagsForResource
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #
The resource ARN.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (NonEmpty Tag)) Source #
The tags for the specified resource.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
ListTunnels
listTunnels_maxResults :: Lens' ListTunnels (Maybe Natural) Source #
The maximum number of results to return at once.
listTunnels_nextToken :: Lens' ListTunnels (Maybe Text) Source #
To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
listTunnels_thingName :: Lens' ListTunnels (Maybe Text) Source #
The name of the IoT thing associated with the destination device.
listTunnelsResponse_nextToken :: Lens' ListTunnelsResponse (Maybe Text) Source #
The token to use to get the next set of results, or null if there are no additional results.
listTunnelsResponse_tunnelSummaries :: Lens' ListTunnelsResponse (Maybe [TunnelSummary]) Source #
A short description of the tunnels in an Amazon Web Services account.
listTunnelsResponse_httpStatus :: Lens' ListTunnelsResponse Int Source #
The response's http status code.
OpenTunnel
openTunnel_description :: Lens' OpenTunnel (Maybe Text) Source #
A short text description of the tunnel.
openTunnel_destinationConfig :: Lens' OpenTunnel (Maybe DestinationConfig) Source #
The destination configuration for the OpenTunnel request.
openTunnel_tags :: Lens' OpenTunnel (Maybe (NonEmpty Tag)) Source #
A collection of tag metadata.
openTunnel_timeoutConfig :: Lens' OpenTunnel (Maybe TimeoutConfig) Source #
Timeout configuration for a tunnel.
openTunnelResponse_destinationAccessToken :: Lens' OpenTunnelResponse (Maybe Text) Source #
The access token the destination local proxy uses to connect to IoT Secure Tunneling.
openTunnelResponse_sourceAccessToken :: Lens' OpenTunnelResponse (Maybe Text) Source #
The access token the source local proxy uses to connect to IoT Secure Tunneling.
openTunnelResponse_tunnelArn :: Lens' OpenTunnelResponse (Maybe Text) Source #
The Amazon Resource Name for the tunnel.
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.
RotateTunnelAccessToken
rotateTunnelAccessToken_destinationConfig :: Lens' RotateTunnelAccessToken (Maybe DestinationConfig) Source #
Undocumented member.
rotateTunnelAccessToken_tunnelId :: Lens' RotateTunnelAccessToken Text Source #
The tunnel for which you want to rotate the access tokens.
rotateTunnelAccessToken_clientMode :: Lens' RotateTunnelAccessToken ClientMode Source #
The mode of the client that will use the client token, which can be either the source or destination, or both source and destination.
rotateTunnelAccessTokenResponse_destinationAccessToken :: Lens' RotateTunnelAccessTokenResponse (Maybe Text) Source #
The client access token that the destination local proxy uses to connect to IoT Secure Tunneling.
rotateTunnelAccessTokenResponse_sourceAccessToken :: Lens' RotateTunnelAccessTokenResponse (Maybe Text) Source #
The client access token that the source local proxy uses to connect to IoT Secure Tunneling.
rotateTunnelAccessTokenResponse_tunnelArn :: Lens' RotateTunnelAccessTokenResponse (Maybe Text) Source #
The Amazon Resource Name for the tunnel.
rotateTunnelAccessTokenResponse_httpStatus :: Lens' RotateTunnelAccessTokenResponse Int Source #
The response's http status code.
TagResource
tagResource_resourceArn :: Lens' TagResource Text Source #
The ARN of the resource.
tagResource_tags :: Lens' TagResource (NonEmpty Tag) Source #
The tags for the resource.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #
The response's http status code.
UntagResource
untagResource_resourceArn :: Lens' UntagResource Text Source #
The resource ARN.
untagResource_tagKeys :: Lens' UntagResource [Text] Source #
The keys of the tags to remove.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #
The response's http status code.
Types
ConnectionState
connectionState_lastUpdatedAt :: Lens' ConnectionState (Maybe UTCTime) Source #
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.
DestinationConfig
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 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
TimeoutConfig
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
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_destinationConnectionState :: Lens' Tunnel (Maybe ConnectionState) Source #
The connection state of the destination application.
tunnel_sourceConnectionState :: Lens' Tunnel (Maybe ConnectionState) Source #
The connection state of the source application.
tunnel_status :: Lens' Tunnel (Maybe TunnelStatus) Source #
The status of a tunnel. Valid values are: Open and Closed.
tunnel_tags :: Lens' Tunnel (Maybe (NonEmpty Tag)) Source #
A list of tag metadata associated with the secure tunnel.
tunnel_timeoutConfig :: Lens' Tunnel (Maybe TimeoutConfig) Source #
Timeout configuration for the tunnel.
tunnel_tunnelId :: Lens' Tunnel (Maybe Text) Source #
A unique alpha-numeric ID that identifies a tunnel.
TunnelSummary
tunnelSummary_createdAt :: Lens' TunnelSummary (Maybe UTCTime) Source #
The time the tunnel was created.
tunnelSummary_description :: Lens' TunnelSummary (Maybe Text) Source #
A description of the tunnel.
tunnelSummary_lastUpdatedAt :: Lens' TunnelSummary (Maybe UTCTime) Source #
The time the tunnel was last updated.
tunnelSummary_status :: Lens' TunnelSummary (Maybe TunnelStatus) Source #
The status of a tunnel. Valid values are: Open and Closed.
tunnelSummary_tunnelArn :: Lens' TunnelSummary (Maybe Text) Source #
The Amazon Resource Name of the tunnel.
tunnelSummary_tunnelId :: Lens' TunnelSummary (Maybe Text) Source #
The unique alpha-numeric identifier for the tunnel.