[ aws . ec2 ]

associate-transit-gateway-multicast-domain

Description

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. Use DescribeTransitGatewayAttachments to see the state of the attachment.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  associate-transit-gateway-multicast-domain
[--transit-gateway-multicast-domain-id <value>]
[--transit-gateway-attachment-id <value>]
[--subnet-ids <value>]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--transit-gateway-multicast-domain-id (string)

The ID of the transit gateway multicast domain.

--transit-gateway-attachment-id (string)

The ID of the transit gateway attachment to associate with the transit gateway multicast domain.

--subnet-ids (list)

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

(string)

Syntax:

"string" "string" ...

--dry-run | --no-dry-run (boolean)

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To associate a transit gateway with a multicast domain

This example returns the route table propagations for the specified route table.

aws ec2 associate-transit-gateway-multicast-domain \
    --transit-gateway-multicast-domain-id tgw-mcast-domain-0c4905cef79d6e597 \
    --transit-gateway-attachment-id tgw-attach-028c1dd0f8f5cbe8e \
    --subnet-id subnet-000de86e3b49c932a \
    --transit-gateway-multicast-domain-id tgw-mcast-domain-0c4905cef7EXAMPLE

Output:

{
    "Associations": {
        "TransitGatewayMulticastDomainId": "tgw-mcast-domain-0c4905cef79d6e597",
        "TransitGatewayAttachmentId": "tgw-attach-028c1dd0f8f5cbe8e",
        "ResourceId": "vpc-01128d2c240c09bd5",
        "ResourceType": "vpc",
        "Subnets": [
            {
                "SubnetId": "subnet-000de86e3b49c932a",
                "State": "associating"
            }
        ]
    }
}

For more information, see ‘Associate VPC Attachments and Subnets with a Transit Gateway Multicast Domain <https://docs.aws.amazon.com/vpc/latest/tgw/working-with-multicast.html#associate-attachment-to-domain>’__ in the AWS Transit Gateways User Guide.

Output

Associations -> (structure)

Information about the transit gateway multicast domain associations.

TransitGatewayMulticastDomainId -> (string)

The ID of the transit gateway multicast domain.

TransitGatewayAttachmentId -> (string)

The ID of the transit gateway attachment.

ResourceId -> (string)

The ID of the resource.

ResourceType -> (string)

The type of resource, for example a VPC attachment.

ResourceOwnerId -> (string)

The ID of the AWS account that owns the resource.

Subnets -> (list)

The subnets associated with the multicast domain.

(structure)

Describes the subnet association with the transit gateway multicast domain.

SubnetId -> (string)

The ID of the subnet.

State -> (string)

The state of the subnet association.