transit_gateway_routes

Creates, updates, deletes or gets a transit_gateway_route resource or lists transit_gateway_routes in a region

Overview

Name	transit_gateway_routes
Type	Resource
Description	Resource Type definition for AWS::EC2::TransitGatewayRoute
Id	awscc.ec2.transit_gateway_routes

Fields

get (all properties)

Name	Datatype	Description
transit_gateway_route_table_id	string	The ID of transit gateway route table.
destination_cidr_block	string	The CIDR range used for destination matches. Routing decisions are based on the most specific match.
blackhole	boolean	Indicates whether to drop traffic that matches this route.
transit_gateway_attachment_id	string	The ID of transit gateway attachment.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
transit_gateway_route_table_id	string	The ID of transit gateway route table.
destination_cidr_block	string	The CIDR range used for destination matches. Routing decisions are based on the most specific match.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	transit_gateway_routes	INSERT	TransitGatewayRouteTableId, DestinationCidrBlock, region
delete_resource	transit_gateway_routes	DELETE	Identifier, region
list_resources	transit_gateway_routes_list_only	SELECT	region
get_resource	transit_gateway_routes	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual transit_gateway_route.

SELECT
  region,
  transit_gateway_route_table_id,
  destination_cidr_block,
  blackhole,
  transit_gateway_attachment_id
FROM awscc.ec2.transit_gateway_routes
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ transit_gateway_route_table_id }}|{{ destination_cidr_block }}';

list (identifiers only)

Lists all transit_gateway_routes in a region.

SELECT
  region,
  transit_gateway_route_table_id,
  destination_cidr_block
FROM awscc.ec2.transit_gateway_routes_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ec2.transit_gateway_routes (
  TransitGatewayRouteTableId,
  DestinationCidrBlock,
  region
)
SELECT
  '{{ transit_gateway_route_table_id }}',
  '{{ destination_cidr_block }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.ec2.transit_gateway_routes (
  TransitGatewayRouteTableId,
  DestinationCidrBlock,
  Blackhole,
  TransitGatewayAttachmentId,
  region
)
SELECT
  '{{ transit_gateway_route_table_id }}',
  '{{ destination_cidr_block }}',
  '{{ blackhole }}',
  '{{ transit_gateway_attachment_id }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: transit_gateway_route
    props:
      - name: transit_gateway_route_table_id
        value: '{{ transit_gateway_route_table_id }}'
      - name: destination_cidr_block
        value: '{{ destination_cidr_block }}'
      - name: blackhole
        value: '{{ blackhole }}'
      - name: transit_gateway_attachment_id
        value: '{{ transit_gateway_attachment_id }}'

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.transit_gateway_routes
WHERE
  Identifier = '{{ transit_gateway_route_table_id }}|{{ destination_cidr_block }}' AND
  region = 'us-east-1';

Permissions

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

Read

ec2:SearchTransitGatewayRoutes

Create

ec2:CreateTransitGatewayRoute,
ec2:SearchTransitGatewayRoutes

List

ec2:SearchTransitGatewayRoutes

Delete

ec2:DeleteTransitGatewayRoute,
ec2:SearchTransitGatewayRoutes