EC2 / Client / register_transit_gateway_multicast_group_sources

register_transit_gateway_multicast_group_sources#

EC2.Client.register_transit_gateway_multicast_group_sources(**kwargs)#

Registers sources (network interfaces) with the specified transit gateway multicast group.

A multicast source is a network interface attached to a supported instance that sends multicast traffic. For information about supported instances, see Multicast Considerations in Amazon VPC Transit Gateways.

After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast group.

See also: AWS API Documentation

Request Syntax

response = client.register_transit_gateway_multicast_group_sources(
    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 sources’ 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

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

Response Structure

  • (dict) –

    • RegisteredMulticastGroupSources (dict) –

      Information about the transit gateway multicast group sources.

      • TransitGatewayMulticastDomainId (string) –

        The ID of the transit gateway multicast domain.

      • RegisteredNetworkInterfaceIds (list) –

        The IDs of the network interfaces members registered with the transit gateway multicast group.

        • (string) –

      • GroupIpAddress (string) –

        The IP address assigned to the transit gateway multicast group.