AWS::EC2::CustomerGateway - Amazon CloudFormation
SyntaxPropertiesReturn valuesExamplesSee also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::EC2::CustomerGateway

Specifies a customer gateway.

Syntax

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

JSON

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

YAML

Type: AWS::EC2::CustomerGateway
Properties: 
  BgpAsn: Integer
  DeviceName: String
  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

DeviceName

The name of customer gateway device.

Required: No

Type: String

Update requires: Replacement

IpAddress

IPv4 address for the customer gateway device'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 Reffunction, Refreturns the ID of the customer 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.

CustomerGatewayId

The ID of the customer gateway.

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