AWS::EC2::TransitGatewayPeeringAttachment - AWS CloudFormation

AWS::EC2::TransitGatewayPeeringAttachment

Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The transit gateways must be in different Regions. The peer transit gateway can be in your account or a different AWS account.

After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.

Syntax

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

JSON

{ "Type" : "AWS::EC2::TransitGatewayPeeringAttachment", "Properties" : { "PeerAccountId" : String, "PeerRegion" : String, "PeerTransitGatewayId" : String, "Tags" : [ Tag, ... ], "TransitGatewayId" : String } }

YAML

Type: AWS::EC2::TransitGatewayPeeringAttachment Properties: PeerAccountId: String PeerRegion: String PeerTransitGatewayId: String Tags: - Tag TransitGatewayId: String

Properties

PeerAccountId

The ID of the AWS account that owns the transit gateway.

Required: Yes

Type: String

Update requires: Replacement

PeerRegion

The Region of the transit gateway.

Required: Yes

Type: String

Update requires: Replacement

PeerTransitGatewayId

The ID of the transit gateway.

Required: Yes

Type: String

Update requires: Replacement

Tags

The tags for the transit gateway peering attachment.

Required: No

Type: List of Tag

Update requires: No interruption

TransitGatewayId

The ID of the transit gateway peering attachment.

Required: Yes

Type: String

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ID of the transit gateway peering attachment.

For more information about using the Ref function, see Ref.

Fn::GetAtt

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 Fn::GetAtt.

CreationTime

The time the transit gateway peering attachment was created.

State

The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.

TransitGatewayAttachmentId

The ID of the transit gateway peering attachment.

See also