Skip to content

Delete Client Vpn Route

ec2_delete_client_vpn_route R Documentation

Deletes a route from a Client VPN endpoint

Description

Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using the CreateClientVpnRoute action. You cannot delete routes that were automatically added when associating a subnet. To remove routes that have been automatically added, disassociate the target subnet from the Client VPN endpoint.

Usage

ec2_delete_client_vpn_route(ClientVpnEndpointId, TargetVpcSubnetId,
  DestinationCidrBlock, DryRun)

Arguments

ClientVpnEndpointId

[required] The ID of the Client VPN endpoint from which the route is to be deleted.

TargetVpcSubnetId

The ID of the target subnet used by the route.

DestinationCidrBlock

[required] The IPv4 address range, in CIDR notation, of the route to be deleted.

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$delete_client_vpn_route(
  ClientVpnEndpointId = "string",
  TargetVpcSubnetId = "string",
  DestinationCidrBlock = "string",
  DryRun = TRUE|FALSE
)