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::TransitGatewayMulticastDomain

Creates a multicast domain using the specified transit gateway.

The transit gateway must be in the available state before you create a domain.

Syntax

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

JSON


{
 "Type" : "AWS::EC2::TransitGatewayMulticastDomain",
 "Properties" : {
 "Options" : Options ,
 "Tags" : [ Tag, ... ],
 "TransitGatewayId" : String
 }
}

YAML


Type: AWS::EC2::TransitGatewayMulticastDomain
Properties:
 Options: 
 Options 
 Tags: 
 - Tag 
 TransitGatewayId: String

Properties

Options

The options for the transit gateway multicast domain.

AutoAcceptSharedAssociations (enable | disable)
Igmpv2Support (enable | disable)
StaticSourcesSupport (enable | disable)

Required: No

Type: Options

Update requires: No interruption

Tags

The tags for the transit gateway multicast domain.

Required: No

Type: Array of Tag

Update requires: No interruption

TransitGatewayId

The ID of the transit gateway.

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.

CreationTime: The time the multicast domain was created.
State: The state of the multicast domain.
TransitGatewayMulticastDomainArn: The Amazon Resource Name (ARN) of the multicast domain.
TransitGatewayMulticastDomainId: The ID of the multicast domain.