AWS Fundamentals Logo
AWS Fundamentals
AWS::EC2::CustomerGateway

EC2 CustomerGateway

Specifies a customer gateway.

Properties

7 configurable properties. 2 required. Click a row to see details.

Filter:
PropertyTypeFlags
IpAddress
string
RequiredCreate-only
Type
string
RequiredCreate-only
BgpAsn
integer
Create-only
BgpAsnExtended
number
Create-only
CertificateArn
string
Create-only
DeviceName
string
Create-only
Tags
Array<Tag>

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
CustomerGatewayIdstring-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::EC2::CustomerGateway

Resources:
  MyResource:
    Type: AWS::EC2::CustomerGateway
    Properties:
      IpAddress: "value"
      Type: "value"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

read

ec2:DescribeCustomerGateways

create

ec2:CreateCustomerGatewayec2:DescribeCustomerGatewaysec2:CreateTags

update

ec2:CreateTagsec2:DeleteTagsec2:DescribeCustomerGateways

list

ec2:DescribeCustomerGateways

delete

ec2:DeleteCustomerGatewayec2:DescribeCustomerGateways

Get the EC2 Cheat Sheet

Everything you need to know about EC2 on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceEC2
Properties8
Required2
TaggingSupported
Primary IDCustomerGatewayId

Supported Operations

ReadCreateUpdateListDelete

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

CertificateArnBgpAsnBgpAsnExtendedTypeIpAddressDeviceName

Related Resources

External Links