Skip to main content

local_gateway_route_tables

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

Overview

Namelocal_gateway_route_tables
TypeResource
Idaws.ec2.local_gateway_route_tables

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
local_gateway_idstringThe ID of the local gateway.
local_gateway_route_table_arnstringThe Amazon Resource Name (ARN) of the local gateway route table.
local_gateway_route_table_idstringThe ID of the local gateway route table.
modestringThe mode of the local gateway route table.
outpost_arnstringThe Amazon Resource Name (ARN) of the Outpost.
owner_idstringThe ID of the Amazon Web Services account that owns the local gateway route table.
statestringThe state of the local gateway route table.
state_reasonstringInformation about the state change.
tagsstringThe tags assigned to the local gateway route table.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_local_gateway_route_tablesselectregionLocalGatewayRouteTableId, Filter, MaxResults, NextToken, DryRunDescribes one or more local gateway route tables. By default, all local gateway route tables are described. Alternatively, you can filter the results.
create_local_gateway_route_tableinsertLocalGatewayId, regionMode, TagSpecification, DryRunCreates a local gateway route table.
delete_local_gateway_route_tabledeleteLocalGatewayRouteTableId, regionDryRunDeletes a local 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.

NameDatatypeDescription
LocalGatewayIdstringThe ID of the local gateway.
LocalGatewayRouteTableIdstringThe ID of the local gateway route table.
regionstringAWS region (default: us-east-1)
DryRunbooleanChecks 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.
FilterarrayOne or more filters. local-gateway-id - The ID of a local gateway. local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local gateway route table. local-gateway-route-table-id - The ID of a local gateway route table. outpost-arn - The Amazon Resource Name (ARN) of the Outpost. owner-id - The ID of the Amazon Web Services account that owns the local gateway route table. state - The state of the local gateway route table.
LocalGatewayRouteTableIdarrayThe IDs of the local gateway route tables.
MaxResultsintegerThe maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
ModestringThe mode of the local gateway route table.
NextTokenstringThe token for the next page of results.
TagSpecificationarrayThe tags assigned to the local gateway route table.

SELECT examples

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

SELECT
local_gateway_id,
local_gateway_route_table_arn,
local_gateway_route_table_id,
mode,
outpost_arn,
owner_id,
state,
state_reason,
tags
FROM aws.ec2.local_gateway_route_tables
WHERE region = '{{ region }}' -- required
AND LocalGatewayRouteTableId = '{{ LocalGatewayRouteTableId }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND DryRun = '{{ DryRun }}'
;

INSERT examples

Creates a local gateway route table.

INSERT INTO aws.ec2.local_gateway_route_tables (
LocalGatewayId,
region,
Mode,
TagSpecification,
DryRun
)
SELECT
'{{ LocalGatewayId }}',
'{{ region }}',
'{{ Mode }}',
'{{ TagSpecification }}',
'{{ DryRun }}'
RETURNING
local_gateway_id,
local_gateway_route_table_arn,
local_gateway_route_table_id,
mode,
outpost_arn,
owner_id,
state,
state_reason,
tags
;

DELETE examples

Deletes a local gateway route table.

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