transit_gateway_route_tables

Creates, updates, deletes, gets or lists a transit_gateway_route_tables resource.

Overview

Name	transit_gateway_route_tables
Type	Resource
Id	aws.ec2.transit_gateway_route_tables

Fields

The following fields are returned by SELECT queries:

describe_transit_gateway_route_tables

Name	Datatype	Description
creation_time	string	The creation time.
default_association_route_table	boolean	Indicates whether this is the default association route table for the transit gateway.
default_propagation_route_table	boolean	Indicates whether this is the default propagation route table for the transit gateway.
state	string	The state of the transit gateway route table.
tags	string	Any tags assigned to the route table.
transit_gateway_id	string	The ID of the transit gateway.
transit_gateway_route_table_id	string	The ID of the transit gateway route table.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_transit_gateway_route_tables	select	region	TransitGatewayRouteTableIds, Filter, MaxResults, NextToken, DryRun	Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results.
create_transit_gateway_route_table	insert	TransitGatewayId, region	TagSpecifications, DryRun	Creates a route table for the specified transit gateway.
associate_transit_gateway_route_table	update	TransitGatewayRouteTableId, TransitGatewayAttachmentId, region	DryRun	Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.
delete_transit_gateway_route_table	delete	TransitGatewayRouteTableId, region	DryRun	Deletes the specified transit gateway route table. If there are any route tables associated with the transit gateway route table, you must first run DisassociateRouteTable before you can delete the transit gateway route table. This removes any route tables associated with the transit gateway route table.
disable_transit_gateway_route_table_propagation	exec	TransitGatewayRouteTableId, region	TransitGatewayAttachmentId, DryRun, TransitGatewayRouteTableAnnouncementId	Disables the specified resource attachment from propagating routes to the specified propagation route table.
disassociate_transit_gateway_route_table	exec	TransitGatewayRouteTableId, TransitGatewayAttachmentId, region	DryRun	Disassociates a resource attachment from a transit gateway route table.
enable_transit_gateway_route_table_propagation	exec	TransitGatewayRouteTableId, region	TransitGatewayAttachmentId, DryRun, TransitGatewayRouteTableAnnouncementId	Enables the specified attachment to propagate routes to the specified propagation route table.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
TransitGatewayAttachmentId	string	The ID of the attachment.
TransitGatewayId	string	The ID of the transit gateway.
TransitGatewayRouteTableId	string	The ID of the propagation route table.
region	string	AWS region (default: us-east-1)
DryRun	boolean	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Filter	array	One or more filters. The possible values are: default-association-route-table - Indicates whether this is the default association route table for the transit gateway (true | false). default-propagation-route-table - Indicates whether this is the default propagation route table for the transit gateway (true | false). state - The state of the route table (available | deleting | deleted | pending). transit-gateway-id - The ID of the transit gateway. transit-gateway-route-table-id - The ID of the transit gateway route table.
MaxResults	integer	The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
NextToken	string	The token for the next page of results.
TagSpecifications	array	The tags to apply to the transit gateway route table.
TransitGatewayAttachmentId	string	The ID of the attachment.
TransitGatewayRouteTableAnnouncementId	string	The ID of the transit gateway route table announcement.
TransitGatewayRouteTableIds	array	The IDs of the transit gateway route tables.

SELECT examples

describe_transit_gateway_route_tables

Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results.

SELECT
creation_time,
default_association_route_table,
default_propagation_route_table,
state,
tags,
transit_gateway_id,
transit_gateway_route_table_id
FROM aws.ec2.transit_gateway_route_tables
WHERE region = '{{ region }}' -- required
AND TransitGatewayRouteTableIds = '{{ TransitGatewayRouteTableIds }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND DryRun = '{{ DryRun }}'
;

INSERT examples

create_transit_gateway_route_table

Creates a route table for the specified transit gateway.

INSERT INTO aws.ec2.transit_gateway_route_tables (
TransitGatewayId,
region,
TagSpecifications,
DryRun
)
SELECT 
'{{ TransitGatewayId }}',
'{{ region }}',
'{{ TagSpecifications }}',
'{{ DryRun }}'
RETURNING
creation_time,
default_association_route_table,
default_propagation_route_table,
state,
tags,
transit_gateway_id,
transit_gateway_route_table_id
;

Manifest

# Description fields are for documentation purposes
- name: transit_gateway_route_tables
props:
  - name: TransitGatewayId
    value: "{{ TransitGatewayId }}"
    description: Required parameter for the transit_gateway_route_tables resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the transit_gateway_route_tables resource.
  - name: TagSpecifications
    value: "{{ TagSpecifications }}"
    description: The tags to apply to the transit gateway route table.
    description: The tags to apply to the transit gateway route table.
  - name: DryRun
    value: {{ DryRun }}
    description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
    description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

UPDATE examples

associate_transit_gateway_route_table

Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.

UPDATE aws.ec2.transit_gateway_route_tables
SET 
-- No updatable properties
WHERE 
TransitGatewayRouteTableId = '{{ TransitGatewayRouteTableId }}' --required
AND TransitGatewayAttachmentId = '{{ TransitGatewayAttachmentId }}' --required
AND region = '{{ region }}' --required
AND DryRun = {{ DryRun}}
RETURNING
resource_id,
resource_type,
state,
transit_gateway_attachment_id,
transit_gateway_route_table_id;

DELETE examples

delete_transit_gateway_route_table

Deletes the specified transit gateway route table. If there are any route tables associated with the transit gateway route table, you must first run DisassociateRouteTable before you can delete the transit gateway route table. This removes any route tables associated with the transit gateway route table.

DELETE FROM aws.ec2.transit_gateway_route_tables
WHERE TransitGatewayRouteTableId = '{{ TransitGatewayRouteTableId }}' --required
AND region = '{{ region }}' --required
AND DryRun = '{{ DryRun }}'
;

Lifecycle Methods

disable_transit_gateway_route_table_propagation

Disables the specified resource attachment from propagating routes to the specified propagation route table.

EXEC aws.ec2.transit_gateway_route_tables.disable_transit_gateway_route_table_propagation 
@TransitGatewayRouteTableId='{{ TransitGatewayRouteTableId }}' --required, 
@region='{{ region }}' --required, 
@TransitGatewayAttachmentId='{{ TransitGatewayAttachmentId }}', 
@DryRun={{ DryRun }}, 
@TransitGatewayRouteTableAnnouncementId='{{ TransitGatewayRouteTableAnnouncementId }}'
;

disassociate_transit_gateway_route_table

Disassociates a resource attachment from a transit gateway route table.

EXEC aws.ec2.transit_gateway_route_tables.disassociate_transit_gateway_route_table 
@TransitGatewayRouteTableId='{{ TransitGatewayRouteTableId }}' --required, 
@TransitGatewayAttachmentId='{{ TransitGatewayAttachmentId }}' --required, 
@region='{{ region }}' --required, 
@DryRun={{ DryRun }}
;

enable_transit_gateway_route_table_propagation

Enables the specified attachment to propagate routes to the specified propagation route table.

EXEC aws.ec2.transit_gateway_route_tables.enable_transit_gateway_route_table_propagation 
@TransitGatewayRouteTableId='{{ TransitGatewayRouteTableId }}' --required, 
@region='{{ region }}' --required, 
@TransitGatewayAttachmentId='{{ TransitGatewayAttachmentId }}', 
@DryRun={{ DryRun }}, 
@TransitGatewayRouteTableAnnouncementId='{{ TransitGatewayRouteTableAnnouncementId }}'
;