transit_gateway_multicast_groups

Creates, updates, deletes, gets or lists a transit_gateway_multicast_groups resource.

Overview

Name	transit_gateway_multicast_groups
Type	Resource
Id	aws.ec2.transit_gateway_multicast_groups

Fields

The following fields are returned by SELECT queries:

search_transit_gateway_multicast_groups

Name	Datatype	Description
group_ip_address	string	The IP address assigned to the transit gateway multicast group.
group_member	boolean	Indicates that the resource is a transit gateway multicast group member.
group_source	boolean	Indicates that the resource is a transit gateway multicast group member.
member_type	string	The member type (for example, static).
network_interface_id	string	The ID of the transit gateway attachment.
resource_id	string	The ID of the resource.
resource_owner_id	string	The ID of the Amazon Web Services account that owns the transit gateway multicast domain group resource.
resource_type	string	The type of resource, for example a VPC attachment.
source_type	string	The source type.
subnet_id	string	The ID of the subnet.
transit_gateway_attachment_id	string	The ID of the transit gateway attachment.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
search_transit_gateway_multicast_groups	select	TransitGatewayMulticastDomainId, region	Filter, MaxResults, NextToken, DryRun	Searches one or more transit gateway multicast groups and returns the group membership information.
register_transit_gateway_multicast_group_members	insert	TransitGatewayMulticastDomainId, NetworkInterfaceIds, region	GroupIpAddress, DryRun	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.
deregister_transit_gateway_multicast_group_members	delete	region	TransitGatewayMulticastDomainId, GroupIpAddress, NetworkInterfaceIds, DryRun	Deregisters the specified members (network interfaces) from the transit gateway multicast group.
deregister_transit_gateway_multicast_group_sources	exec	region	TransitGatewayMulticastDomainId, GroupIpAddress, NetworkInterfaceIds, DryRun	Deregisters the specified sources (network interfaces) from the transit gateway multicast group.
register_transit_gateway_multicast_group_sources	exec	TransitGatewayMulticastDomainId, NetworkInterfaceIds, region	GroupIpAddress, DryRun	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 more information about supported instances, see Multicast on transit gateways in the Amazon Web Services Transit Gateways Guide. After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast group.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
NetworkInterfaceIds	array	The group sources' network interface IDs to register with the transit gateway multicast group.
TransitGatewayMulticastDomainId	string	The ID of the transit gateway multicast domain.
region	string	AWS region (default: us-east-1)
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.
Filter	array	One or more filters. The possible values are: group-ip-address - The IP address of the transit gateway multicast group. is-group-member - The resource is a group member. Valid values are true | false. is-group-source - The resource is a group source. Valid values are true | false. member-type - The member type. Valid values are igmp | static. resource-id - The ID of the resource. resource-type - The type of resource. Valid values are vpc | vpn | direct-connect-gateway | tgw-peering. source-type - The source type. Valid values are igmp | static. subnet-id - The ID of the subnet. transit-gateway-attachment-id - The id of the transit gateway attachment.
GroupIpAddress	string	The IP address assigned to the transit gateway multicast group.
MaxResults	integer	The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
NetworkInterfaceIds	array	The IDs of the group sources' network interfaces.
NextToken	string	The token for the next page of results.
TransitGatewayMulticastDomainId	string	The ID of the transit gateway multicast domain.

SELECT examples

search_transit_gateway_multicast_groups

Searches one or more transit gateway multicast groups and returns the group membership information.

SELECT
group_ip_address,
group_member,
group_source,
member_type,
network_interface_id,
resource_id,
resource_owner_id,
resource_type,
source_type,
subnet_id,
transit_gateway_attachment_id
FROM aws.ec2.transit_gateway_multicast_groups
WHERE TransitGatewayMulticastDomainId = '{{ TransitGatewayMulticastDomainId }}' -- required
AND region = '{{ region }}' -- required
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND DryRun = '{{ DryRun }}'
;

INSERT examples

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.

INSERT INTO aws.ec2.transit_gateway_multicast_groups (
TransitGatewayMulticastDomainId,
NetworkInterfaceIds,
region,
GroupIpAddress,
DryRun
)
SELECT 
'{{ TransitGatewayMulticastDomainId }}',
'{{ NetworkInterfaceIds }}',
'{{ region }}',
'{{ GroupIpAddress }}',
'{{ DryRun }}'
RETURNING
group_ip_address,
registered_network_interface_ids,
transit_gateway_multicast_domain_id
;

Manifest

# Description fields are for documentation purposes
- name: transit_gateway_multicast_groups
props:
  - name: TransitGatewayMulticastDomainId
    value: "{{ TransitGatewayMulticastDomainId }}"
    description: Required parameter for the transit_gateway_multicast_groups resource.
  - name: NetworkInterfaceIds
    value: "{{ NetworkInterfaceIds }}"
    description: Required parameter for the transit_gateway_multicast_groups resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the transit_gateway_multicast_groups resource.
  - name: GroupIpAddress
    value: "{{ GroupIpAddress }}"
    description: The IP address assigned to the transit gateway multicast group.
    description: The IP address assigned to the transit gateway multicast group.
  - name: DryRun
    value: {{ DryRun }}
    description: 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.
    description: 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.

DELETE examples

deregister_transit_gateway_multicast_group_members

Deregisters the specified members (network interfaces) from the transit gateway multicast group.

DELETE FROM aws.ec2.transit_gateway_multicast_groups
WHERE region = '{{ region }}' --required
AND TransitGatewayMulticastDomainId = '{{ TransitGatewayMulticastDomainId }}'
AND GroupIpAddress = '{{ GroupIpAddress }}'
AND NetworkInterfaceIds = '{{ NetworkInterfaceIds }}'
AND DryRun = '{{ DryRun }}'
;

Lifecycle Methods

deregister_transit_gateway_multicast_group_sources

Deregisters the specified sources (network interfaces) from the transit gateway multicast group.

EXEC aws.ec2.transit_gateway_multicast_groups.deregister_transit_gateway_multicast_group_sources 
@region='{{ region }}' --required, 
@TransitGatewayMulticastDomainId='{{ TransitGatewayMulticastDomainId }}', 
@GroupIpAddress='{{ GroupIpAddress }}', 
@NetworkInterfaceIds='{{ NetworkInterfaceIds }}', 
@DryRun={{ DryRun }}
;

register_transit_gateway_multicast_group_sources

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 more information about supported instances, see Multicast on transit gateways in the Amazon Web Services Transit Gateways Guide. After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast group.

EXEC aws.ec2.transit_gateway_multicast_groups.register_transit_gateway_multicast_group_sources 
@TransitGatewayMulticastDomainId='{{ TransitGatewayMulticastDomainId }}' --required, 
@NetworkInterfaceIds='{{ NetworkInterfaceIds }}' --required, 
@region='{{ region }}' --required, 
@GroupIpAddress='{{ GroupIpAddress }}', 
@DryRun={{ DryRun }}
;