DeleteClientVpnRoute
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.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- ClientVpnEndpointId
-
The ID of the Client VPN endpoint from which the route is to be deleted.
Type: String
Required: Yes
- DestinationCidrBlock
-
The IPv4 address range, in CIDR notation, of the route to be deleted.
Type: String
Required: Yes
- 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 isUnauthorizedOperation
.Type: Boolean
Required: No
- TargetVpcSubnetId
-
The ID of the target subnet used by the route.
Type: String
Required: No
Response Elements
The following elements are returned by the service.
- requestId
-
The ID of the request.
Type: String
- status
-
The current state of the route.
Type: ClientVpnRouteStatus object
Errors
For information about the errors that are common to all actions, see Common client error codes.
Examples
Example
This example deletes a route from a Client VPN endpoint.
Sample Request
https://ec2.amazonaws.com/?Action=DeleteClientVpnRoute
&ClientVpnEndpointId=cvpn-endpoint-00c5d11fc4EXAMPLE
&DestinationCidrBlock=0.0.0.0/0
&TargetVpcSubnetId=subnet-057fa0918fEXAMPLE
&AUTHPARAMS
Sample Response
<DeleteClientVpnRouteResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
<requestId>00d80748-708d-40f7-8635-f34acEXAMPLE</requestId>
<status>
<code>deleting</code>
</status>
</DeleteClientVpnRouteResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: