Skip to content

register_transit_gateway_multicast_group_members

Operation

register_transit_gateway_multicast_group_members

Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated with a supported EC2 instance that receives multicast traffic. For more information, see Multicast on transit gateways in the Amazon Web Services Transit Gateways Guide.

After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added to the transit gateway multicast group.

Parameters:

Name Type Description Default
request RegisterTransitGatewayMulticastGroupMembersInput | RegisterTransitGatewayMulticastGroupMembersInputDict | 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[RegisterTransitGatewayMulticastGroupMembersInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
RegisterTransitGatewayMulticastGroupMembersOutput

An instance of RegisterTransitGatewayMulticastGroupMembersOutput.

register_transit_gateway_multicast_group_members async

Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated with a supported EC2 instance that receives multicast traffic. For more information, see Multicast on transit gateways in the Amazon Web Services Transit Gateways Guide.

After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added to the transit gateway multicast group.

Parameters:

Name Type Description Default
request RegisterTransitGatewayMulticastGroupMembersInput | RegisterTransitGatewayMulticastGroupMembersInputDict | 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[RegisterTransitGatewayMulticastGroupMembersInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
RegisterTransitGatewayMulticastGroupMembersOutput

An instance of RegisterTransitGatewayMulticastGroupMembersOutput.

Input

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

RegisterTransitGatewayMulticastGroupMembersInputDict

Bases: TypedDict

Dictionary form of RegisterTransitGatewayMulticastGroupMembersInput.

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.

group_ip_address instance-attribute
group_ip_address: str | None

The IP address assigned to the transit gateway multicast group.

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

The group members' network interface IDs to register with the transit gateway multicast group.

transit_gateway_multicast_domain_id instance-attribute
transit_gateway_multicast_domain_id: Required[str]

The ID of the transit gateway multicast domain.

RegisterTransitGatewayMulticastGroupMembersInput dataclass

Bases: _SerdeShape

Dataclass for RegisterTransitGatewayMulticastGroupMembersInput 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.

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

The IP address assigned to the transit gateway multicast group.

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

The group members' network interface IDs to register with the transit gateway multicast group.

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

RegisterTransitGatewayMulticastGroupMembersOutput dataclass

Bases: _SerdeShape

Dataclass for RegisterTransitGatewayMulticastGroupMembersOutput structure.

Attributes

registered_multicast_group_members class-attribute instance-attribute
registered_multicast_group_members: TransitGatewayMulticastRegisteredGroupMembers | None = ...

Information about the registered transit gateway multicast group members.

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.