transit_gateway_connects

Creates, updates, deletes or gets a transit_gateway_connect resource or lists transit_gateway_connects in a region

Overview

Name	transit_gateway_connects
Type	Resource
Description	The AWS::EC2::TransitGatewayConnect type
Id	aws.ec2.transit_gateway_connects

Fields

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	TransportTransitGatewayAttachmentId, Options, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all transit_gateway_connects in a region.

SELECT
region,
transit_gateway_attachment_id,
transport_transit_gateway_attachment_id,
transit_gateway_id,
state,
creation_time,
tags,
options
FROM aws.ec2.transit_gateway_connects
WHERE region = 'us-east-1';

Gets all properties from an individual transit_gateway_connect.

SELECT
region,
transit_gateway_attachment_id,
transport_transit_gateway_attachment_id,
transit_gateway_id,
state,
creation_time,
tags,
options
FROM aws.ec2.transit_gateway_connects
WHERE region = 'us-east-1' AND data__Identifier = '<TransitGatewayAttachmentId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.ec2.transit_gateway_connects (
 TransportTransitGatewayAttachmentId,
 Options,
 region
)
SELECT 
'{{ TransportTransitGatewayAttachmentId }}',
 '{{ Options }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ec2.transit_gateway_connects (
 TransportTransitGatewayAttachmentId,
 Tags,
 Options,
 region
)
SELECT 
 '{{ TransportTransitGatewayAttachmentId }}',
 '{{ Tags }}',
 '{{ Options }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: transit_gateway_connect
    props:
      - name: TransportTransitGatewayAttachmentId
        value: '{{ TransportTransitGatewayAttachmentId }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: Options
        value:
          Protocol: '{{ Protocol }}'

DELETE example

/*+ delete */
DELETE FROM aws.ec2.transit_gateway_connects
WHERE data__Identifier = '<TransitGatewayAttachmentId>'
AND region = 'us-east-1';

Permissions

To operate on the transit_gateway_connects resource, the following permissions are required:

Create

ec2:CreateTransitGatewayConnect,
ec2:DescribeTransitGatewayConnects,
ec2:CreateTags

Read

ec2:DescribeTransitGatewayConnects

Update

ec2:DescribeTransitGatewayConnects,
ec2:DeleteTags,
ec2:CreateTags

Delete

ec2:DeleteTransitGatewayConnect,
ec2:DescribeTransitGatewayConnects,
ec2:DeleteTags

List

ec2:DescribeTransitGatewayConnects