transit_gateway_policy_tables

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

Overview

Name	transit_gateway_policy_tables
Type	Resource
Id	aws.ec2.transit_gateway_policy_tables

Fields

The following fields are returned by SELECT queries:

describe_transit_gateway_policy_tables

Name	Datatype	Description
creation_time	string	The timestamp when the transit gateway policy table was created.
state	string	The state of the transit gateway policy table
tags	string	he key-value pairs associated with the transit gateway policy table.
transit_gateway_id	string	The ID of the transit gateway.
transit_gateway_policy_table_id	string	The ID of the transit gateway policy table.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_transit_gateway_policy_tables	select	region	TransitGatewayPolicyTableIds, Filter, MaxResults, NextToken, DryRun	Describes one or more transit gateway route policy tables.
create_transit_gateway_policy_table	insert	TransitGatewayId, region	TagSpecifications, DryRun	Creates a transit gateway policy table.
associate_transit_gateway_policy_table	update	TransitGatewayPolicyTableId, TransitGatewayAttachmentId, region	DryRun	Associates the specified transit gateway attachment with a transit gateway policy table.
delete_transit_gateway_policy_table	delete	TransitGatewayPolicyTableId, region	DryRun	Deletes the specified transit gateway policy table.
disassociate_transit_gateway_policy_table	exec	TransitGatewayPolicyTableId, TransitGatewayAttachmentId, region	DryRun	Removes the association between an an attachment and a policy 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 transit gateway attachment to disassociate from the policy table.
TransitGatewayId	string	The ID of the transit gateway used for the policy table.
TransitGatewayPolicyTableId	string	The ID of the disassociated policy 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	The filters associated with the transit gateway policy 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 specification for the transit gateway policy table created during the request.
TransitGatewayPolicyTableIds	array	The IDs of the transit gateway policy tables.

SELECT examples

describe_transit_gateway_policy_tables

Describes one or more transit gateway route policy tables.

SELECT
creation_time,
state,
tags,
transit_gateway_id,
transit_gateway_policy_table_id
FROM aws.ec2.transit_gateway_policy_tables
WHERE region = '{{ region }}' -- required
AND TransitGatewayPolicyTableIds = '{{ TransitGatewayPolicyTableIds }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND DryRun = '{{ DryRun }}'
;

INSERT examples

create_transit_gateway_policy_table

Creates a transit gateway policy table.

INSERT INTO aws.ec2.transit_gateway_policy_tables (
TransitGatewayId,
region,
TagSpecifications,
DryRun
)
SELECT 
'{{ TransitGatewayId }}',
'{{ region }}',
'{{ TagSpecifications }}',
'{{ DryRun }}'
RETURNING
creation_time,
state,
tags,
transit_gateway_id,
transit_gateway_policy_table_id
;

Manifest

# Description fields are for documentation purposes
- name: transit_gateway_policy_tables
props:
  - name: TransitGatewayId
    value: "{{ TransitGatewayId }}"
    description: Required parameter for the transit_gateway_policy_tables resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the transit_gateway_policy_tables resource.
  - name: TagSpecifications
    value: "{{ TagSpecifications }}"
    description: The tags specification for the transit gateway policy table created during the request.
    description: The tags specification for the transit gateway policy table created during the request.
  - 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_policy_table

Associates the specified transit gateway attachment with a transit gateway policy table.

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

DELETE examples

delete_transit_gateway_policy_table

Deletes the specified transit gateway policy table.

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

Lifecycle Methods

disassociate_transit_gateway_policy_table

Removes the association between an an attachment and a policy table.

EXEC aws.ec2.transit_gateway_policy_tables.disassociate_transit_gateway_policy_table 
@TransitGatewayPolicyTableId='{{ TransitGatewayPolicyTableId }}' --required, 
@TransitGatewayAttachmentId='{{ TransitGatewayAttachmentId }}' --required, 
@region='{{ region }}' --required, 
@DryRun={{ DryRun }}
;