aws ec2 create-client-vpn-route

Adds a route to a network to a Client VPN endpoint. AWS CLI reference

1 example 6 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To create a route for a Client VPN endpoint

The following create-client-vpn-route example adds a route to the internet (0.0.0.0/0) for the specified subnet of the Client VPN endpoint.

aws ec2 create-client-vpn-route --client-vpn-endpoint-id cvpn-endpoint-123456789012abcde --destination-cidr-block 0.0.0.0/0 --target-vpc-subnet-id subnet-0123456789abcabca

Identify

--client-vpn-endpoint-idThe ID of the Client VPN endpoint to which to add the route.

--destination-cidr-blockThe IPv4 address range, in CIDR notation, of the route destination.

--target-vpc-subnet-idThe ID of the subnet through which you want to route traffic.

Its output

{
    "Status": {
        "Code": "creating"
    }
}

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

Options

6 in the AWS CLI reference

--client-tokenUnique, case-sensitive identifier that you provide to ensure the idempotency of the request.

--client-vpn-endpoint-idThe ID of the Client VPN endpoint to which to add the route.

--descriptionA brief description of the route.

--destination-cidr-blockThe IPv4 address range, in CIDR notation, of the route destination.

--dry-runChecks whether you have the required permissions for the action, without actually making the request, and provides an error response.

--target-vpc-subnet-idThe ID of the subnet through which you want to route traffic.