This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::EC2::CarrierGateway
<a name="aws-resource-ec2-carriergateway"></a>

Creates a carrier gateway. For more information about carrier gateways, see [Carrier gateways](https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#wavelength-carrier-gateway) in the *AWS Wavelength Developer Guide*.

## Syntax
<a name="aws-resource-ec2-carriergateway-syntax"></a>

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

### JSON
<a name="aws-resource-ec2-carriergateway-syntax.json"></a>

```
{
  "Type" : "AWS::EC2::CarrierGateway",
  "Properties" : {
      "[Tags](#cfn-ec2-carriergateway-tags)" : [ Tag, ... ],
      "[VpcId](#cfn-ec2-carriergateway-vpcid)" : String
    }
}
```

### YAML
<a name="aws-resource-ec2-carriergateway-syntax.yaml"></a>

```
Type: AWS::EC2::CarrierGateway
Properties:
  [Tags](#cfn-ec2-carriergateway-tags): 
    - Tag
  [VpcId](#cfn-ec2-carriergateway-vpcid): String
```

## Properties
<a name="aws-resource-ec2-carriergateway-properties"></a>

`Tags`  <a name="cfn-ec2-carriergateway-tags"></a>
The tags assigned to the carrier gateway.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-ec2-carriergateway-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VpcId`  <a name="cfn-ec2-carriergateway-vpcid"></a>
The ID of the VPC associated with the carrier gateway.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-ec2-carriergateway-return-values"></a>

### Ref
<a name="aws-resource-ec2-carriergateway-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the carrier gateway ID. For example: `cagw-05a8da9a199afb1c7`.

### Fn::GetAtt
<a name="aws-resource-ec2-carriergateway-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-ec2-carriergateway-return-values-fn--getatt-fn--getatt"></a>

`CarrierGatewayId`  <a name="CarrierGatewayId-fn::getatt"></a>
The ID of the carrier gateway.

`OwnerId`  <a name="OwnerId-fn::getatt"></a>
The AWS account ID of the owner of the carrier gateway.

`State`  <a name="State-fn::getatt"></a>
The state of the carrier gateway.

## See also
<a name="aws-resource-ec2-carriergateway--seealso"></a>
+ [Carrier gateways](https://docs.aws.amazon.com/vpc/latest/userguide/Carrier_Gateway.html) in *Amazon VPC User Guide*
+ [CreateCarrierGateway](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateCarrierGateway.html) in the *Amazon EC2 API Reference*



# AWS::EC2::CarrierGateway Tag
<a name="aws-properties-ec2-carriergateway-tag"></a>

Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).

## Syntax
<a name="aws-properties-ec2-carriergateway-tag-syntax"></a>

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

### JSON
<a name="aws-properties-ec2-carriergateway-tag-syntax.json"></a>

```
{
  "[Key](#cfn-ec2-carriergateway-tag-key)" : String,
  "[Value](#cfn-ec2-carriergateway-tag-value)" : String
}
```

### YAML
<a name="aws-properties-ec2-carriergateway-tag-syntax.yaml"></a>

```
  [Key](#cfn-ec2-carriergateway-tag-key): String
  [Value](#cfn-ec2-carriergateway-tag-value): String
```

## Properties
<a name="aws-properties-ec2-carriergateway-tag-properties"></a>

`Key`  <a name="cfn-ec2-carriergateway-tag-key"></a>
The tag key.  
*Required*: No  
*Type*: String  
*Pattern*: `^(?!aws:.*)`  
*Minimum*: `1`  
*Maximum*: `127`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-ec2-carriergateway-tag-value"></a>
The tag value.  
*Required*: No  
*Type*: String  
*Pattern*: `^(?!aws:.*)`  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Examples
<a name="aws-properties-ec2-carriergateway-tag--examples"></a>

### 
<a name="aws-properties-ec2-carriergateway-tag--examples--"></a>

This example specifies two tags for the carrier gateway.

#### JSON
<a name="aws-properties-ec2-carriergateway-tag--examples----json"></a>

```
"Tags" : [
   {
      "Key" : "key1",
      "Value" : "value1"
   },
   {
      "Key" : "key2",
      "Value" : "value2"
   }
]
```

#### YAML
<a name="aws-properties-ec2-carriergateway-tag--examples----yaml"></a>

```
Tags: 
  - Key: "key1"
    Value: "value1"
  - Key: "key2"
    Value: "value2"
```