Table Of Contents


User Guide

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

[ aws . ec2 ]



Modifies the specified Client VPN endpoint. You can only modify an endpoint's server certificate information, client connection logging information, DNS server, and description. Modifying the DNS server resets existing client connections.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--client-vpn-endpoint-id <value>
[--server-certificate-arn <value>]
[--connection-log-options <value>]
[--dns-servers <value>]
[--description <value>]
[--split-tunnel | --no-split-tunnel]
[--dry-run | --no-dry-run]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--client-vpn-endpoint-id (string)

The ID of the Client VPN endpoint to modify.

--server-certificate-arn (string)

The ARN of the server certificate to be used. The server certificate must be provisioned in AWS Certificate Manager (ACM).

--connection-log-options (structure)

Information about the client connection logging options.

If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:

  • Client connection requests
  • Client connection results (successful and unsuccessful)
  • Reasons for unsuccessful client connection requests
  • Client connection termination time

Shorthand Syntax:


JSON Syntax:

  "Enabled": true|false,
  "CloudwatchLogGroup": "string",
  "CloudwatchLogStream": "string"

--dns-servers (structure)

Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have up to two DNS servers.

Shorthand Syntax:


JSON Syntax:

  "CustomDnsServers": ["string", ...],
  "Enabled": true|false

--description (string)

A brief description of the Client VPN endpoint.

--split-tunnel | --no-split-tunnel (boolean)

Indicates whether the VPN is split-tunnel.

For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN Endpoint in the AWS Client VPN Administrator Guide .

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


To modify a Client VPN endpoint

The following modify-client-vpn-endpoint example enables client connection logging for the specified Client VPN endpoint.

aws ec2 modify-client-vpn-endpoint \
    --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \
    --connection-log-options Enabled=true,CloudwatchLogGroup=ClientVPNLogs


    "Return": true

For more information, see Client VPN Endpoints in the AWS Client VPN Administrator Guide.


Return -> (boolean)

Returns true if the request succeeds; otherwise, it returns an error.