AWS CloudFormation
User Guide (Version )

AWS::EC2::VPNGateway

Specifies a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.

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::VPNGateway", "Properties" : { "AmazonSideAsn" : Long, "Tags" : [ Tag, ... ], "Type" : String } }

YAML

Type: AWS::EC2::VPNGateway Properties: AmazonSideAsn: Long Tags: - Tag Type: String

Properties

AmazonSideAsn

The private Autonomous System Number (ASN) for the Amazon side of a BGP session.

Required: No

Type: Long

Update requires: Replacement

Tags

Any tags assigned to the virtual private gateway.

Required: No

Type: List of Tag

Update requires: No interruption

Type

The type of VPN connection the virtual private gateway supports.

Required: Yes

Type: String

Allowed Values: ipsec.1

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 gateway.

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

Examples

VPN Gateway

The following example declares a VPN gateway that uses IPSec 1.

JSON

"myVPNGateway" : { "Type" : "AWS::EC2::VPNGateway", "Properties" : { "Type" : "ipsec.1", "Tags" : [ { "Key" : "Use", "Value" : "Test" } ] } }

YAML

myVPNGateway: Type: AWS::EC2::VPNGateway Properties: Type: ipsec.1 Tags: - Key: Use Value: Test

See Also