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	aws.ec2.transit_gateway_routes

Fields

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.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	TransitGatewayRouteTableId, DestinationCidrBlock, region
delete_resource	DELETE	data__Identifier, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all transit_gateway_routes in a region.

SELECT
region,
transit_gateway_route_table_id,
destination_cidr_block,
blackhole,
transit_gateway_attachment_id
FROM aws.ec2.transit_gateway_routes
WHERE region = 'us-east-1';

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 aws.ec2.transit_gateway_routes
WHERE region = 'us-east-1' AND data__Identifier = '<TransitGatewayRouteTableId>|<DestinationCidrBlock>';

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 aws.ec2.transit_gateway_routes (
 TransitGatewayRouteTableId,
 DestinationCidrBlock,
 region
)
SELECT 
'{{ TransitGatewayRouteTableId }}',
 '{{ DestinationCidrBlock }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ec2.transit_gateway_routes (
 TransitGatewayRouteTableId,
 DestinationCidrBlock,
 Blackhole,
 TransitGatewayAttachmentId,
 region
)
SELECT 
 '{{ TransitGatewayRouteTableId }}',
 '{{ DestinationCidrBlock }}',
 '{{ Blackhole }}',
 '{{ TransitGatewayAttachmentId }}',
 '{{ 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: TransitGatewayRouteTableId
        value: '{{ TransitGatewayRouteTableId }}'
      - name: DestinationCidrBlock
        value: '{{ DestinationCidrBlock }}'
      - name: Blackhole
        value: '{{ Blackhole }}'
      - name: TransitGatewayAttachmentId
        value: '{{ TransitGatewayAttachmentId }}'

DELETE example

/*+ delete */
DELETE FROM aws.ec2.transit_gateway_routes
WHERE data__Identifier = '<TransitGatewayRouteTableId|DestinationCidrBlock>'
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