| 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.RotateTunnelAccessToken
Description
Revokes the current client access token (CAT) and returns new CAT for clients to use when reconnecting to secure tunneling to access the same tunnel.
Requires permission to access the RotateTunnelAccessToken action.
Rotating the CAT doesn't extend the tunnel duration. For example, say the tunnel duration is 12 hours and the tunnel has already been open for 4 hours. When you rotate the access tokens, the new tokens that are generated can only be used for the remaining 8 hours.
Synopsis
- data RotateTunnelAccessToken = RotateTunnelAccessToken' {}
- newRotateTunnelAccessToken :: Text -> ClientMode -> RotateTunnelAccessToken
- rotateTunnelAccessToken_destinationConfig :: Lens' RotateTunnelAccessToken (Maybe DestinationConfig)
- rotateTunnelAccessToken_tunnelId :: Lens' RotateTunnelAccessToken Text
- rotateTunnelAccessToken_clientMode :: Lens' RotateTunnelAccessToken ClientMode
- data RotateTunnelAccessTokenResponse = RotateTunnelAccessTokenResponse' {}
- newRotateTunnelAccessTokenResponse :: Int -> RotateTunnelAccessTokenResponse
- rotateTunnelAccessTokenResponse_destinationAccessToken :: Lens' RotateTunnelAccessTokenResponse (Maybe Text)
- rotateTunnelAccessTokenResponse_sourceAccessToken :: Lens' RotateTunnelAccessTokenResponse (Maybe Text)
- rotateTunnelAccessTokenResponse_tunnelArn :: Lens' RotateTunnelAccessTokenResponse (Maybe Text)
- rotateTunnelAccessTokenResponse_httpStatus :: Lens' RotateTunnelAccessTokenResponse Int
Creating a Request
data RotateTunnelAccessToken Source #
See: newRotateTunnelAccessToken smart constructor.
Constructors
| RotateTunnelAccessToken' | |
Fields
| |
Instances
newRotateTunnelAccessToken Source #
Arguments
| :: Text | |
| -> ClientMode | |
| -> RotateTunnelAccessToken |
Create a value of RotateTunnelAccessToken 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:
RotateTunnelAccessToken, rotateTunnelAccessToken_destinationConfig - Undocumented member.
RotateTunnelAccessToken, rotateTunnelAccessToken_tunnelId - The tunnel for which you want to rotate the access tokens.
$sel:clientMode:RotateTunnelAccessToken', rotateTunnelAccessToken_clientMode - The mode of the client that will use the client token, which can be
either the source or destination, or both source and destination.
Request Lenses
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.
Destructuring the Response
data RotateTunnelAccessTokenResponse Source #
See: newRotateTunnelAccessTokenResponse smart constructor.
Constructors
| RotateTunnelAccessTokenResponse' | |
Fields
| |
Instances
newRotateTunnelAccessTokenResponse Source #
Create a value of RotateTunnelAccessTokenResponse 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:destinationAccessToken:RotateTunnelAccessTokenResponse', rotateTunnelAccessTokenResponse_destinationAccessToken - The client access token that the destination local proxy uses to connect
to IoT Secure Tunneling.
$sel:sourceAccessToken:RotateTunnelAccessTokenResponse', rotateTunnelAccessTokenResponse_sourceAccessToken - The client access token that the source local proxy uses to connect to
IoT Secure Tunneling.
RotateTunnelAccessTokenResponse, rotateTunnelAccessTokenResponse_tunnelArn - The Amazon Resource Name for the tunnel.
$sel:httpStatus:RotateTunnelAccessTokenResponse', rotateTunnelAccessTokenResponse_httpStatus - The response's http status code.
Response Lenses
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.