Create Client Vpn Route

ec2_create_client_vpn_route

R Documentation

Adds a route to a network to a Client VPN endpoint

Description

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.

Usage

ec2_create_client_vpn_route(ClientVpnEndpointId, DestinationCidrBlock,
  TargetVpcSubnetId, Description, ClientToken, DryRun)

Arguments

ClientVpnEndpointId

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

DestinationCidrBlock

[required] 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 Amazon Web Services Site-to-Site VPN connection's IPv4 CIDR range

• To add a route for the local network, enter the client CIDR range

TargetVpcSubnetId

[required] 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.

Alternatively, if you're adding a route for the local network, specify local.

Description

A brief description of the route.

ClientToken

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

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.

Value

A list with the following syntax:

list(
  Status = list(
    Code = "creating"|"active"|"failed"|"deleting",
    Message = "string"
  )
)

Request syntax

svc$create_client_vpn_route(
  ClientVpnEndpointId = "string",
  DestinationCidrBlock = "string",
  TargetVpcSubnetId = "string",
  Description = "string",
  ClientToken = "string",
  DryRun = TRUE|FALSE
)