EC2 / Client / create_client_vpn_route

create_client_vpn_route

EC2.Client.create_client_vpn_route(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_client_vpn_route(
    ClientVpnEndpointId='string',
    DestinationCidrBlock='string',
    TargetVpcSubnetId='string',
    Description='string',
    ClientToken='string',
    DryRun=True|False
)

Parameters:

• ClientVpnEndpointId (string) –

  [REQUIRED]

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

• DestinationCidrBlock (string) –

  [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 (string) –

  [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 (string) – A brief description of the route.

• ClientToken (string) –

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

  This field is autopopulated if not provided.

• DryRun (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.

Return type:

dict

Returns:

Response Syntax

{
    'Status': {
        'Code': 'creating'|'active'|'failed'|'deleting',
        'Message': 'string'
    }
}

Response Structure

• (dict) –

  • Status (dict) –

    The current state of the route.

    • Code (string) –

      The state of the Client VPN endpoint route.

    • Message (string) –

      A message about the status of the Client VPN endpoint route, if applicable.