AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
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.
See also: AWS API Documentation
terminate-client-vpn-connections
--client-vpn-endpoint-id <value>
[--connection-id <value>]
[--username <value>]
[--dry-run | --no-dry-run]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--client-vpn-endpoint-id
(string)
The ID of the Client VPN endpoint to which the client is connected.
--connection-id
(string)
The ID of the client connection to be terminated.
--username
(string)
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.
--dry-run
| --no-dry-run
(boolean)
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 isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To terminate a connection to a Client VPN endpoint
The following terminate-client-vpn-connections
example terminates the specified connection to the Client VPN endpoint.
aws ec2 terminate-client-vpn-connections \
--client-vpn-endpoint-id vpn-endpoint-123456789123abcde \
--connection-id cvpn-connection-04edd76f5201e0cb8
Output:
{
"ClientVpnEndpointId": "vpn-endpoint-123456789123abcde",
"ConnectionStatuses": [
{
"ConnectionId": "cvpn-connection-04edd76f5201e0cb8",
"PreviousStatus": {
"Code": "active"
},
"CurrentStatus": {
"Code": "terminating"
}
}
]
}
For more information, see Client Connections in the AWS Client VPN Administrator Guide.
ClientVpnEndpointId -> (string)
The ID of the Client VPN endpoint.
Username -> (string)
The user who established the terminated client connections.
ConnectionStatuses -> (list)
The current state of the client connections.
(structure)
Information about a terminated Client VPN endpoint client connection.
ConnectionId -> (string)
The ID of the client connection.PreviousStatus -> (structure)
The state of the client connection.
Code -> (string)
The state of the client connection.Message -> (string)
A message about the status of the client connection, if applicable.CurrentStatus -> (structure)
A message about the status of the client connection, if applicable.
Code -> (string)
The state of the client connection.Message -> (string)
A message about the status of the client connection, if applicable.