Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . ec2 ]

terminate-client-vpn-connections

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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  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>]

Options

--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 is DryRunOperation . Otherwise, it is UnauthorizedOperation .

--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.

See 'aws help' for descriptions of global parameters.

Output

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.