transit_gateway_multicast_domains

Creates, updates, deletes, gets or lists a transit_gateway_multicast_domains resource.

Overview

Name	transit_gateway_multicast_domains
Type	Resource
Id	aws.ec2.transit_gateway_multicast_domains

Fields

The following fields are returned by SELECT queries:

describe_transit_gateway_multicast_domains

Name	Datatype	Description
creation_time	string	The time the transit gateway multicast domain was created.
options	string	The options for the transit gateway multicast domain.
owner_id	string	The ID of the Amazon Web Services account that owns the transit gateway multicast domain.
state	string	The state of the transit gateway multicast domain.
tags	string	The tags for the transit gateway multicast domain.
transit_gateway_id	string	The ID of the transit gateway.
transit_gateway_multicast_domain_arn	string	The Amazon Resource Name (ARN) of the transit gateway multicast domain.
transit_gateway_multicast_domain_id	string	The ID of the transit gateway multicast domain.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_transit_gateway_multicast_domains	select	region	TransitGatewayMulticastDomainIds, Filter, MaxResults, NextToken, DryRun	Describes one or more transit gateway multicast domains.
create_transit_gateway_multicast_domain	insert	TransitGatewayId, region	Options, TagSpecification, DryRun	Creates a multicast domain using the specified transit gateway. The transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway.
associate_transit_gateway_multicast_domain	update	TransitGatewayMulticastDomainId, TransitGatewayAttachmentId, SubnetIds, region	DryRun	Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain. The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments to see the state of the attachment.
delete_transit_gateway_multicast_domain	delete	TransitGatewayMulticastDomainId, region	DryRun	Deletes the specified transit gateway multicast domain.
disassociate_transit_gateway_multicast_domain	exec	TransitGatewayMulticastDomainId, TransitGatewayAttachmentId, SubnetIds, region	DryRun	Disassociates the specified subnets from the transit gateway multicast domain.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
SubnetIds	array	The IDs of the subnets;
TransitGatewayAttachmentId	string	The ID of the attachment.
TransitGatewayId	string	The ID of the transit gateway.
TransitGatewayMulticastDomainId	string	The ID of the transit gateway multicast domain.
region	string	AWS region (default: us-east-1)
DryRun	boolean	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Filter	array	One or more filters. The possible values are: state - The state of the transit gateway multicast domain. Valid values are pending | available | deleting | deleted. transit-gateway-id - The ID of the transit gateway. transit-gateway-multicast-domain-id - The ID of the transit gateway multicast domain.
MaxResults	integer	The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
NextToken	string	The token for the next page of results.
Options	object	The options for the transit gateway multicast domain.
TagSpecification	array	The tags for the transit gateway multicast domain.
TransitGatewayMulticastDomainIds	array	The ID of the transit gateway multicast domain.

SELECT examples

describe_transit_gateway_multicast_domains

Describes one or more transit gateway multicast domains.

SELECT
creation_time,
options,
owner_id,
state,
tags,
transit_gateway_id,
transit_gateway_multicast_domain_arn,
transit_gateway_multicast_domain_id
FROM aws.ec2.transit_gateway_multicast_domains
WHERE region = '{{ region }}' -- required
AND TransitGatewayMulticastDomainIds = '{{ TransitGatewayMulticastDomainIds }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND DryRun = '{{ DryRun }}'
;

INSERT examples

create_transit_gateway_multicast_domain

Creates a multicast domain using the specified transit gateway. The transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway.

INSERT INTO aws.ec2.transit_gateway_multicast_domains (
TransitGatewayId,
region,
Options,
TagSpecification,
DryRun
)
SELECT 
'{{ TransitGatewayId }}',
'{{ region }}',
'{{ Options }}',
'{{ TagSpecification }}',
'{{ DryRun }}'
RETURNING
creation_time,
options,
owner_id,
state,
tags,
transit_gateway_id,
transit_gateway_multicast_domain_arn,
transit_gateway_multicast_domain_id
;

Manifest

# Description fields are for documentation purposes
- name: transit_gateway_multicast_domains
props:
  - name: TransitGatewayId
    value: "{{ TransitGatewayId }}"
    description: Required parameter for the transit_gateway_multicast_domains resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the transit_gateway_multicast_domains resource.
  - name: Options
    value: "{{ Options }}"
    description: The options for the transit gateway multicast domain.
    description: The options for the transit gateway multicast domain.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: The tags for the transit gateway multicast domain.
    description: The tags for the transit gateway multicast domain.
  - name: DryRun
    value: {{ DryRun }}
    description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
    description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

UPDATE examples

associate_transit_gateway_multicast_domain

Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain. The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments to see the state of the attachment.

UPDATE aws.ec2.transit_gateway_multicast_domains
SET 
-- No updatable properties
WHERE 
TransitGatewayMulticastDomainId = '{{ TransitGatewayMulticastDomainId }}' --required
AND TransitGatewayAttachmentId = '{{ TransitGatewayAttachmentId }}' --required
AND SubnetIds = '{{ SubnetIds }}' --required
AND region = '{{ region }}' --required
AND DryRun = {{ DryRun}}
RETURNING
resource_id,
resource_owner_id,
resource_type,
subnets,
transit_gateway_attachment_id,
transit_gateway_multicast_domain_id;

DELETE examples

delete_transit_gateway_multicast_domain

Deletes the specified transit gateway multicast domain.

DELETE FROM aws.ec2.transit_gateway_multicast_domains
WHERE TransitGatewayMulticastDomainId = '{{ TransitGatewayMulticastDomainId }}' --required
AND region = '{{ region }}' --required
AND DryRun = '{{ DryRun }}'
;

Lifecycle Methods

disassociate_transit_gateway_multicast_domain

Disassociates the specified subnets from the transit gateway multicast domain.

EXEC aws.ec2.transit_gateway_multicast_domains.disassociate_transit_gateway_multicast_domain 
@TransitGatewayMulticastDomainId='{{ TransitGatewayMulticastDomainId }}' --required, 
@TransitGatewayAttachmentId='{{ TransitGatewayAttachmentId }}' --required, 
@SubnetIds='{{ SubnetIds }}' --required, 
@region='{{ region }}' --required, 
@DryRun={{ DryRun }}
;