Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

CreateClientVpnRoute

Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

ClientToken

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

Type: String

Required: No

ClientVpnEndpointId

The ID of the Client VPN endpoint to which to add the route.

Type: String

Required: Yes

Description

A brief description of the route.

Type: String

Required: No

DestinationCidrBlock

The IPv4 address range, in CIDR notation, of the route destination. For example:

  • To add a route for Internet access, enter 0.0.0.0/0

  • To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range

  • To add a route for an on-premises network, enter the AWS Site-to-Site VPN connection's IPv4 CIDR range

Route address ranges cannot overlap with the CIDR range specified for client allocation.

Type: String

Required: Yes

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.

Type: Boolean

Required: No

TargetVpcSubnetId

The ID of the subnet through which you want to route traffic. The specified subnet must be an existing target network of the Client VPN endpoint.

Type: String

Required: Yes

Response Elements

The following elements are returned by the service.

requestId

The ID of the request.

Type: String

status

The current state of the route.

Type: ClientVpnRouteStatus object

Errors

For information about the errors that are common to all actions, see Common Client Errors.

Example

Example

This example adds a route for Internet access to the Client VPN endpoint.

Sample Request

https://ec2.amazonaws.com/?Action=CreateClientVpnRoute &ClientVpnEndpointId=cvpn-endpoint-00c5d11fc4EXAMPLE &DestinationCidrBlock=0.0.0.0/0 &TargetVpcSubnetId=subnet-057fa0918fEXAMPLE &AUTHPARAMS

Sample Response

<CreateClientVpnRouteResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>5b301186-e6d3-436b-87d6-7c400EXAMPLE</requestId> <status> <code>creating</code> </status> </CreateClientVpnRouteResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: