ec2_create_client_vpn_route {aws.ecx} | R Documentation |
Create Client Vpn Route
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 tra_c to speci_c resources or networks.
Usage
ec2_create_client_vpn_route(
ClientVpnEndpointId,
DestinationCidrBlock,
TargetVpcSubnetId,
Description = NULL,
ClientToken = NULL,
DryRun = NULL,
simplify = TRUE,
others = list(),
print_on_error = aws_get_print_on_error(),
retry_time = aws_get_retry_time(),
network_timeout = aws_get_network_timeout(),
region = aws_get_region()
)
Arguments
ClientVpnEndpointId |
Character. The ID of the Client VPN endpoint to which to add the route. |
DestinationCidrBlock |
Character. The IPv4 address range, in CIDR notation, of the route destination. |
TargetVpcSubnetId |
Character. The ID of the subnet through which you want to route traffic. |
Description |
Character. A brief description of the route.[optional] |
ClientToken |
Character. Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.[optional] |
DryRun |
Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional] |
simplify |
Logical. Whether to simplify the result and handle |
others |
Named list. The parameters that are not included in the function parameters and need to be added into the request[optional] |
print_on_error |
Logical. Whether to show an error message when a network error occurs. |
retry_time |
Integer. Number of retries for a REST request when encounter the
network issue. If the request has been sent |
network_timeout |
Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms. |
region |
Character. The region of the AWS service. |
Value
A list object or a character vector
ClientVpnEndpointId
The ID of the Client VPN endpoint to which to add the route.
DestinationCidrBlock
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 AWS Site-to-Site VPN connection\'s IPv4 CIDR range
To add a route for the local network, enter the client CIDR range
TargetVpcSubnetId
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 How to Ensure 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
.