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::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](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *AWS Site-to-Site VPN User Guide*. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::EC2::VPNGateway", "Properties" : { "[AmazonSideAsn](#cfn-ec2-vpngateway-amazonsideasn)" : {{Integer}}, "[Tags](#cfn-ec2-vpngateway-tags)" : {{[ Tag, ... ]}}, "[Type](#cfn-ec2-vpngateway-type)" : {{String}} } } ``` ### YAML ``` Type: AWS::EC2::VPNGateway Properties: [AmazonSideAsn](#cfn-ec2-vpngateway-amazonsideasn): {{Integer}} [Tags](#cfn-ec2-vpngateway-tags): {{ - Tag}} [Type](#cfn-ec2-vpngateway-type): {{String}} ``` ## Properties `AmazonSideAsn` The private Autonomous System Number (ASN) for the Amazon side of a BGP session. *Required*: No *Type*: Integer *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Tags` Any tags assigned to the virtual private gateway. *Required*: No *Type*: Array of [Tag](aws-properties-ec2-vpngateway-tag.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The type of VPN connection the virtual private gateway supports. *Required*: Yes *Type*: String *Allowed values*: `ipsec.1` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-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 [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). #### `VPNGatewayId` The ID of the VPN gateway. ## 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 + [CreateVPNGateway](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVPNGateway.html) in the *Amazon EC2 API Reference*