local_gateways

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

Overview

Name	local_gateways
Type	Resource
Id	aws.ec2.local_gateways

Fields

The following fields are returned by SELECT queries:

describe_local_gateways

Name	Datatype	Description
local_gateway_id	string	The ID of the local gateway.
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.
state	string	The state of the local gateway.
tags	string	The tags assigned to the local gateway.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_local_gateways	select	region	LocalGatewayId, Filter, MaxResults, NextToken, DryRun	Describes one or more local gateways. By default, all local gateways are described. Alternatively, you can filter the results.

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
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. 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. state - The state of the association.
LocalGatewayId	array	The IDs of the local gateways.
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.

SELECT examples

describe_local_gateways

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

SELECT
local_gateway_id,
outpost_arn,
owner_id,
state,
tags
FROM aws.ec2.local_gateways
WHERE region = '{{ region }}' -- required
AND LocalGatewayId = '{{ LocalGatewayId }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND DryRun = '{{ DryRun }}'
;