Documentation AWS CloudFormation Template Reference

Syntax Properties Return values See also

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.

AWS::EC2::TransitGatewayMulticastDomainAssociation

Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.

The transit gateway attachment must be in the available state before you can add a resource.

Syntax

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

JSON


{
 "Type" : "AWS::EC2::TransitGatewayMulticastDomainAssociation",
 "Properties" : {
 "SubnetId" : String,
 "TransitGatewayAttachmentId" : String,
 "TransitGatewayMulticastDomainId" : String
 }
}

YAML


Type: AWS::EC2::TransitGatewayMulticastDomainAssociation
Properties:
 SubnetId: String
 TransitGatewayAttachmentId: String
 TransitGatewayMulticastDomainId: String

Properties

SubnetId

The IDs of the subnets to associate with the transit gateway multicast domain.

Required: Yes

Type: String

Update requires: Replacement

TransitGatewayAttachmentId

The ID of the transit gateway attachment.

Required: Yes

Type: String

Update requires: Replacement

TransitGatewayMulticastDomainId

The ID of the transit gateway multicast domain.

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 transit gateway multicast domain ID. For example: tgw-mcast-domain-000fb24d04EXAMPLE.

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.

ResourceId: The ID of the resource.
ResourceType: The type of resource, for example a VPC attachment.
State: The state of the resource.