Sign In to the Console
AWS CloudFormation
User Guide (Version )

AWS Documentation » AWS CloudFormation » User Guide » EC2 Resource Type Reference » AWS::EC2::CustomerGateway

AWS::EC2::CustomerGateway

Specifies a customer gateway.

Syntax

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

JSON

{
  "Type" : "AWS::EC2::CustomerGateway",
  "Properties" : {
      "BgpAsn" : Integer,
      "IpAddress" : String,
      "Tags" : [ Tag, ... ],
      "Type" : String
    }
}

YAML

Type: AWS::EC2::CustomerGateway
Properties: 
  BgpAsn: Integer
  IpAddress: String
  Tags: 
    - Tag
  Type: String

Properties

BgpAsn

For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

Required: Yes

Type: Integer

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

One or more tags for the customer gateway.

Required: No

Type: List of Tag

Update requires: No interruption

Type

The type of VPN connection that this customer gateway supports (ipsec.1).

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

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

Examples

YAML

myCustomerGateway: 
    Type: AWS::EC2::CustomerGateway
    Properties: 
        Type: ipsec.1
        BgpAsn: 65534
        IpAddress: 12.1.2.3

JSON

{
    "myCustomerGateway" : {
        "Type" : "AWS::EC2::CustomerGateway",
        "Properties" : {
            "Type" : "ipsec.1",
            "BgpAsn" : "65534",
            "IpAddress" : "12.1.2.3"
        }
    }
}

See Also