transit_gateway_multicast_domains

Creates, updates, deletes or gets a transit_gateway_multicast_domain resource or lists transit_gateway_multicast_domains in a region

Overview

Name	transit_gateway_multicast_domains
Type	Resource
Description	The AWS::EC2::TransitGatewayMulticastDomain type
Id	aws.ec2.transit_gateway_multicast_domains

Fields

Name	Datatype	Description
transit_gateway_multicast_domain_id	string	The ID of the transit gateway multicast domain.
transit_gateway_multicast_domain_arn	string	The Amazon Resource Name (ARN) of the transit gateway multicast domain.
transit_gateway_id	string	The ID of the transit gateway.
state	string	The state of the transit gateway multicast domain.
creation_time	string	The time the transit gateway multicast domain was created.
tags	array	The tags for the transit gateway multicast domain.
options	object	The options for the transit gateway multicast domain.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	TransitGatewayId, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all transit_gateway_multicast_domains in a region.

SELECT
region,
transit_gateway_multicast_domain_id,
transit_gateway_multicast_domain_arn,
transit_gateway_id,
state,
creation_time,
tags,
options
FROM aws.ec2.transit_gateway_multicast_domains
WHERE region = 'us-east-1';

Gets all properties from an individual transit_gateway_multicast_domain.

SELECT
region,
transit_gateway_multicast_domain_id,
transit_gateway_multicast_domain_arn,
transit_gateway_id,
state,
creation_time,
tags,
options
FROM aws.ec2.transit_gateway_multicast_domains
WHERE region = 'us-east-1' AND data__Identifier = '<TransitGatewayMulticastDomainId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.ec2.transit_gateway_multicast_domains (
 TransitGatewayId,
 region
)
SELECT 
'{{ TransitGatewayId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ec2.transit_gateway_multicast_domains (
 TransitGatewayId,
 Tags,
 Options,
 region
)
SELECT 
 '{{ TransitGatewayId }}',
 '{{ Tags }}',
 '{{ Options }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: transit_gateway_multicast_domain
    props:
      - name: TransitGatewayId
        value: '{{ TransitGatewayId }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: Options
        value:
          AutoAcceptSharedAssociations: '{{ AutoAcceptSharedAssociations }}'
          Igmpv2Support: '{{ Igmpv2Support }}'
          StaticSourcesSupport: '{{ StaticSourcesSupport }}'

DELETE example

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

Permissions

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

Create

ec2:DescribeTransitGatewayMulticastDomains,
ec2:CreateTransitGatewayMulticastDomain,
ec2:CreateTags

Read

ec2:DescribeTransitGatewayMulticastDomains

Update

ec2:DescribeTransitGatewayMulticastDomains,
ec2:DeleteTags,
ec2:CreateTags

Delete

ec2:DescribeTransitGatewayMulticastDomains,
ec2:DeleteTransitGatewayMulticastDomain,
ec2:DeleteTags

List

ec2:DescribeTransitGatewayMulticastDomains