local_gateway_route_table_virtual_interface_group_associations

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

Overview

Name	local_gateway_route_table_virtual_interface_group_associations
Type	Resource
Id	aws.ec2.local_gateway_route_table_virtual_interface_group_associations

Fields

The following fields are returned by SELECT queries:

describe_local_gateway_route_table_virtual_interface_group_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 virtual interface group.
local_gateway_route_table_id	string	The ID of the local gateway route table.
local_gateway_route_table_virtual_interface_group_association_id	string	The ID of the association.
local_gateway_virtual_interface_group_id	string	The ID of the virtual interface group.
owner_id	string	The ID of the Amazon Web Services account that owns the local gateway virtual interface group association.
state	string	The state of the association.
tags	string	The tags assigned to the association.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_local_gateway_route_table_virtual_interface_group_associations	select	region	LocalGatewayRouteTableVirtualInterfaceGroupAssociationId, Filter, MaxResults, NextToken, DryRun	Describes the associations between virtual interface groups and local gateway route tables.
create_local_gateway_route_table_virtual_interface_group_association	insert	LocalGatewayRouteTableId, LocalGatewayVirtualInterfaceGroupId, region	TagSpecification, DryRun	Creates a local gateway route table virtual interface group association.
delete_local_gateway_route_table_virtual_interface_group_association	delete	LocalGatewayRouteTableVirtualInterfaceGroupAssociationId, region	DryRun	Deletes a local gateway route table virtual interface group association.

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.
LocalGatewayRouteTableVirtualInterfaceGroupAssociationId	string	The ID of the local gateway route table virtual interface group association.
LocalGatewayVirtualInterfaceGroupId	string	The ID of the local gateway route table virtual interface group association.
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 virtual interface group. local-gateway-route-table-id - The ID of the local gateway route table. local-gateway-route-table-virtual-interface-group-association-id - The ID of the association. local-gateway-route-table-virtual-interface-group-id - The ID of the virtual interface group. owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface group association. state - The state of the association.
LocalGatewayRouteTableVirtualInterfaceGroupAssociationId	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 assigned to the local gateway route table virtual interface group association.

SELECT examples

describe_local_gateway_route_table_virtual_interface_group_associations

Describes the associations between virtual interface groups and local gateway route tables.

SELECT
local_gateway_id,
local_gateway_route_table_arn,
local_gateway_route_table_id,
local_gateway_route_table_virtual_interface_group_association_id,
local_gateway_virtual_interface_group_id,
owner_id,
state,
tags
FROM aws.ec2.local_gateway_route_table_virtual_interface_group_associations
WHERE region = '{{ region }}' -- required
AND LocalGatewayRouteTableVirtualInterfaceGroupAssociationId = '{{ LocalGatewayRouteTableVirtualInterfaceGroupAssociationId }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND DryRun = '{{ DryRun }}'
;

INSERT examples

create_local_gateway_route_table_virtual_interface_group_association

Creates a local gateway route table virtual interface group association.

INSERT INTO aws.ec2.local_gateway_route_table_virtual_interface_group_associations (
LocalGatewayRouteTableId,
LocalGatewayVirtualInterfaceGroupId,
region,
TagSpecification,
DryRun
)
SELECT 
'{{ LocalGatewayRouteTableId }}',
'{{ LocalGatewayVirtualInterfaceGroupId }}',
'{{ region }}',
'{{ TagSpecification }}',
'{{ DryRun }}'
RETURNING
local_gateway_id,
local_gateway_route_table_arn,
local_gateway_route_table_id,
local_gateway_route_table_virtual_interface_group_association_id,
local_gateway_virtual_interface_group_id,
owner_id,
state,
tags
;

Manifest

# Description fields are for documentation purposes
- name: local_gateway_route_table_virtual_interface_group_associations
props:
  - name: LocalGatewayRouteTableId
    value: "{{ LocalGatewayRouteTableId }}"
    description: Required parameter for the local_gateway_route_table_virtual_interface_group_associations resource.
  - name: LocalGatewayVirtualInterfaceGroupId
    value: "{{ LocalGatewayVirtualInterfaceGroupId }}"
    description: Required parameter for the local_gateway_route_table_virtual_interface_group_associations resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the local_gateway_route_table_virtual_interface_group_associations resource.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: The tags assigned to the local gateway route table virtual interface group association.
    description: The tags assigned to the local gateway route table virtual interface group 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_virtual_interface_group_association

Deletes a local gateway route table virtual interface group association.

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