AWS::EC2::VPNConnectionRoute - AWS CloudFormation
SyntaxPropertiesReturn valuesExamplesSee also

AWS::EC2::VPNConnectionRoute

Specifies a static route for a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::EC2::VPNConnectionRoute",
  "Properties" : {
      "DestinationCidrBlock" : String,
      "VpnConnectionId" : String
    }
}

YAML

Type: AWS::EC2::VPNConnectionRoute
Properties:
  DestinationCidrBlock: String
  VpnConnectionId: String

Properties

DestinationCidrBlock

The CIDR block associated with the local subnet of the customer network.

Required: Yes

Type: String

Update requires: Replacement

VpnConnectionId

The ID of the VPN connection.

Required: Yes

Type: String

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ID of the VPN connection route.

For more information about using the Ref function, see Ref.

Examples

VPN connection route

The following example specifies a VPN connection route.

JSON

"MyConnectionRoute0" : {
   "Type" : "AWS::EC2::VPNConnectionRoute",
    "Properties" : {
       "DestinationCidrBlock" : "10.0.0.0/16",
       "VpnConnectionId" : {"Ref" : "Connection0"}
    }
}

YAML

MyConnectionRoute0: 
  Type: AWS::EC2::VPNConnectionRoute
  Properties: 
     DestinationCidrBlock: 10.0.0.0/16
     VpnConnectionId: 
     !Ref Connection0

See also