AWS::EC2::ClientVpnRouteResource Type definition for AWS::EC2::ClientVpnRoute. Specifies a network route to add 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.
4 configurable properties. 2 required. Click a row to see details.
| Property | Type | Flags |
|---|---|---|
ClientVpnEndpointId | string | RequiredCreate-only |
DestinationCidrBlock | string | RequiredCreate-only |
Description | string | Create-only |
TargetVpcSubnetId | string | Create-only |
Values returned after the resource is created. Access these with Fn::GetAtt.
| Attribute | Type | Description |
|---|---|---|
Id | string | The CloudFormation-generated identifier for this Client VPN route, derived from the logical resource id and client request token. |
A minimal template with required properties and common optional ones.
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::EC2::ClientVpnRoute
Resources:
MyResource:
Type: AWS::EC2::ClientVpnRoute
Properties:
ClientVpnEndpointId: "my-clientvpnendpointid"
DestinationCidrBlock: "my-destinationcidrblock"
Description: !Ref "AWS::StackName"Permissions CloudFormation needs in your IAM role to manage this resource.
ec2:CreateClientVpnRouteec2:DescribeClientVpnRoutesec2:DescribeClientVpnRoutesec2:DeleteClientVpnRouteec2:DescribeClientVpnRoutesec2:DescribeClientVpnRoutesEverything you need to know about EC2 on one page. HD quality, print-friendly.
Download Free InfographicIdThese properties cannot be changed after the resource is created. Updating them triggers a replacement.
ClientVpnEndpointIdDestinationCidrBlockTargetVpcSubnetIdDescription