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	awscc.ec2.transit_gateway_connects

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
transit_gateway_attachment_id	string	The ID of the Connect attachment.
region	string	AWS region.

For more information, see AWS::EC2::TransitGatewayConnect.

Methods

Name	Resource	Accessible by	Required Params
create_resource	transit_gateway_connects	INSERT	TransportTransitGatewayAttachmentId, Options, region
delete_resource	transit_gateway_connects	DELETE	Identifier, region
update_resource	transit_gateway_connects	UPDATE	Identifier, PatchDocument, region
list_resources	transit_gateway_connects_list_only	SELECT	region
get_resource	transit_gateway_connects	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.ec2.transit_gateway_connects
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ transit_gateway_attachment_id }}';

list (identifiers only)

Lists all transit_gateway_connects in a region.

SELECT
  region,
  transit_gateway_attachment_id
FROM awscc.ec2.transit_gateway_connects_list_only
WHERE
  region = 'us-east-1';

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 awscc.ec2.transit_gateway_connects (
  TransportTransitGatewayAttachmentId,
  Options,
  region
)
SELECT
  '{{ transport_transit_gateway_attachment_id }}',
  '{{ options }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.ec2.transit_gateway_connects (
  TransportTransitGatewayAttachmentId,
  Tags,
  Options,
  region
)
SELECT
  '{{ transport_transit_gateway_attachment_id }}',
  '{{ 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: transport_transit_gateway_attachment_id
        value: '{{ transport_transit_gateway_attachment_id }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: options
        value:
          protocol: '{{ protocol }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ec2.transit_gateway_connects
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ transit_gateway_attachment_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.transit_gateway_connects
WHERE
  Identifier = '{{ transit_gateway_attachment_id }}' 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,
ec2:DescribeTags

Read

ec2:DescribeTransitGatewayConnects,
ec2:DescribeTags

Update

ec2:DescribeTransitGatewayConnects,
ec2:DeleteTags,
ec2:CreateTags,
ec2:DescribeTags

Delete

ec2:DeleteTransitGatewayConnect,
ec2:DescribeTransitGatewayConnects,
ec2:DeleteTags,
ec2:DescribeTags

List

ec2:DescribeTransitGatewayConnects,
ec2:DescribeTags