Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » Amazon EC2 Resource Types Reference » AWS::EC2::VPNConnectionRoute

AWS::EC2::VPNConnectionRoute

A static route that is associated with 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.

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 that is 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 the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the resource name.

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

Example

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