transit_gateway_attachments

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

Overview

Name	transit_gateway_attachments
Type	Resource
Id	aws.ec2.transit_gateway_attachments

Fields

The following fields are returned by SELECT queries:

describe_transit_gateway_attachments

Name	Datatype	Description
association	string	The association.
creation_time	string	The creation time.
resource_id	string	The ID of the resource.
resource_owner_id	string	The ID of the Amazon Web Services account that owns the resource.
resource_type	string	The resource type. Note that the tgw-peering resource type has been deprecated.
state	string	The attachment state. Note that the initiating state has been deprecated.
tags	string	The tags for the attachment.
transit_gateway_attachment_id	string	The ID of the attachment.
transit_gateway_id	string	The ID of the transit gateway.
transit_gateway_owner_id	string	The ID of the Amazon Web Services account that owns the transit gateway.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_transit_gateway_attachments	select	region	TransitGatewayAttachmentIds, Filter, MaxResults, NextToken, DryRun	Describes one or more attachments between resources and transit gateways. By default, all attachments are described. Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.

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
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: association.state - The state of the association (associating | associated | disassociating). association.transit-gateway-route-table-id - The ID of the route table for the transit gateway. resource-id - The ID of the resource. resource-owner-id - The ID of the Amazon Web Services account that owns the resource. resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect. state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting. transit-gateway-attachment-id - The ID of the attachment. transit-gateway-id - The ID of the transit gateway. transit-gateway-owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
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.
TransitGatewayAttachmentIds	array	The IDs of the attachments.

SELECT examples

describe_transit_gateway_attachments

Describes one or more attachments between resources and transit gateways. By default, all attachments are described. Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.

SELECT
association,
creation_time,
resource_id,
resource_owner_id,
resource_type,
state,
tags,
transit_gateway_attachment_id,
transit_gateway_id,
transit_gateway_owner_id
FROM aws.ec2.transit_gateway_attachments
WHERE region = '{{ region }}' -- required
AND TransitGatewayAttachmentIds = '{{ TransitGatewayAttachmentIds }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND DryRun = '{{ DryRun }}'
;