transit_gateway_route_table_announcements

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

Overview

Name	transit_gateway_route_table_announcements
Type	Resource
Id	aws.ec2.transit_gateway_route_table_announcements

Fields

The following fields are returned by SELECT queries:

describe_transit_gateway_route_table_announcements

Name	Datatype	Description
announcement_direction	string	The direction for the route table announcement.
core_network_id	string	The ID of the core network for the transit gateway route table announcement.
creation_time	string	The timestamp when the transit gateway route table announcement was created.
peer_core_network_id	string	The ID of the core network ID for the peer.
peer_transit_gateway_id	string	The ID of the peer transit gateway.
peering_attachment_id	string	The ID of the peering attachment.
state	string	The state of the transit gateway announcement.
tags	string	The key-value pairs associated with the route table announcement.
transit_gateway_id	string	The ID of the transit gateway.
transit_gateway_route_table_announcement_id	string	The ID of the transit gateway route table announcement.
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_table_announcements	select	region	TransitGatewayRouteTableAnnouncementIds, Filter, MaxResults, NextToken, DryRun	Describes one or more transit gateway route table advertisements.
create_transit_gateway_route_table_announcement	insert	TransitGatewayRouteTableId, PeeringAttachmentId, region	TagSpecification, DryRun	Advertises a new transit gateway route table.
delete_transit_gateway_route_table_announcement	delete	TransitGatewayRouteTableAnnouncementId, region	DryRun	Advertises to the transit gateway that a transit gateway route table is deleted.

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
PeeringAttachmentId	string	The ID of the peering attachment.
TransitGatewayRouteTableAnnouncementId	string	The transit gateway route table ID that's being deleted.
TransitGatewayRouteTableId	string	The ID of the transit gateway 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	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.
TagSpecification	array	The tags specifications applied to the transit gateway route table announcement.
TransitGatewayRouteTableAnnouncementIds	array	The IDs of the transit gateway route tables that are being advertised.

SELECT examples

describe_transit_gateway_route_table_announcements

Describes one or more transit gateway route table advertisements.

SELECT
announcement_direction,
core_network_id,
creation_time,
peer_core_network_id,
peer_transit_gateway_id,
peering_attachment_id,
state,
tags,
transit_gateway_id,
transit_gateway_route_table_announcement_id,
transit_gateway_route_table_id
FROM aws.ec2.transit_gateway_route_table_announcements
WHERE region = '{{ region }}' -- required
AND TransitGatewayRouteTableAnnouncementIds = '{{ TransitGatewayRouteTableAnnouncementIds }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND DryRun = '{{ DryRun }}'
;

INSERT examples

create_transit_gateway_route_table_announcement

Advertises a new transit gateway route table.

INSERT INTO aws.ec2.transit_gateway_route_table_announcements (
TransitGatewayRouteTableId,
PeeringAttachmentId,
region,
TagSpecification,
DryRun
)
SELECT 
'{{ TransitGatewayRouteTableId }}',
'{{ PeeringAttachmentId }}',
'{{ region }}',
'{{ TagSpecification }}',
'{{ DryRun }}'
RETURNING
announcement_direction,
core_network_id,
creation_time,
peer_core_network_id,
peer_transit_gateway_id,
peering_attachment_id,
state,
tags,
transit_gateway_id,
transit_gateway_route_table_announcement_id,
transit_gateway_route_table_id
;

Manifest

# Description fields are for documentation purposes
- name: transit_gateway_route_table_announcements
props:
  - name: TransitGatewayRouteTableId
    value: "{{ TransitGatewayRouteTableId }}"
    description: Required parameter for the transit_gateway_route_table_announcements resource.
  - name: PeeringAttachmentId
    value: "{{ PeeringAttachmentId }}"
    description: Required parameter for the transit_gateway_route_table_announcements resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the transit_gateway_route_table_announcements resource.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: The tags specifications applied to the transit gateway route table announcement.
    description: The tags specifications applied to the transit gateway route table announcement.
  - 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.

DELETE examples

delete_transit_gateway_route_table_announcement

Advertises to the transit gateway that a transit gateway route table is deleted.

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