Skip to content

associate_transit_gateway_multicast_domain

Operation

associate_transit_gateway_multicast_domain

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.

Parameters:

Name Type Description Default
request AssociateTransitGatewayMulticastDomainInput | AssociateTransitGatewayMulticastDomainInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[AssociateTransitGatewayMulticastDomainInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
AssociateTransitGatewayMulticastDomainOutput

An instance of AssociateTransitGatewayMulticastDomainOutput.

associate_transit_gateway_multicast_domain async

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.

Parameters:

Name Type Description Default
request AssociateTransitGatewayMulticastDomainInput | AssociateTransitGatewayMulticastDomainInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[AssociateTransitGatewayMulticastDomainInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
AssociateTransitGatewayMulticastDomainOutput

An instance of AssociateTransitGatewayMulticastDomainOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

AssociateTransitGatewayMulticastDomainInputDict

Bases: TypedDict

Dictionary form of AssociateTransitGatewayMulticastDomainInput.

Attributes

dry_run instance-attribute
dry_run: bool | None

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.

subnet_ids instance-attribute
subnet_ids: Required[Sequence[str]]

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

transit_gateway_attachment_id instance-attribute
transit_gateway_attachment_id: Required[str]

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

transit_gateway_multicast_domain_id instance-attribute
transit_gateway_multicast_domain_id: Required[str]

The ID of the transit gateway multicast domain.

AssociateTransitGatewayMulticastDomainInput dataclass

Bases: _SerdeShape

Dataclass for AssociateTransitGatewayMulticastDomainInput structure.

Attributes

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

subnet_ids class-attribute instance-attribute
subnet_ids: list[str] | None = ...

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

transit_gateway_attachment_id class-attribute instance-attribute
transit_gateway_attachment_id: str | None = ...

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

transit_gateway_multicast_domain_id class-attribute instance-attribute
transit_gateway_multicast_domain_id: str | None = ...

The ID of the transit gateway multicast domain.

Output

AssociateTransitGatewayMulticastDomainOutput dataclass

Bases: _SerdeShape

Dataclass for AssociateTransitGatewayMulticastDomainOutput structure.

Attributes

associations class-attribute instance-attribute
associations: TransitGatewayMulticastDomainAssociations | None = ...

Information about the transit gateway multicast domain associations.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.