transit_gateway_prefix_list_references

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

Overview

Name	transit_gateway_prefix_list_references
Type	Resource
Id	aws.ec2.transit_gateway_prefix_list_references

Fields

The following fields are returned by SELECT queries:

get_transit_gateway_prefix_list_references

Name	Datatype	Description
blackhole	boolean	Indicates whether traffic that matches this route is dropped.
prefix_list_id	string	The ID of the prefix list.
prefix_list_owner_id	string	The ID of the prefix list owner.
state	string	The state of the prefix list reference.
transit_gateway_attachment	string	Information about the transit gateway attachment.
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
get_transit_gateway_prefix_list_references	select	TransitGatewayRouteTableId, region	Filter, MaxResults, NextToken, DryRun	Gets information about the prefix list references in a specified transit gateway route table.
create_transit_gateway_prefix_list_reference	insert	TransitGatewayRouteTableId, PrefixListId, region	TransitGatewayAttachmentId, Blackhole, DryRun	Creates a reference (route) to a prefix list in a specified transit gateway route table.
modify_transit_gateway_prefix_list_reference	update	TransitGatewayRouteTableId, PrefixListId, region	TransitGatewayAttachmentId, Blackhole, DryRun	Modifies a reference (route) to a prefix list in a specified transit gateway route table.
delete_transit_gateway_prefix_list_reference	delete	TransitGatewayRouteTableId, PrefixListId, region	DryRun	Deletes a reference (route) to a prefix list in a specified transit gateway 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
PrefixListId	string	The ID of the prefix list.
TransitGatewayRouteTableId	string	The ID of the route table.
region	string	AWS region (default: us-east-1)
Blackhole	boolean	Indicates whether to drop traffic that matches this route.
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: attachment.resource-id - The ID of the resource for the attachment. attachment.resource-type - The type of resource for the attachment. Valid values are vpc | vpn | direct-connect-gateway | peering. attachment.transit-gateway-attachment-id - The ID of the attachment. is-blackhole - Whether traffic matching the route is blocked (true | false). prefix-list-id - The ID of the prefix list. prefix-list-owner-id - The ID of the owner of the prefix list. state - The state of the prefix list reference (pending | available | modifying | deleting).
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.
TransitGatewayAttachmentId	string	The ID of the attachment to which traffic is routed.

SELECT examples

get_transit_gateway_prefix_list_references

Gets information about the prefix list references in a specified transit gateway route table.

SELECT
blackhole,
prefix_list_id,
prefix_list_owner_id,
state,
transit_gateway_attachment,
transit_gateway_route_table_id
FROM aws.ec2.transit_gateway_prefix_list_references
WHERE TransitGatewayRouteTableId = '{{ TransitGatewayRouteTableId }}' -- required
AND region = '{{ region }}' -- required
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND DryRun = '{{ DryRun }}'
;

INSERT examples

create_transit_gateway_prefix_list_reference

Creates a reference (route) to a prefix list in a specified transit gateway route table.

INSERT INTO aws.ec2.transit_gateway_prefix_list_references (
TransitGatewayRouteTableId,
PrefixListId,
region,
TransitGatewayAttachmentId,
Blackhole,
DryRun
)
SELECT 
'{{ TransitGatewayRouteTableId }}',
'{{ PrefixListId }}',
'{{ region }}',
'{{ TransitGatewayAttachmentId }}',
'{{ Blackhole }}',
'{{ DryRun }}'
RETURNING
blackhole,
prefix_list_id,
prefix_list_owner_id,
state,
transit_gateway_attachment,
transit_gateway_route_table_id
;

Manifest

# Description fields are for documentation purposes
- name: transit_gateway_prefix_list_references
props:
  - name: TransitGatewayRouteTableId
    value: "{{ TransitGatewayRouteTableId }}"
    description: Required parameter for the transit_gateway_prefix_list_references resource.
  - name: PrefixListId
    value: "{{ PrefixListId }}"
    description: Required parameter for the transit_gateway_prefix_list_references resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the transit_gateway_prefix_list_references resource.
  - name: TransitGatewayAttachmentId
    value: "{{ TransitGatewayAttachmentId }}"
    description: The ID of the attachment to which traffic is routed.
    description: The ID of the attachment to which traffic is routed.
  - name: Blackhole
    value: {{ Blackhole }}
    description: Indicates whether to drop traffic that matches this route.
    description: Indicates whether to drop traffic that matches this route.
  - 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

modify_transit_gateway_prefix_list_reference

Modifies a reference (route) to a prefix list in a specified transit gateway route table.

UPDATE aws.ec2.transit_gateway_prefix_list_references
SET 
-- No updatable properties
WHERE 
TransitGatewayRouteTableId = '{{ TransitGatewayRouteTableId }}' --required
AND PrefixListId = '{{ PrefixListId }}' --required
AND region = '{{ region }}' --required
AND TransitGatewayAttachmentId = '{{ TransitGatewayAttachmentId}}'
AND Blackhole = {{ Blackhole}}
AND DryRun = {{ DryRun}}
RETURNING
blackhole,
prefix_list_id,
prefix_list_owner_id,
state,
transit_gateway_attachment,
transit_gateway_route_table_id;

DELETE examples

delete_transit_gateway_prefix_list_reference

Deletes a reference (route) to a prefix list in a specified transit gateway route table.

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