transit_gateway_vpc_attachments

Creates, updates, deletes or gets a transit_gateway_vpc_attachment resource or lists transit_gateway_vpc_attachments in a region

Overview

Name	transit_gateway_vpc_attachments
Type	Resource
Description	Resource Type definition for AWS::EC2::TransitGatewayVpcAttachment
Id	awscc.ec2.transit_gateway_vpc_attachments

Fields

get (all properties)

Name	Datatype	Description
id	string
transit_gateway_id	string
vpc_id	string
subnet_ids	array
add_subnet_ids	array
remove_subnet_ids	array
▶tags	array
▶options	object	The options for the transit gateway vpc attachment.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	transit_gateway_vpc_attachments	INSERT	SubnetIds, VpcId, TransitGatewayId, region
delete_resource	transit_gateway_vpc_attachments	DELETE	Identifier, region
update_resource	transit_gateway_vpc_attachments	UPDATE	Identifier, PatchDocument, region
list_resources	transit_gateway_vpc_attachments_list_only	SELECT	region
get_resource	transit_gateway_vpc_attachments	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual transit_gateway_vpc_attachment.

SELECT
  region,
  id,
  transit_gateway_id,
  vpc_id,
  subnet_ids,
  add_subnet_ids,
  remove_subnet_ids,
  tags,
  options
FROM awscc.ec2.transit_gateway_vpc_attachments
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all transit_gateway_vpc_attachments in a region.

SELECT
  region,
  id
FROM awscc.ec2.transit_gateway_vpc_attachments_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ec2.transit_gateway_vpc_attachments (
  TransitGatewayId,
  VpcId,
  SubnetIds,
  region
)
SELECT
  '{{ transit_gateway_id }}',
  '{{ vpc_id }}',
  '{{ subnet_ids }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.ec2.transit_gateway_vpc_attachments (
  TransitGatewayId,
  VpcId,
  SubnetIds,
  AddSubnetIds,
  RemoveSubnetIds,
  Tags,
  Options,
  region
)
SELECT
  '{{ transit_gateway_id }}',
  '{{ vpc_id }}',
  '{{ subnet_ids }}',
  '{{ add_subnet_ids }}',
  '{{ remove_subnet_ids }}',
  '{{ 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_vpc_attachment
    props:
      - name: transit_gateway_id
        value: '{{ transit_gateway_id }}'
      - name: vpc_id
        value: '{{ vpc_id }}'
      - name: subnet_ids
        value:
          - '{{ subnet_ids[0] }}'
      - name: add_subnet_ids
        value:
          - '{{ add_subnet_ids[0] }}'
      - name: remove_subnet_ids
        value:
          - '{{ remove_subnet_ids[0] }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: options
        value:
          dns_support: '{{ dns_support }}'
          ipv6_support: '{{ ipv6_support }}'
          appliance_mode_support: '{{ appliance_mode_support }}'
          security_group_referencing_support: '{{ security_group_referencing_support }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ec2.transit_gateway_vpc_attachments
SET PatchDocument = string('{{ {
    "AddSubnetIds": add_subnet_ids,
    "RemoveSubnetIds": remove_subnet_ids,
    "Tags": tags,
    "Options": options
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.transit_gateway_vpc_attachments
WHERE
  Identifier = '{{ id }}' AND
  region = 'us-east-1';

Permissions

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

Create

ec2:DescribeTransitGatewayVpcAttachments,
ec2:CreateTransitGatewayVpcAttachment,
ec2:CreateTags,
ec2:DescribeTags

Read

ec2:DescribeTransitGatewayVpcAttachments,
ec2:DescribeTags

Delete

ec2:DescribeTransitGatewayVpcAttachments,
ec2:DeleteTransitGatewayVpcAttachment,
ec2:DeleteTags,
ec2:DescribeTags

List

ec2:DescribeTransitGatewayVpcAttachments,
ec2:DescribeTags

Update

ec2:DescribeTransitGatewayVpcAttachments,
ec2:DescribeTags,
ec2:CreateTransitGatewayVpcAttachment,
ec2:CreateTags,
ec2:DeleteTransitGatewayVpcAttachment,
ec2:DeleteTags,
ec2:ModifyTransitGatewayVpcAttachment