transit_gateway_multicast_domain_associations

Creates, updates, deletes or gets a transit_gateway_multicast_domain_association resource or lists transit_gateway_multicast_domain_associations in a region

Overview

Name	transit_gateway_multicast_domain_associations
Type	Resource
Description	The AWS::EC2::TransitGatewayMulticastDomainAssociation type
Id	awscc.ec2.transit_gateway_multicast_domain_associations

Fields

get (all properties)

Name	Datatype	Description
transit_gateway_multicast_domain_id	string	The ID of the transit gateway multicast domain.
transit_gateway_attachment_id	string	The ID of the transit gateway attachment.
resource_id	string	The ID of the resource.
resource_type	string	The type of resource, for example a VPC attachment.
state	string	The state of the subnet association.
subnet_id	string	The IDs of the subnets to associate with 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.
transit_gateway_attachment_id	string	The ID of the transit gateway attachment.
subnet_id	string	The IDs of the subnets to associate with the transit gateway multicast domain.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	transit_gateway_multicast_domain_associations	INSERT	TransitGatewayMulticastDomainId, TransitGatewayAttachmentId, SubnetId, region
delete_resource	transit_gateway_multicast_domain_associations	DELETE	Identifier, region
list_resources	transit_gateway_multicast_domain_associations_list_only	SELECT	region
get_resource	transit_gateway_multicast_domain_associations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual transit_gateway_multicast_domain_association.

SELECT
  region,
  transit_gateway_multicast_domain_id,
  transit_gateway_attachment_id,
  resource_id,
  resource_type,
  state,
  subnet_id
FROM awscc.ec2.transit_gateway_multicast_domain_associations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ transit_gateway_multicast_domain_id }}|{{ transit_gateway_attachment_id }}|{{ subnet_id }}';

list (identifiers only)

Lists all transit_gateway_multicast_domain_associations in a region.

SELECT
  region,
  transit_gateway_multicast_domain_id,
  transit_gateway_attachment_id,
  subnet_id
FROM awscc.ec2.transit_gateway_multicast_domain_associations_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ec2.transit_gateway_multicast_domain_associations (
  TransitGatewayMulticastDomainId,
  TransitGatewayAttachmentId,
  SubnetId,
  region
)
SELECT
  '{{ transit_gateway_multicast_domain_id }}',
  '{{ transit_gateway_attachment_id }}',
  '{{ subnet_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ec2.transit_gateway_multicast_domain_associations (
  TransitGatewayMulticastDomainId,
  TransitGatewayAttachmentId,
  SubnetId,
  region
)
SELECT
  '{{ transit_gateway_multicast_domain_id }}',
  '{{ transit_gateway_attachment_id }}',
  '{{ subnet_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_domain_association
  props:
    - name: transit_gateway_multicast_domain_id
      value: '{{ transit_gateway_multicast_domain_id }}'
    - name: transit_gateway_attachment_id
      value: '{{ transit_gateway_attachment_id }}'
    - name: subnet_id
      value: '{{ subnet_id }}'

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.transit_gateway_multicast_domain_associations
WHERE
  Identifier = '{{ transit_gateway_multicast_domain_id }}|{{ transit_gateway_attachment_id }}|{{ subnet_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_domain_associations resource, the following permissions are required:

Create

ec2:AssociateTransitGatewayMulticastDomain,
ec2:GetTransitGatewayMulticastDomainAssociations

Read

ec2:GetTransitGatewayMulticastDomainAssociations

Delete

ec2:DisassociateTransitGatewayMulticastDomain,
ec2:GetTransitGatewayMulticastDomainAssociations

List

ec2:GetTransitGatewayMulticastDomainAssociations