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

AWS::EC2::CustomerGateway

Provides information to AWS about your VPN customer gateway device.

Syntax

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

JSON

Copy to clipboard
{ "Type" : "AWS::EC2::CustomerGateway", "Properties" : { "BgpAsn" : Number, "IpAddress" : String, "Tags" : [ Resource Tag, ... ], "Type" : String } }

YAML

Copy to clipboard
Type: "AWS::EC2::CustomerGateway" Properties: BgpAsn: Number IpAddress: String Tags: Resource Tag Type: String

Properties

BgpAsn

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

Required: Yes

Type: Number BgpAsn is always an integer value.

Update requires: Replacement

IpAddress

The internet-routable IP address for the customer gateway's outside interface. The address must be static.

Required: Yes

Type: String

Update requires: Replacement

Tags

The tags that you want to attach to the resource.

Required: No

Type: AWS CloudFormation Resource Tags.

Update requires: No interruption.

Type

The type of VPN connection that this customer gateway supports.

Required: Yes

Type: String

Update requires: Replacement

Example: ipsec.1

Return Value

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

Copy to clipboard
{ "Ref": "MyResource" }

For the resource with the logical ID "MyResource", Ref will return the AWS resource name.

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

Example

JSON

Copy to clipboard
{ "AWSTemplateFormatVersion" : "2010-09-09", "Resources" : { "myCustomerGateway" : { "Type" : "AWS::EC2::CustomerGateway", "Properties" : { "Type" : "ipsec.1", "BgpAsn" : "64000", "IpAddress" : "1.1.1.1" } } } }

YAML

Copy to clipboard
AWSTemplateFormatVersion: "2010-09-09" Resources: myCustomerGateway: Type: "AWS::EC2::CustomerGateway" Properties: Type: ipsec.1 BgpAsn: 64000 IpAddress: 1.1.1.1

See Also