EC2 / Client / associate_transit_gateway_multicast_domain

associate_transit_gateway_multicast_domain#

EC2.Client.associate_transit_gateway_multicast_domain(**kwargs)#

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

Request Syntax

response = client.associate_transit_gateway_multicast_domain(
    TransitGatewayMulticastDomainId='string',
    TransitGatewayAttachmentId='string',
    SubnetIds=[
        'string',
    ],
    DryRun=True|False
)
Parameters:

  • TransitGatewayMulticastDomainId (string) –

    [REQUIRED]

    The ID of the transit gateway multicast domain.

  • TransitGatewayAttachmentId (string) –

    [REQUIRED]

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

  • SubnetIds (list) –

    [REQUIRED]

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

    • (string) –

  • DryRun (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.

Return type:

dict

Returns:

Response Syntax

{
    'Associations': {
        'TransitGatewayMulticastDomainId': 'string',
        'TransitGatewayAttachmentId': 'string',
        'ResourceId': 'string',
        'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering',
        'ResourceOwnerId': 'string',
        'Subnets': [
            {
                'SubnetId': 'string',
                'State': 'pendingAcceptance'|'associating'|'associated'|'disassociating'|'disassociated'|'rejected'|'failed'
            },
        ]
    }
}

Response Structure

  • (dict) –

    • Associations (dict) –

      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 Amazon Web Services account that owns the resource.

      • Subnets (list) –

        The subnets associated with the multicast domain.

        • (dict) –

          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.