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::NetworkManager::TransitGatewayPeering
<a name="aws-resource-networkmanager-transitgatewaypeering"></a>

Creates a transit gateway peering connection.

## Syntax
<a name="aws-resource-networkmanager-transitgatewaypeering-syntax"></a>

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

### JSON
<a name="aws-resource-networkmanager-transitgatewaypeering-syntax.json"></a>

```
{
  "Type" : "AWS::NetworkManager::TransitGatewayPeering",
  "Properties" : {
      "[CoreNetworkId](#cfn-networkmanager-transitgatewaypeering-corenetworkid)" : String,
      "[Tags](#cfn-networkmanager-transitgatewaypeering-tags)" : [ Tag, ... ],
      "[TransitGatewayArn](#cfn-networkmanager-transitgatewaypeering-transitgatewayarn)" : String
    }
}
```

### YAML
<a name="aws-resource-networkmanager-transitgatewaypeering-syntax.yaml"></a>

```
Type: AWS::NetworkManager::TransitGatewayPeering
Properties:
  [CoreNetworkId](#cfn-networkmanager-transitgatewaypeering-corenetworkid): String
  [Tags](#cfn-networkmanager-transitgatewaypeering-tags): 
    - Tag
  [TransitGatewayArn](#cfn-networkmanager-transitgatewaypeering-transitgatewayarn): String
```

## Properties
<a name="aws-resource-networkmanager-transitgatewaypeering-properties"></a>

`CoreNetworkId`  <a name="cfn-networkmanager-transitgatewaypeering-corenetworkid"></a>
The ID of the core network.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-networkmanager-transitgatewaypeering-tags"></a>
The list of key-value tags associated with the peering.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-networkmanager-transitgatewaypeering-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TransitGatewayArn`  <a name="cfn-networkmanager-transitgatewaypeering-transitgatewayarn"></a>
The ARN of the transit gateway.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[\s\S]*`  
*Minimum*: `0`  
*Maximum*: `500`  
*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-networkmanager-transitgatewaypeering-return-values"></a>

### Ref
<a name="aws-resource-networkmanager-transitgatewaypeering-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `peeringId`. For example: `peering-01234ab1234a12a12`.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

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

#### 
<a name="aws-resource-networkmanager-transitgatewaypeering-return-values-fn--getatt-fn--getatt"></a>

`CoreNetworkArn`  <a name="CoreNetworkArn-fn::getatt"></a>
The ARN of the core network.

`CreatedAt`  <a name="CreatedAt-fn::getatt"></a>
The timestamp when the core network peering was created.

`EdgeLocation`  <a name="EdgeLocation-fn::getatt"></a>
The edge location for the peer.

`LastModificationErrors`  <a name="LastModificationErrors-fn::getatt"></a>
Property description not available.

`OwnerAccountId`  <a name="OwnerAccountId-fn::getatt"></a>
The ID of the account owner.

`PeeringId`  <a name="PeeringId-fn::getatt"></a>
The ID of the peering.

`PeeringType`  <a name="PeeringType-fn::getatt"></a>
The peering type. This will be `TRANSIT_GATEWAY`.

`ResourceArn`  <a name="ResourceArn-fn::getatt"></a>
The ARN of the resource peered to a core network.

`State`  <a name="State-fn::getatt"></a>
The current state of the peer. This can be `CREATING` \$1 `FAILED` \$1 `AVAILABLE` \$1 `DELETING`.

`TransitGatewayPeeringAttachmentId`  <a name="TransitGatewayPeeringAttachmentId-fn::getatt"></a>
The ID of the peering attachment.

# AWS::NetworkManager::TransitGatewayPeering Tag
<a name="aws-properties-networkmanager-transitgatewaypeering-tag"></a>

Describes a tag.

## Syntax
<a name="aws-properties-networkmanager-transitgatewaypeering-tag-syntax"></a>

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

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

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

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

```
  [Key](#cfn-networkmanager-transitgatewaypeering-tag-key): String
  [Value](#cfn-networkmanager-transitgatewaypeering-tag-value): String
```

## Properties
<a name="aws-properties-networkmanager-transitgatewaypeering-tag-properties"></a>

`Key`  <a name="cfn-networkmanager-transitgatewaypeering-tag-key"></a>
The tag key.  
Constraints: Maximum length of 128 characters.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*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-networkmanager-transitgatewaypeering-tag-value"></a>
The tag value.  
Constraints: Maximum length of 256 characters.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)