EC2 / Client / register_transit_gateway_multicast_group_members

register_transit_gateway_multicast_group_members#

EC2.Client.register_transit_gateway_multicast_group_members(**kwargs)#

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 information about supported instances, see Multicast Consideration in Amazon VPC Transit Gateways.

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

See also: AWS API Documentation

Request Syntax

response = client.register_transit_gateway_multicast_group_members(
    TransitGatewayMulticastDomainId='string',
    GroupIpAddress='string',
    NetworkInterfaceIds=[
        'string',
    ],
    DryRun=True|False
)
Parameters:

  • TransitGatewayMulticastDomainId (string) –

    [REQUIRED]

    The ID of the transit gateway multicast domain.

  • GroupIpAddress (string) – The IP address assigned to the transit gateway multicast group.

  • NetworkInterfaceIds (list) –

    [REQUIRED]

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

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

{
    'RegisteredMulticastGroupMembers': {
        'TransitGatewayMulticastDomainId': 'string',
        'RegisteredNetworkInterfaceIds': [
            'string',
        ],
        'GroupIpAddress': 'string'
    }
}

Response Structure

  • (dict) –

    • RegisteredMulticastGroupMembers (dict) –

      Information about the registered transit gateway multicast group members.

      • TransitGatewayMulticastDomainId (string) –

        The ID of the transit gateway multicast domain.

      • RegisteredNetworkInterfaceIds (list) –

        The ID of the registered network interfaces.

        • (string) –

      • GroupIpAddress (string) –

        The IP address assigned to the transit gateway multicast group.