transit_gateways

Creates, updates, deletes or gets a transit_gateway resource or lists transit_gateways in a region

Overview

Name	transit_gateways
Type	Resource
Description	Resource Type definition for AWS::EC2::TransitGateway
Id	awscc.ec2.transit_gateways

Fields

get (all properties)

Name	Datatype	Description
default_route_table_propagation	string
transit_gateway_arn	string
description	string
auto_accept_shared_attachments	string
default_route_table_association	string
id	string
vpn_ecmp_support	string
dns_support	string
security_group_referencing_support	string
multicast_support	string
amazon_side_asn	integer
transit_gateway_cidr_blocks	array
▶tags	array
association_default_route_table_id	string
propagation_default_route_table_id	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	transit_gateways	INSERT	region
delete_resource	transit_gateways	DELETE	Identifier, region
update_resource	transit_gateways	UPDATE	Identifier, PatchDocument, region
list_resources	transit_gateways_list_only	SELECT	region
get_resource	transit_gateways	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual transit_gateway.

SELECT
  region,
  default_route_table_propagation,
  transit_gateway_arn,
  description,
  auto_accept_shared_attachments,
  default_route_table_association,
  id,
  vpn_ecmp_support,
  dns_support,
  security_group_referencing_support,
  multicast_support,
  amazon_side_asn,
  transit_gateway_cidr_blocks,
  tags,
  association_default_route_table_id,
  propagation_default_route_table_id
FROM awscc.ec2.transit_gateways
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all transit_gateways in a region.

SELECT
  region,
  id
FROM awscc.ec2.transit_gateways_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ec2.transit_gateways (
  DefaultRouteTablePropagation,
  Description,
  AutoAcceptSharedAttachments,
  DefaultRouteTableAssociation,
  VpnEcmpSupport,
  DnsSupport,
  SecurityGroupReferencingSupport,
  MulticastSupport,
  AmazonSideAsn,
  TransitGatewayCidrBlocks,
  Tags,
  AssociationDefaultRouteTableId,
  PropagationDefaultRouteTableId,
  region
)
SELECT
  '{{ default_route_table_propagation }}',
  '{{ description }}',
  '{{ auto_accept_shared_attachments }}',
  '{{ default_route_table_association }}',
  '{{ vpn_ecmp_support }}',
  '{{ dns_support }}',
  '{{ security_group_referencing_support }}',
  '{{ multicast_support }}',
  '{{ amazon_side_asn }}',
  '{{ transit_gateway_cidr_blocks }}',
  '{{ tags }}',
  '{{ association_default_route_table_id }}',
  '{{ propagation_default_route_table_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ec2.transit_gateways (
  DefaultRouteTablePropagation,
  Description,
  AutoAcceptSharedAttachments,
  DefaultRouteTableAssociation,
  VpnEcmpSupport,
  DnsSupport,
  SecurityGroupReferencingSupport,
  MulticastSupport,
  AmazonSideAsn,
  TransitGatewayCidrBlocks,
  Tags,
  AssociationDefaultRouteTableId,
  PropagationDefaultRouteTableId,
  region
)
SELECT
  '{{ default_route_table_propagation }}',
  '{{ description }}',
  '{{ auto_accept_shared_attachments }}',
  '{{ default_route_table_association }}',
  '{{ vpn_ecmp_support }}',
  '{{ dns_support }}',
  '{{ security_group_referencing_support }}',
  '{{ multicast_support }}',
  '{{ amazon_side_asn }}',
  '{{ transit_gateway_cidr_blocks }}',
  '{{ tags }}',
  '{{ association_default_route_table_id }}',
  '{{ propagation_default_route_table_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: transit_gateway
  props:
    - name: default_route_table_propagation
      value: '{{ default_route_table_propagation }}'
    - name: description
      value: '{{ description }}'
    - name: auto_accept_shared_attachments
      value: '{{ auto_accept_shared_attachments }}'
    - name: default_route_table_association
      value: '{{ default_route_table_association }}'
    - name: vpn_ecmp_support
      value: '{{ vpn_ecmp_support }}'
    - name: dns_support
      value: '{{ dns_support }}'
    - name: security_group_referencing_support
      value: '{{ security_group_referencing_support }}'
    - name: multicast_support
      value: '{{ multicast_support }}'
    - name: amazon_side_asn
      value: '{{ amazon_side_asn }}'
    - name: transit_gateway_cidr_blocks
      value:
        - '{{ transit_gateway_cidr_blocks[0] }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: association_default_route_table_id
      value: '{{ association_default_route_table_id }}'
    - name: propagation_default_route_table_id
      value: '{{ propagation_default_route_table_id }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ec2.transit_gateways
SET PatchDocument = string('{{ {
    "DefaultRouteTablePropagation": default_route_table_propagation,
    "Description": description,
    "AutoAcceptSharedAttachments": auto_accept_shared_attachments,
    "DefaultRouteTableAssociation": default_route_table_association,
    "VpnEcmpSupport": vpn_ecmp_support,
    "DnsSupport": dns_support,
    "SecurityGroupReferencingSupport": security_group_referencing_support,
    "TransitGatewayCidrBlocks": transit_gateway_cidr_blocks,
    "Tags": tags,
    "AssociationDefaultRouteTableId": association_default_route_table_id,
    "PropagationDefaultRouteTableId": propagation_default_route_table_id
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.transit_gateways
WHERE
  Identifier = '{{ id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

ec2:CreateTransitGateway,
ec2:CreateTags,
ec2:DescribeTransitGateways,
ec2:DescribeTags

Read

ec2:DescribeTransitGateways,
ec2:DescribeTags

Delete

ec2:DescribeTransitGateways,
ec2:DescribeTags,
ec2:DeleteTransitGateway,
ec2:DeleteTags

Update

ec2:CreateTransitGateway,
ec2:CreateTags,
ec2:DescribeTransitGateways,
ec2:DescribeTags,
ec2:DeleteTransitGateway,
ec2:DeleteTags,
ec2:ModifyTransitGateway,
ec2:ModifyTransitGatewayOptions

List

ec2:DescribeTransitGateways,
ec2:DescribeTags