transit_gateway_multicast_domain_associations

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

Overview

Name	transit_gateway_multicast_domain_associations
Type	Resource
Id	aws.ec2.transit_gateway_multicast_domain_associations

Fields

The following fields are returned by SELECT queries:

get_transit_gateway_multicast_domain_associations

Name	Datatype	Description
resource_id	string	The ID of the resource.
resource_owner_id	string	The ID of the Amazon Web Services account that owns the transit gateway multicast domain association resource.
resource_type	string	The type of resource, for example a VPC attachment.
subnet	string	The subnet associated with the transit gateway multicast domain.
transit_gateway_attachment_id	string	The ID of the transit gateway attachment.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_transit_gateway_multicast_domain_associations	select	TransitGatewayMulticastDomainId, region	Filter, MaxResults, NextToken, DryRun	Gets information about the associations for the transit gateway multicast domain.
accept_transit_gateway_multicast_domain_associations	exec	region	TransitGatewayMulticastDomainId, TransitGatewayAttachmentId, SubnetIds, DryRun	Accepts a request to associate subnets with a transit gateway multicast domain.
reject_transit_gateway_multicast_domain_associations	exec	region	TransitGatewayMulticastDomainId, TransitGatewayAttachmentId, SubnetIds, DryRun	Rejects a request to associate cross-account subnets with a 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
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: resource-id - The ID of the resource. resource-type - The type of resource. The valid value is: vpc. state - The state of the subnet association. Valid values are associated | associating | disassociated | disassociating. subnet-id - The ID of the subnet. transit-gateway-attachment-id - The id of the transit gateway attachment.
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.
SubnetIds	array	The IDs of the subnets to associate with the transit gateway multicast domain.
TransitGatewayAttachmentId	string	The ID of the transit gateway attachment.
TransitGatewayMulticastDomainId	string	The ID of the transit gateway multicast domain.

SELECT examples

get_transit_gateway_multicast_domain_associations

Gets information about the associations for the transit gateway multicast domain.

SELECT
resource_id,
resource_owner_id,
resource_type,
subnet,
transit_gateway_attachment_id
FROM aws.ec2.transit_gateway_multicast_domain_associations
WHERE TransitGatewayMulticastDomainId = '{{ TransitGatewayMulticastDomainId }}' -- required
AND region = '{{ region }}' -- required
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND DryRun = '{{ DryRun }}'
;

Lifecycle Methods

accept_transit_gateway_multicast_domain_associations

Accepts a request to associate subnets with a transit gateway multicast domain.

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

reject_transit_gateway_multicast_domain_associations

Rejects a request to associate cross-account subnets with a transit gateway multicast domain.

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