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 Amazon Site-to-Site VPN in the Amazon Site-to-Site VPN User Guide.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::EC2::VPNGateway", "Properties" : { "AmazonSideAsn" :Integer, "Tags" :[ Tag, ... ], "Type" :String} }
YAML
Type: AWS::EC2::VPNGateway Properties: AmazonSideAsn:IntegerTags:- TagType:String
Properties
AmazonSideAsn-
The private Autonomous System Number (ASN) for the Amazon side of a BGP session.
Required: No
Type: Integer
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.1Update requires: Replacement
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Reffunction, Refreturns the ID of the VPN gateway.
For more information about using the Reffunction, see Ref.
Fn::GetAtt
The Fn::GetAttintrinsic 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::GetAttintrinsic function, see Fn::GetAtt.
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 in the Amazon EC2 API Reference