Table Of Contents

Feedback

User Guide

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

[ aws . ec2 ]

create-client-vpn-endpoint

Description

Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-client-vpn-endpoint
--client-cidr-block <value>
--server-certificate-arn <value>
--authentication-options <value>
--connection-log-options <value>
[--dns-servers <value>]
[--transport-protocol <value>]
[--description <value>]
[--split-tunnel | --no-split-tunnel]
[--dry-run | --no-dry-run]
[--client-token <value>]
[--tag-specifications <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--client-cidr-block (string)

The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater.

--server-certificate-arn (string)

The ARN of the server certificate. For more information, see the AWS Certificate Manager User Guide .

--authentication-options (list)

Information about the authentication method to be used to authenticate clients.

Shorthand Syntax:

Type=string,ActiveDirectory={DirectoryId=string},MutualAuthentication={ClientRootCertificateChainArn=string} ...

JSON Syntax:

[
  {
    "Type": "certificate-authentication"|"directory-service-authentication",
    "ActiveDirectory": {
      "DirectoryId": "string"
    },
    "MutualAuthentication": {
      "ClientRootCertificateChainArn": "string"
    }
  }
  ...
]

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

Enabled=boolean,CloudwatchLogGroup=string,CloudwatchLogStream=string

JSON Syntax:

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

--dns-servers (list)

Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.

Syntax:

"string" "string" ...

--transport-protocol (string)

The transport protocol to be used by the VPN session.

Default value: udp

Possible values:

  • tcp
  • udp

--description (string)

A brief description of the Client VPN endpoint.

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

Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.

By default, split-tunnel on a VPN endpoint is disabled.

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 .

--client-token (string)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency .

--tag-specifications (list)

The tags to apply to the Client VPN endpoint during creation.

Shorthand Syntax:

ResourceType=string,Tags=[{Key=string,Value=string},{Key=string,Value=string}] ...

JSON Syntax:

[
  {
    "ResourceType": "client-vpn-endpoint"|"customer-gateway"|"dedicated-host"|"dhcp-options"|"elastic-ip"|"fleet"|"fpga-image"|"host-reservation"|"image"|"instance"|"internet-gateway"|"launch-template"|"natgateway"|"network-acl"|"network-interface"|"reserved-instances"|"route-table"|"security-group"|"snapshot"|"spot-instances-request"|"subnet"|"traffic-mirror-filter"|"traffic-mirror-session"|"traffic-mirror-target"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-route-table"|"volume"|"vpc"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
      ...
    ]
  }
  ...
]

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

Examples

To create a Client VPN endpoint

The following create-client-vpn-endpoint example creates a Client VPN endpoint that uses mutual authentication and specifies a value for the client CIDR block.

aws ec2 create-client-vpn-endpoint \
    --client-cidr-block "172.31.0.0/16" \
    --server-certificate-arn arn:aws:acm:ap-south-1:123456789012:certificate/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \
    --authentication-options Type=certificate-authentication,MutualAuthentication={ClientRootCertificateChainArn=arn:aws:acm:ap-south-1:123456789012:certificate/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE} \
    --connection-log-options Enabled=false

Output:

{
    "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde",
    "Status": {
        "Code": "pending-associate"
    },
    "DnsName": "cvpn-endpoint-123456789123abcde.prod.clientvpn.ap-south-1.amazonaws.com"
}

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

Output

ClientVpnEndpointId -> (string)

The ID of the Client VPN endpoint.

Status -> (structure)

The current state of the Client VPN endpoint.

Code -> (string)

The state of the Client VPN endpoint. Possible states include:

  • pending-associate - The Client VPN endpoint has been created but no target networks have been associated. The Client VPN endpoint cannot accept connections.
  • available - The Client VPN endpoint has been created and a target network has been associated. The Client VPN endpoint can accept connections.
  • deleting - The Client VPN endpoint is being deleted. The Client VPN endpoint cannot accept connections.
  • deleted - The Client VPN endpoint has been deleted. The Client VPN endpoint cannot accept connections.

Message -> (string)

A message about the status of the Client VPN endpoint.

DnsName -> (string)

The DNS name to be used by clients when establishing their VPN session.