AWS::EC2::CarrierGateway

EC2 CarrierGateway

Resource Type definition for Carrier Gateway which describes the Carrier Gateway resource

Properties

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

Filter:

Property	Type	Flags
`VpcId`	`string`	RequiredCreate-only
`Tags`	`array`

Return Values

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

Attribute	Type	Description
`CarrierGatewayId`	`string`	The ID of the carrier gateway.
`OwnerId`	`string`	The ID of the owner.
`State`	`string`	The state of the carrier gateway.

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::CarrierGateway

Resources:
  MyResource:
    Type: AWS::EC2::CarrierGateway
    Properties:
      VpcId: "my-vpcid"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

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

create

ec2:CreateCarrierGatewayec2:DescribeCarrierGatewaysec2:CreateTags

read

ec2:DescribeCarrierGatewaysec2:DescribeTags

update

ec2:DescribeCarrierGatewaysec2:CreateTagsec2:DeleteTagsec2:DescribeTags

delete

ec2:DeleteCarrierGatewayec2:DescribeCarrierGatewaysec2:DeleteTags

list

ec2:DescribeCarrierGateways

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

Properties5

Required1

TaggingSupported

Primary IDCarrierGatewayId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

VpcId

Related Resources

External Links

AWS Documentation