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

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
transit_gateway_multicast_domain_id	string	The ID of the transit gateway multicast domain.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	transit_gateway_multicast_domains	INSERT	TransitGatewayId, region
delete_resource	transit_gateway_multicast_domains	DELETE	Identifier, region
update_resource	transit_gateway_multicast_domains	UPDATE	Identifier, PatchDocument, region
list_resources	transit_gateway_multicast_domains_list_only	SELECT	region
get_resource	transit_gateway_multicast_domains	SELECT	Identifier, region

SELECT examples

get (all properties)

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

list (identifiers only)

Lists all transit_gateway_multicast_domains in a region.

SELECT
  region,
  transit_gateway_multicast_domain_id
FROM awscc.ec2.transit_gateway_multicast_domains_list_only
WHERE
  region = '{{ region }}';

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 awscc.ec2.transit_gateway_multicast_domains (
  TransitGatewayId,
  region
)
SELECT
  '{{ transit_gateway_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ec2.transit_gateway_multicast_domains (
  TransitGatewayId,
  Tags,
  Options,
  region
)
SELECT
  '{{ transit_gateway_id }}',
  '{{ tags }}',
  '{{ options }}',
  '{{ 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_domain
  props:
    - name: transit_gateway_id
      value: '{{ transit_gateway_id }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: options
      value:
        auto_accept_shared_associations: '{{ auto_accept_shared_associations }}'
        igmpv2_support: '{{ igmpv2_support }}'
        static_sources_support: '{{ static_sources_support }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ec2.transit_gateway_multicast_domains
SET PatchDocument = string('{{ {
    "Tags": tags,
    "Options": options
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ transit_gateway_multicast_domain_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.transit_gateway_multicast_domains
WHERE
  Identifier = '{{ transit_gateway_multicast_domain_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_domains resource, the following permissions are required:

Create

ec2:DescribeTransitGatewayMulticastDomains,
ec2:CreateTransitGatewayMulticastDomain,
ec2:CreateTags,
ec2:DescribeTags

Read

ec2:DescribeTransitGatewayMulticastDomains,
ec2:DescribeTags

Update

ec2:DescribeTransitGatewayMulticastDomains,
ec2:DeleteTags,
ec2:CreateTags,
ec2:DescribeTags

Delete

ec2:DescribeTransitGatewayMulticastDomains,
ec2:DeleteTransitGatewayMulticastDomain,
ec2:DeleteTags,
ec2:DescribeTags

List

ec2:DescribeTransitGatewayMulticastDomains,
ec2:DescribeTags