AWS::EC2::CustomerGateway - AWS CloudFormation
SyntaxPropertiesReturn valuesExamplesSee also

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,
      "BgpAsnExtended" : Number,
      "CertificateArn" : String,
      "DeviceName" : String,
      "IpAddress" : String,
      "Tags" : [ Tag, ... ],
      "Type" : String
    }
}

YAML

Type: AWS::EC2::CustomerGateway
Properties:
  BgpAsn: Integer
  BgpAsnExtended: Number
  CertificateArn: String
  DeviceName: String
  IpAddress: String
  Tags: 
    - Tag
  Type: String

Properties

BgpAsn

For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.

Default: 65000

Valid values: 1 to 2,147,483,647

Required: No

Type: Integer

Update requires: Replacement

BgpAsnExtended

For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.

Valid values: 2,147,483,648 to 4,294,967,295

Required: No

Type: Number

Minimum: 2147483648

Maximum: 4294967294

Update requires: Replacement

CertificateArn

The Amazon Resource Name (ARN) for the customer gateway certificate.

Required: No

Type: String

Pattern: ^arn:(aws[a-zA-Z-]*)?:acm:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:certificate\/[a-zA-Z0-9-_]+$

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. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.

Required: Yes

Type: String

Update requires: Replacement

Tags

One or more tags for the customer gateway.

Required: No

Type: Array 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.

Fn::GetAtt

The Fn::GetAtt intrinsic 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::GetAtt intrinsic function, see Fn::GetAtt.

CustomerGatewayId

The ID of the customer gateway.

Examples

Create a customer gateway

The following example creates a customer gateway.

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