AWS::NetworkManager::TransitGatewayRouteTableAttachment

Creates a transit gateway route table attachment.

Syntax

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

JSON

{
  "Type" : "AWS::NetworkManager::TransitGatewayRouteTableAttachment",
  "Properties" : {
      "NetworkFunctionGroupName" : String,
      "PeeringId" : String,
      "ProposedNetworkFunctionGroupChange" : ProposedNetworkFunctionGroupChange,
      "ProposedSegmentChange" : ProposedSegmentChange,
      "Tags" : [ Tag, ... ],
      "TransitGatewayRouteTableArn" : String
    }
}

YAML

Type: AWS::NetworkManager::TransitGatewayRouteTableAttachment
Properties:
  NetworkFunctionGroupName: String
  PeeringId: String
  ProposedNetworkFunctionGroupChange: 
    ProposedNetworkFunctionGroupChange
  ProposedSegmentChange: 
    ProposedSegmentChange
  Tags: 
    - Tag
  TransitGatewayRouteTableArn: String

Properties

NetworkFunctionGroupName

The name of the network function group.

Required: No

Type: String

Pattern: [\s\S]*

Minimum: 0

Maximum: 256

Update requires: No interruption

PeeringId

The ID of the transit gateway peering.

Required: Yes

Type: String

Pattern: ^peering-([0-9a-f]{8,17})$

Minimum: 0

Maximum: 50

Update requires: Replacement

ProposedNetworkFunctionGroupChange

Describes proposed changes to a network function group.

Required: No

Type: ProposedNetworkFunctionGroupChange

Update requires: No interruption

ProposedSegmentChange

This property is read-only. Values can't be assigned to it.

Required: No

Type: ProposedSegmentChange

Update requires: No interruption

Tags

The list of key-value pairs associated with the transit gateway route table attachment.

Required: No

Type: Array of Tag

Update requires: No interruption

TransitGatewayRouteTableArn

The ARN of the transit gateway attachment route table. For example, "TransitGatewayRouteTableArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway-route-table/tgw-rtb-9876543210123456".

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 attachment ID of the transit gateway route table. For example: attachment-12367e74104d31234.

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.

AttachmentId

The ID of the transit gateway route table attachment.

AttachmentPolicyRuleNumber

The policy rule number associated with the attachment.

AttachmentType

The type of attachment. This will be TRANSIT_GATEWAY_ROUTE_TABLE.

CoreNetworkArn

The ARN of the core network.

CoreNetworkId

The ID of the core network.

CreatedAt

The timestamp when the transit gateway route table attachment was created.

EdgeLocation

The Region where the core network edge is located.

OwnerAccountId

The ID of the transit gateway route table attachment owner.

ResourceArn

The resource ARN for the transit gateway route table attachment.

SegmentName

The name of the attachment's segment.

State

The state of the attachment. This can be: REJECTED | PENDING_ATTACHMENT_ACCEPTANCE | CREATING | FAILED | AVAILABLE | UPDATING | PENDING_NETWORK_UPDATE | PENDING_TAG_ACCEPTANCE | DELETING.

UpdatedAt

The timestamp when the transit gateway route table attachment was last updated.