local_gateway_virtual_interface_groups

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

Overview

Name	local_gateway_virtual_interface_groups
Type	Resource
Id	aws.ec2.local_gateway_virtual_interface_groups

Fields

The following fields are returned by SELECT queries:

describe_local_gateway_virtual_interface_groups

Name	Datatype	Description
configuration_state	string	The current state of the local gateway virtual interface group.
local_bgp_asn	integer	The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP).
local_bgp_asn_extended	integer	The extended 32-bit ASN for the local BGP configuration.
local_gateway_id	string	The ID of the local gateway.
local_gateway_virtual_interface_group_arn	string	The Amazon Resource Number (ARN) of the local gateway virtual interface group.
local_gateway_virtual_interface_group_id	string	The ID of the virtual interface group.
local_gateway_virtual_interface_ids	string	The IDs of the virtual interfaces.
owner_id	string	The ID of the Amazon Web Services account that owns the local gateway virtual interface group.
tags	string	The tags assigned to the virtual interface group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_local_gateway_virtual_interface_groups	select	region	LocalGatewayVirtualInterfaceGroupId, Filter, MaxResults, NextToken, DryRun	Describes the specified local gateway virtual interface groups.
create_local_gateway_virtual_interface_group	insert	LocalGatewayId, region	LocalBgpAsn, LocalBgpAsnExtended, TagSpecification, DryRun	Create a local gateway virtual interface group.
delete_local_gateway_virtual_interface_group	delete	LocalGatewayVirtualInterfaceGroupId, region	DryRun	Delete the specified local gateway interface group.

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.
LocalGatewayVirtualInterfaceGroupId	string	The ID of the local gateway virtual interface group to delete.
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-virtual-interface-group-id - The ID of the virtual interface group. local-gateway-virtual-interface-id - The ID of the virtual interface. owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface group.
LocalBgpAsn	integer	The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP).
LocalBgpAsnExtended	integer (int64)	The extended 32-bit ASN for the local BGP configuration.
LocalGatewayVirtualInterfaceGroupId	array	The IDs of the virtual interface groups.
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 apply to the local gateway virtual interface group when the resource is being created.

SELECT examples

describe_local_gateway_virtual_interface_groups

Describes the specified local gateway virtual interface groups.

SELECT
configuration_state,
local_bgp_asn,
local_bgp_asn_extended,
local_gateway_id,
local_gateway_virtual_interface_group_arn,
local_gateway_virtual_interface_group_id,
local_gateway_virtual_interface_ids,
owner_id,
tags
FROM aws.ec2.local_gateway_virtual_interface_groups
WHERE region = '{{ region }}' -- required
AND LocalGatewayVirtualInterfaceGroupId = '{{ LocalGatewayVirtualInterfaceGroupId }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND DryRun = '{{ DryRun }}'
;

INSERT examples

create_local_gateway_virtual_interface_group

Create a local gateway virtual interface group.

INSERT INTO aws.ec2.local_gateway_virtual_interface_groups (
LocalGatewayId,
region,
LocalBgpAsn,
LocalBgpAsnExtended,
TagSpecification,
DryRun
)
SELECT 
'{{ LocalGatewayId }}',
'{{ region }}',
'{{ LocalBgpAsn }}',
'{{ LocalBgpAsnExtended }}',
'{{ TagSpecification }}',
'{{ DryRun }}'
RETURNING
configuration_state,
local_bgp_asn,
local_bgp_asn_extended,
local_gateway_id,
local_gateway_virtual_interface_group_arn,
local_gateway_virtual_interface_group_id,
local_gateway_virtual_interface_ids,
owner_id,
tags
;

Manifest

# Description fields are for documentation purposes
- name: local_gateway_virtual_interface_groups
props:
  - name: LocalGatewayId
    value: "{{ LocalGatewayId }}"
    description: Required parameter for the local_gateway_virtual_interface_groups resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the local_gateway_virtual_interface_groups resource.
  - name: LocalBgpAsn
    value: {{ LocalBgpAsn }}
    description: The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP).
    description: The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP).
  - name: LocalBgpAsnExtended
    value: "{{ LocalBgpAsnExtended }}"
    description: The extended 32-bit ASN for the local BGP configuration.
    description: The extended 32-bit ASN for the local BGP configuration.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: The tags to apply to the local gateway virtual interface group when the resource is being created.
    description: The tags to apply to the local gateway virtual interface group when the resource is being created.
  - 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_virtual_interface_group

Delete the specified local gateway interface group.

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