transit_gateway_connects

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

Overview

Name	transit_gateway_connects
Type	Resource
Id	aws.ec2.transit_gateway_connects

Fields

The following fields are returned by SELECT queries:

describe_transit_gateway_connects

Name	Datatype	Description
creation_time	string	The creation time.
options	string	The Connect attachment options.
state	string	The state of the attachment.
tags	string	The tags for the attachment.
transit_gateway_attachment_id	string	The ID of the Connect attachment.
transit_gateway_id	string	The ID of the transit gateway.
transport_transit_gateway_attachment_id	string	The ID of the attachment from which the Connect attachment was created.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_transit_gateway_connects	select	region	TransitGatewayAttachmentIds, Filter, MaxResults, NextToken, DryRun	Describes one or more Connect attachments.
create_transit_gateway_connect	insert	TransportTransitGatewayAttachmentId, region	Options, TagSpecification, DryRun	Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance. A Connect attachment uses an existing VPC or Amazon Web Services Direct Connect attachment as the underlying transport mechanism.
delete_transit_gateway_connect	delete	TransitGatewayAttachmentId, region	DryRun	Deletes the specified Connect attachment. You must first delete any Connect peers for the attachment.

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
TransitGatewayAttachmentId	string	The ID of the Connect attachment.
TransportTransitGatewayAttachmentId	string	The ID of the transit gateway attachment. You can specify a VPC attachment or Amazon Web Services Direct Connect attachment.
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: options.protocol - The tunnel protocol (gre). state - The state of the attachment (initiating | initiatingRequest | pendingAcceptance | rollingBack | pending | available | modifying | deleting | deleted | failed | rejected | rejecting | failing). transit-gateway-attachment-id - The ID of the Connect attachment. transit-gateway-id - The ID of the transit gateway. transport-transit-gateway-attachment-id - The ID of the transit gateway attachment from which the Connect attachment was created.
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 Connect attachment options.
TagSpecification	array	The tags to apply to the Connect attachment.
TransitGatewayAttachmentIds	array	The IDs of the attachments.

SELECT examples

describe_transit_gateway_connects

Describes one or more Connect attachments.

SELECT
creation_time,
options,
state,
tags,
transit_gateway_attachment_id,
transit_gateway_id,
transport_transit_gateway_attachment_id
FROM aws.ec2.transit_gateway_connects
WHERE region = '{{ region }}' -- required
AND TransitGatewayAttachmentIds = '{{ TransitGatewayAttachmentIds }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND DryRun = '{{ DryRun }}'
;

INSERT examples

create_transit_gateway_connect

Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance. A Connect attachment uses an existing VPC or Amazon Web Services Direct Connect attachment as the underlying transport mechanism.

INSERT INTO aws.ec2.transit_gateway_connects (
TransportTransitGatewayAttachmentId,
region,
Options,
TagSpecification,
DryRun
)
SELECT 
'{{ TransportTransitGatewayAttachmentId }}',
'{{ region }}',
'{{ Options }}',
'{{ TagSpecification }}',
'{{ DryRun }}'
RETURNING
creation_time,
options,
state,
tags,
transit_gateway_attachment_id,
transit_gateway_id,
transport_transit_gateway_attachment_id
;

Manifest

# Description fields are for documentation purposes
- name: transit_gateway_connects
props:
  - name: TransportTransitGatewayAttachmentId
    value: "{{ TransportTransitGatewayAttachmentId }}"
    description: Required parameter for the transit_gateway_connects resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the transit_gateway_connects resource.
  - name: Options
    value: "{{ Options }}"
    description: The Connect attachment options.
    description: The Connect attachment options.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: The tags to apply to the Connect attachment.
    description: The tags to apply to the Connect attachment.
  - 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.

DELETE examples

delete_transit_gateway_connect

Deletes the specified Connect attachment. You must first delete any Connect peers for the attachment.

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