This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html). # AWS::EC2::VPNGatewayRoutePropagation Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC. If you reference a VPN gateway that is in the same template as your VPN gateway route propagation, you must explicitly declare a dependency on the VPN gateway attachment. The `AWS::EC2::VPNGatewayRoutePropagation` resource cannot use the VPN gateway until it has successfully attached to the VPC. Add a [ DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) in the `AWS::EC2::VPNGatewayRoutePropagation` resource to explicitly declare a dependency on the VPN gateway attachment. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::EC2::VPNGatewayRoutePropagation", "Properties" : { "[RouteTableIds](#cfn-ec2-vpngatewayroutepropagation-routetableids)" : {{[ String, ... ]}}, "[VpnGatewayId](#cfn-ec2-vpngatewayroutepropagation-vpngatewayid)" : {{String}} } } ``` ### YAML ``` Type: AWS::EC2::VPNGatewayRoutePropagation Properties: [RouteTableIds](#cfn-ec2-vpngatewayroutepropagation-routetableids): {{ - String}} [VpnGatewayId](#cfn-ec2-vpngatewayroutepropagation-vpngatewayid): {{String}} ``` ## Properties `RouteTableIds` The ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to. *Required*: Yes *Type*: Array of String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `VpnGatewayId` The ID of the virtual private gateway that is attached to a VPC. The virtual private gateway must be attached to the same VPC that the routing tables are associated with. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the VPN gateway. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `Id` The ID of the VPN gateway. ## Examples ### VPN gateway route propagation The following example enables route propagation for the private route table named PrivateRouteTable . #### JSON ``` "myVPNGatewayRouteProp" : { "Type" : "AWS::EC2::VPNGatewayRoutePropagation", "Properties" : { "RouteTableIds" : [{"Ref" : "PrivateRouteTable"}], "VpnGatewayId" : {"Ref" : "VPNGateway"} } } ``` #### YAML ``` myVPNGatewayRouteProp: Type: AWS::EC2::VPNGatewayRoutePropagation Properties: RouteTableIds: - !Ref PrivateRouteTable VpnGatewayId: !Ref VPNGateway ``` ## See also + [EnableVgwRoutePropagation](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EnableVgwRoutePropagation.html) in the *Amazon EC2 API Reference*