local_gateway_route_table_vpc_associations

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

Overview

Name	local_gateway_route_table_vpc_associations
Type	Resource
Id	aws.ec2.local_gateway_route_table_vpc_associations

Fields

The following fields are returned by SELECT queries:

describe_local_gateway_route_table_vpc_associations

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 for the association.
local_gateway_route_table_id	string	The ID of the local gateway route table.
local_gateway_route_table_vpc_association_id	string	The ID of the association.
owner_id	string	The ID of the Amazon Web Services account that owns the local gateway route table for the association.
state	string	The state of the association.
tags	string	The tags assigned to the association.
vpc_id	string	The ID of the VPC.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_local_gateway_route_table_vpc_associations	select	region	LocalGatewayRouteTableVpcAssociationId, Filter, MaxResults, NextToken, DryRun	Describes the specified associations between VPCs and local gateway route tables.
create_local_gateway_route_table_vpc_association	insert	LocalGatewayRouteTableId, VpcId, region	TagSpecification, DryRun	Associates the specified VPC with the specified local gateway route table.
delete_local_gateway_route_table_vpc_association	delete	LocalGatewayRouteTableVpcAssociationId, region	DryRun	Deletes the specified association between a VPC and 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
LocalGatewayRouteTableId	string	The ID of the local gateway route table.
LocalGatewayRouteTableVpcAssociationId	string	The ID of the association.
VpcId	string	The ID of the VPC.
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 for the association. local-gateway-route-table-id - The ID of the local gateway route table. local-gateway-route-table-vpc-association-id - The ID of the association. owner-id - The ID of the Amazon Web Services account that owns the local gateway route table for the association. state - The state of the association. vpc-id - The ID of the VPC.
LocalGatewayRouteTableVpcAssociationId	array	The IDs of the associations.
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 to assign to the local gateway route table VPC association.

SELECT examples

describe_local_gateway_route_table_vpc_associations

Describes the specified associations between VPCs and local gateway route tables.

SELECT
local_gateway_id,
local_gateway_route_table_arn,
local_gateway_route_table_id,
local_gateway_route_table_vpc_association_id,
owner_id,
state,
tags,
vpc_id
FROM aws.ec2.local_gateway_route_table_vpc_associations
WHERE region = '{{ region }}' -- required
AND LocalGatewayRouteTableVpcAssociationId = '{{ LocalGatewayRouteTableVpcAssociationId }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND DryRun = '{{ DryRun }}'
;

INSERT examples

create_local_gateway_route_table_vpc_association

Associates the specified VPC with the specified local gateway route table.

INSERT INTO aws.ec2.local_gateway_route_table_vpc_associations (
LocalGatewayRouteTableId,
VpcId,
region,
TagSpecification,
DryRun
)
SELECT 
'{{ LocalGatewayRouteTableId }}',
'{{ VpcId }}',
'{{ region }}',
'{{ TagSpecification }}',
'{{ DryRun }}'
RETURNING
local_gateway_id,
local_gateway_route_table_arn,
local_gateway_route_table_id,
local_gateway_route_table_vpc_association_id,
owner_id,
state,
tags,
vpc_id
;

Manifest

# Description fields are for documentation purposes
- name: local_gateway_route_table_vpc_associations
props:
  - name: LocalGatewayRouteTableId
    value: "{{ LocalGatewayRouteTableId }}"
    description: Required parameter for the local_gateway_route_table_vpc_associations resource.
  - name: VpcId
    value: "{{ VpcId }}"
    description: Required parameter for the local_gateway_route_table_vpc_associations resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the local_gateway_route_table_vpc_associations resource.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: The tags to assign to the local gateway route table VPC association.
    description: The tags to assign to the local gateway route table VPC association.
  - 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_vpc_association

Deletes the specified association between a VPC and local gateway route table.

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