local_gateway_route_tables
Creates, updates, deletes, gets or lists a local_gateway_route_tables resource.
Overview
| Name | local_gateway_route_tables |
| Type | Resource |
| Id | aws.ec2.local_gateway_route_tables |
Fields
The following fields are returned by SELECT queries:
- describe_local_gateway_route_tables
| Name | Datatype | Description |
|---|---|---|
local_gateway_id | string | The ID of the local gateway. |
local_gateway_route_table_arn | string | The Amazon Resource Name (ARN) of the local gateway route table. |
local_gateway_route_table_id | string | The ID of the local gateway route table. |
mode | string | The mode of the local gateway route table. |
outpost_arn | string | The Amazon Resource Name (ARN) of the Outpost. |
owner_id | string | The ID of the Amazon Web Services account that owns the local gateway route table. |
state | string | The state of the local gateway route table. |
state_reason | string | Information about the state change. |
tags | string | The tags assigned to the local gateway route table. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_local_gateway_route_tables | select | region | LocalGatewayRouteTableId, Filter, MaxResults, NextToken, DryRun | Describes 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_table | insert | LocalGatewayId, region | Mode, TagSpecification, DryRun | Creates a local gateway route table. |
delete_local_gateway_route_table | delete | LocalGatewayRouteTableId, region | DryRun | Deletes 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.
| Name | Datatype | Description |
|---|---|---|
LocalGatewayId | string | The ID of the local gateway. |
LocalGatewayRouteTableId | string | The ID of the local 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 | One 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. |
LocalGatewayRouteTableId | array | The IDs of the local gateway route tables. |
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. |
Mode | string | The mode of the local gateway route table. |
NextToken | string | The token for the next page of results. |
TagSpecification | array | The tags assigned to the local gateway route table. |
SELECT examples
- describe_local_gateway_route_tables
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
- create_local_gateway_route_table
- Manifest
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
;
# Description fields are for documentation purposes
- name: local_gateway_route_tables
props:
- name: LocalGatewayId
value: "{{ LocalGatewayId }}"
description: Required parameter for the local_gateway_route_tables resource.
- name: region
value: "{{ region }}"
description: Required parameter for the local_gateway_route_tables resource.
- name: Mode
value: "{{ Mode }}"
description: The mode of the local gateway route table.
description: The mode of the local gateway route table.
- name: TagSpecification
value: "{{ TagSpecification }}"
description: The tags assigned to the local gateway route table.
description: The tags assigned to the local 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.
DELETE examples
- delete_local_gateway_route_table
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 }}'
;