Menu
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS::EC2::VPNGateway

Creates a virtual private gateway. A virtual private gateway is the VPC-side endpoint for your VPN connection.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

Copy
{ "Type" : "AWS::EC2::VPNGateway", "Properties" : { "Type" : String, "Tags" : [ Resource Tag, ... ] } }

YAML

Copy
Type: "AWS::EC2::VPNGateway" Properties: Type: String Tags: Resource Tag

Properties

Type

The type of VPN connection this virtual private gateway supports. The only valid value is "ipsec.1".

Required: Yes

Type: String

Update requires: Replacement

Tags

An arbitrary set of tags (key–value pairs) for this resource.

Required: No

Type: AWS CloudFormation Resource Tags

Update requires: No interruption.

Return Value

When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the resource name. For example:

Copy
{ "Ref": "MyVPNGateway" }

For the VPN gateway with the logical ID "MyVPNGateway", Ref will return the gateway's resource name.

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

Example

JSON

Copy
{ "AWSTemplateFormatVersion" : "2010-09-09", "Resources" : { "myVPNGateway" : { "Type" : "AWS::EC2::VPNGateway", "Properties" : { "Type" : "ipsec.1", "Tags" : [ { "Key" : "Use", "Value" : "Test" } ] } } } }

YAML

Copy
AWSTemplateFormatVersion: "2010-09-09" Resources: myVPNGateway: Type: "AWS::EC2::VPNGateway" Properties: Type: ipsec.1 Tags: - Key: Use Value: Test

See Also