transit_gateway_multicast_group_members

Creates, updates, deletes or gets a transit_gateway_multicast_group_member resource or lists transit_gateway_multicast_group_members in a region

Overview

Name	transit_gateway_multicast_group_members
Type	Resource
Description	The AWS::EC2::TransitGatewayMulticastGroupMember registers and deregisters members and sources (network interfaces) with the transit gateway multicast group
Id	aws.ec2.transit_gateway_multicast_group_members

Fields

Name	Datatype	Description
group_ip_address	string	The IP address assigned to the transit gateway multicast group.
transit_gateway_attachment_id	string	The ID of the transit gateway attachment.
transit_gateway_multicast_domain_id	string	The ID of the transit gateway multicast domain.
subnet_id	string	The ID of the subnet.
resource_id	string	The ID of the resource.
resource_type	string	The type of resource, for example a VPC attachment.
network_interface_id	string	The ID of the transit gateway attachment.
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).
source_type	string	The source type.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	GroupIpAddress, NetworkInterfaceId, TransitGatewayMulticastDomainId, region
delete_resource	DELETE	data__Identifier, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all transit_gateway_multicast_group_members in a region.

SELECT
region,
group_ip_address,
transit_gateway_attachment_id,
transit_gateway_multicast_domain_id,
subnet_id,
resource_id,
resource_type,
network_interface_id,
group_member,
group_source,
member_type,
source_type
FROM aws.ec2.transit_gateway_multicast_group_members
WHERE region = 'us-east-1';

Gets all properties from an individual transit_gateway_multicast_group_member.

SELECT
region,
group_ip_address,
transit_gateway_attachment_id,
transit_gateway_multicast_domain_id,
subnet_id,
resource_id,
resource_type,
network_interface_id,
group_member,
group_source,
member_type,
source_type
FROM aws.ec2.transit_gateway_multicast_group_members
WHERE region = 'us-east-1' AND data__Identifier = '<TransitGatewayMulticastDomainId>|<GroupIpAddress>|<NetworkInterfaceId>';

INSERT example

Use the following StackQL query and manifest file to create a new transit_gateway_multicast_group_member resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.ec2.transit_gateway_multicast_group_members (
 GroupIpAddress,
 TransitGatewayMulticastDomainId,
 NetworkInterfaceId,
 region
)
SELECT 
'{{ GroupIpAddress }}',
 '{{ TransitGatewayMulticastDomainId }}',
 '{{ NetworkInterfaceId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ec2.transit_gateway_multicast_group_members (
 GroupIpAddress,
 TransitGatewayMulticastDomainId,
 NetworkInterfaceId,
 region
)
SELECT 
 '{{ GroupIpAddress }}',
 '{{ TransitGatewayMulticastDomainId }}',
 '{{ NetworkInterfaceId }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: transit_gateway_multicast_group_member
    props:
      - name: GroupIpAddress
        value: '{{ GroupIpAddress }}'
      - name: TransitGatewayMulticastDomainId
        value: '{{ TransitGatewayMulticastDomainId }}'
      - name: NetworkInterfaceId
        value: '{{ NetworkInterfaceId }}'

DELETE example

/*+ delete */
DELETE FROM aws.ec2.transit_gateway_multicast_group_members
WHERE data__Identifier = '<TransitGatewayMulticastDomainId|GroupIpAddress|NetworkInterfaceId>'
AND region = 'us-east-1';

Permissions

To operate on the transit_gateway_multicast_group_members resource, the following permissions are required:

Create

ec2:RegisterTransitGatewayMulticastGroupMembers,
ec2:SearchTransitGatewayMulticastGroups

Read

ec2:SearchTransitGatewayMulticastGroups

Delete

ec2:DeregisterTransitGatewayMulticastGroupMembers,
ec2:SearchTransitGatewayMulticastGroups

List

ec2:SearchTransitGatewayMulticastGroups