AWS::NetworkManager::TransitGatewayPeering - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::NetworkManager::TransitGatewayPeering

Creates a transit gateway peering connection.

Syntax

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

JSON

{
  "Type" : "AWS::NetworkManager::TransitGatewayPeering",
  "Properties" : {
      "CoreNetworkId" : String,
      "Tags" : [ Tag, ... ],
      "TransitGatewayArn" : String
    }
}

YAML

Type: AWS::NetworkManager::TransitGatewayPeering
Properties:
  CoreNetworkId: String
  Tags: 
    - Tag
  TransitGatewayArn: String

Properties

CoreNetworkId

The ID of the core network.

Required: Yes

Type: String

Update requires: Replacement

Tags

The list of key-value tags associated with the peering.

Required: No

Type: Array of Tag

Update requires: No interruption

TransitGatewayArn

The ARN of the transit gateway.

Required: Yes

Type: String

Pattern: [\s\S]*

Minimum: 0

Maximum: 500

Update requires: Replacement

Return values

Ref

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 Ref.

Fn::GetAtt

CoreNetworkArn

The ARN of the core network.

CreatedAt

The timestamp when the core network peering was created.

EdgeLocation

The edge location for the peer.

OwnerAccountId

The ID of the account owner.

PeeringId

The ID of the peering.

PeeringType

The peering type. This will be TRANSIT_GATEWAY.

ResourceArn

The ARN of the resource peered to a core network.

State

The current state of the peer. This can be CREATING | FAILED | AVAILABLE | DELETING.

TransitGatewayPeeringAttachmentId

The ID of the peering attachment.