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	awscc.ec2.transit_gateway_multicast_group_members

Fields

get (all properties)

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).
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
group_ip_address	string	The IP address assigned to the transit gateway multicast group.
transit_gateway_multicast_domain_id	string	The ID of the transit gateway multicast domain.
network_interface_id	string	The ID of the transit gateway attachment.
region	string	AWS region.

For more information, see AWS::EC2::TransitGatewayMulticastGroupMember.

Methods

Name	Resource	Accessible by	Required Params
create_resource	transit_gateway_multicast_group_members	INSERT	GroupIpAddress, NetworkInterfaceId, TransitGatewayMulticastDomainId, region
delete_resource	transit_gateway_multicast_group_members	DELETE	Identifier, region
list_resources	transit_gateway_multicast_group_members_list_only	SELECT	region
get_resource	transit_gateway_multicast_group_members	SELECT	Identifier, region

SELECT examples

get (all properties)

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
FROM awscc.ec2.transit_gateway_multicast_group_members
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ transit_gateway_multicast_domain_id }}|{{ group_ip_address }}|{{ network_interface_id }}';

list (identifiers only)

Lists all transit_gateway_multicast_group_members in a region.

SELECT
  region,
  transit_gateway_multicast_domain_id,
  group_ip_address,
  network_interface_id
FROM awscc.ec2.transit_gateway_multicast_group_members_list_only
WHERE
  region = '{{ region }}';

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 awscc.ec2.transit_gateway_multicast_group_members (
  GroupIpAddress,
  TransitGatewayMulticastDomainId,
  NetworkInterfaceId,
  region
)
SELECT
  '{{ group_ip_address }}',
  '{{ transit_gateway_multicast_domain_id }}',
  '{{ network_interface_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ec2.transit_gateway_multicast_group_members (
  GroupIpAddress,
  TransitGatewayMulticastDomainId,
  NetworkInterfaceId,
  region
)
SELECT
  '{{ group_ip_address }}',
  '{{ transit_gateway_multicast_domain_id }}',
  '{{ network_interface_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: group_ip_address
      value: '{{ group_ip_address }}'
    - name: transit_gateway_multicast_domain_id
      value: '{{ transit_gateway_multicast_domain_id }}'
    - name: network_interface_id
      value: '{{ network_interface_id }}'

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.transit_gateway_multicast_group_members
WHERE
  Identifier = '{{ transit_gateway_multicast_domain_id }}|{{ group_ip_address }}|{{ network_interface_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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