Skip to content

Describe Client Vpn Routes

ec2_describe_client_vpn_routes R Documentation

Describes the routes for the specified Client VPN endpoint

Description

Describes the routes for the specified Client VPN endpoint.

Usage

ec2_describe_client_vpn_routes(ClientVpnEndpointId, Filters, MaxResults,
  NextToken, DryRun)

Arguments

ClientVpnEndpointId

[required] The ID of the Client VPN endpoint.

Filters

One or more filters. Filter names and values are case-sensitive.

  • destination-cidr - The CIDR of the route destination.

  • origin - How the route was associated with the Client VPN endpoint (associate | add-route).

  • target-subnet - The ID of the subnet through which traffic is routed.

MaxResults

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

NextToken

The token to retrieve the next page of results.

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(
  Routes = list(
    list(
      ClientVpnEndpointId = "string",
      DestinationCidr = "string",
      TargetSubnet = "string",
      Type = "string",
      Origin = "string",
      Status = list(
        Code = "creating"|"active"|"failed"|"deleting",
        Message = "string"
      ),
      Description = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_client_vpn_routes(
  ClientVpnEndpointId = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string",
  DryRun = TRUE|FALSE
)