| 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.EC2.TerminateClientVpnConnections
Description
Terminates active Client VPN endpoint connections. This action can be used to terminate a specific client connection, or up to five connections established by a specific user.
Synopsis
- data TerminateClientVpnConnections = TerminateClientVpnConnections' {}
- newTerminateClientVpnConnections :: Text -> TerminateClientVpnConnections
- terminateClientVpnConnections_connectionId :: Lens' TerminateClientVpnConnections (Maybe Text)
- terminateClientVpnConnections_dryRun :: Lens' TerminateClientVpnConnections (Maybe Bool)
- terminateClientVpnConnections_username :: Lens' TerminateClientVpnConnections (Maybe Text)
- terminateClientVpnConnections_clientVpnEndpointId :: Lens' TerminateClientVpnConnections Text
- data TerminateClientVpnConnectionsResponse = TerminateClientVpnConnectionsResponse' {}
- newTerminateClientVpnConnectionsResponse :: Int -> TerminateClientVpnConnectionsResponse
- terminateClientVpnConnectionsResponse_clientVpnEndpointId :: Lens' TerminateClientVpnConnectionsResponse (Maybe Text)
- terminateClientVpnConnectionsResponse_connectionStatuses :: Lens' TerminateClientVpnConnectionsResponse (Maybe [TerminateConnectionStatus])
- terminateClientVpnConnectionsResponse_username :: Lens' TerminateClientVpnConnectionsResponse (Maybe Text)
- terminateClientVpnConnectionsResponse_httpStatus :: Lens' TerminateClientVpnConnectionsResponse Int
Creating a Request
data TerminateClientVpnConnections Source #
See: newTerminateClientVpnConnections smart constructor.
Constructors
| TerminateClientVpnConnections' | |
Fields
| |
Instances
newTerminateClientVpnConnections Source #
Create a value of TerminateClientVpnConnections 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:
TerminateClientVpnConnections, terminateClientVpnConnections_connectionId - The ID of the client connection to be terminated.
$sel:dryRun:TerminateClientVpnConnections', terminateClientVpnConnections_dryRun - Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation.
Otherwise, it is UnauthorizedOperation.
TerminateClientVpnConnections, terminateClientVpnConnections_username - The name of the user who initiated the connection. Use this option to
terminate all active connections for the specified user. This option can
only be used if the user has established up to five connections.
TerminateClientVpnConnections, terminateClientVpnConnections_clientVpnEndpointId - The ID of the Client VPN endpoint to which the client is connected.
Request Lenses
terminateClientVpnConnections_connectionId :: Lens' TerminateClientVpnConnections (Maybe Text) Source #
The ID of the client connection to be terminated.
terminateClientVpnConnections_dryRun :: Lens' TerminateClientVpnConnections (Maybe Bool) Source #
Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation.
Otherwise, it is UnauthorizedOperation.
terminateClientVpnConnections_username :: Lens' TerminateClientVpnConnections (Maybe Text) Source #
The name of the user who initiated the connection. Use this option to terminate all active connections for the specified user. This option can only be used if the user has established up to five connections.
terminateClientVpnConnections_clientVpnEndpointId :: Lens' TerminateClientVpnConnections Text Source #
The ID of the Client VPN endpoint to which the client is connected.
Destructuring the Response
data TerminateClientVpnConnectionsResponse Source #
See: newTerminateClientVpnConnectionsResponse smart constructor.
Constructors
| TerminateClientVpnConnectionsResponse' | |
Fields
| |
Instances
newTerminateClientVpnConnectionsResponse Source #
Arguments
| :: Int | |
| -> TerminateClientVpnConnectionsResponse |
Create a value of TerminateClientVpnConnectionsResponse 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:
TerminateClientVpnConnections, terminateClientVpnConnectionsResponse_clientVpnEndpointId - The ID of the Client VPN endpoint.
$sel:connectionStatuses:TerminateClientVpnConnectionsResponse', terminateClientVpnConnectionsResponse_connectionStatuses - The current state of the client connections.
TerminateClientVpnConnections, terminateClientVpnConnectionsResponse_username - The user who established the terminated client connections.
$sel:httpStatus:TerminateClientVpnConnectionsResponse', terminateClientVpnConnectionsResponse_httpStatus - The response's http status code.
Response Lenses
terminateClientVpnConnectionsResponse_clientVpnEndpointId :: Lens' TerminateClientVpnConnectionsResponse (Maybe Text) Source #
The ID of the Client VPN endpoint.
terminateClientVpnConnectionsResponse_connectionStatuses :: Lens' TerminateClientVpnConnectionsResponse (Maybe [TerminateConnectionStatus]) Source #
The current state of the client connections.
terminateClientVpnConnectionsResponse_username :: Lens' TerminateClientVpnConnectionsResponse (Maybe Text) Source #
The user who established the terminated client connections.
terminateClientVpnConnectionsResponse_httpStatus :: Lens' TerminateClientVpnConnectionsResponse Int Source #
The response's http status code.