local_gateway_virtual_interfaces

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

Overview

Name	local_gateway_virtual_interfaces
Type	Resource
Id	aws.ec2.local_gateway_virtual_interfaces

Fields

The following fields are returned by SELECT queries:

describe_local_gateway_virtual_interfaces

Name	Datatype	Description
configuration_state	string	The current state of the local gateway virtual interface.
local_address	string	The local address.
local_bgp_asn	integer	The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
local_gateway_id	string	The ID of the local gateway.
local_gateway_virtual_interface_arn	string	The Amazon Resource Number (ARN) of the local gateway virtual interface.
local_gateway_virtual_interface_group_id	string	The ID of the local gateway virtual interface group.
local_gateway_virtual_interface_id	string	The ID of the virtual interface.
outpost_lag_id	string	The Outpost LAG ID.
owner_id	string	The ID of the Amazon Web Services account that owns the local gateway virtual interface.
peer_address	string	The peer address.
peer_bgp_asn	integer	The peer BGP ASN.
peer_bgp_asn_extended	integer	The extended 32-bit ASN of the BGP peer for use with larger ASN values.
tags	string	The tags assigned to the virtual interface.
vlan	integer	The ID of the VLAN.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_local_gateway_virtual_interfaces	select	region	LocalGatewayVirtualInterfaceId, Filter, MaxResults, NextToken, DryRun	Describes the specified local gateway virtual interfaces.
create_local_gateway_virtual_interface	insert	LocalGatewayVirtualInterfaceGroupId, OutpostLagId, LocalAddress, PeerAddress, region	Vlan, PeerBgpAsn, TagSpecification, DryRun, PeerBgpAsnExtended	Create a virtual interface for a local gateway.
delete_local_gateway_virtual_interface	delete	LocalGatewayVirtualInterfaceId, region	DryRun	Deletes the specified local gateway virtual interface.

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
LocalAddress	string	The IP address assigned to the local gateway virtual interface on the Outpost side. Only IPv4 is supported.
LocalGatewayVirtualInterfaceGroupId	string	The ID of the local gateway virtual interface group.
LocalGatewayVirtualInterfaceId	string	The ID of the local virtual interface to delete.
OutpostLagId	string	References the Link Aggregation Group (LAG) that connects the Outpost to on-premises network devices.
PeerAddress	string	The peer IP address for the local gateway virtual interface. Only IPv4 is supported.
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-address - The local address. local-bgp-asn - The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway. local-gateway-id - The ID of the local gateway. 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. peer-address - The peer address. peer-bgp-asn - The peer BGP ASN. vlan - The ID of the VLAN.
LocalGatewayVirtualInterfaceId	array	The IDs of the virtual interfaces.
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.
PeerBgpAsn	integer	The Autonomous System Number (ASN) of the Border Gateway Protocol (BGP) peer.
PeerBgpAsnExtended	integer (int64)	The extended 32-bit ASN of the BGP peer for use with larger ASN values.
TagSpecification	array	The tags to apply to a resource when the local gateway virtual interface is being created.
Vlan	integer	The virtual local area network (VLAN) used for the local gateway virtual interface.

SELECT examples

describe_local_gateway_virtual_interfaces

Describes the specified local gateway virtual interfaces.

SELECT
configuration_state,
local_address,
local_bgp_asn,
local_gateway_id,
local_gateway_virtual_interface_arn,
local_gateway_virtual_interface_group_id,
local_gateway_virtual_interface_id,
outpost_lag_id,
owner_id,
peer_address,
peer_bgp_asn,
peer_bgp_asn_extended,
tags,
vlan
FROM aws.ec2.local_gateway_virtual_interfaces
WHERE region = '{{ region }}' -- required
AND LocalGatewayVirtualInterfaceId = '{{ LocalGatewayVirtualInterfaceId }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND DryRun = '{{ DryRun }}'
;

INSERT examples

create_local_gateway_virtual_interface

Create a virtual interface for a local gateway.

INSERT INTO aws.ec2.local_gateway_virtual_interfaces (
LocalGatewayVirtualInterfaceGroupId,
OutpostLagId,
LocalAddress,
PeerAddress,
region,
Vlan,
PeerBgpAsn,
TagSpecification,
DryRun,
PeerBgpAsnExtended
)
SELECT 
'{{ LocalGatewayVirtualInterfaceGroupId }}',
'{{ OutpostLagId }}',
'{{ LocalAddress }}',
'{{ PeerAddress }}',
'{{ region }}',
'{{ Vlan }}',
'{{ PeerBgpAsn }}',
'{{ TagSpecification }}',
'{{ DryRun }}',
'{{ PeerBgpAsnExtended }}'
RETURNING
configuration_state,
local_address,
local_bgp_asn,
local_gateway_id,
local_gateway_virtual_interface_arn,
local_gateway_virtual_interface_group_id,
local_gateway_virtual_interface_id,
outpost_lag_id,
owner_id,
peer_address,
peer_bgp_asn,
peer_bgp_asn_extended,
tags,
vlan
;

Manifest

# Description fields are for documentation purposes
- name: local_gateway_virtual_interfaces
props:
  - name: LocalGatewayVirtualInterfaceGroupId
    value: "{{ LocalGatewayVirtualInterfaceGroupId }}"
    description: Required parameter for the local_gateway_virtual_interfaces resource.
  - name: OutpostLagId
    value: "{{ OutpostLagId }}"
    description: Required parameter for the local_gateway_virtual_interfaces resource.
  - name: LocalAddress
    value: "{{ LocalAddress }}"
    description: Required parameter for the local_gateway_virtual_interfaces resource.
  - name: PeerAddress
    value: "{{ PeerAddress }}"
    description: Required parameter for the local_gateway_virtual_interfaces resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the local_gateway_virtual_interfaces resource.
  - name: Vlan
    value: {{ Vlan }}
    description: The virtual local area network (VLAN) used for the local gateway virtual interface.
    description: The virtual local area network (VLAN) used for the local gateway virtual interface.
  - name: PeerBgpAsn
    value: {{ PeerBgpAsn }}
    description: The Autonomous System Number (ASN) of the Border Gateway Protocol (BGP) peer.
    description: The Autonomous System Number (ASN) of the Border Gateway Protocol (BGP) peer.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: The tags to apply to a resource when the local gateway virtual interface is being created.
    description: The tags to apply to a resource when the local gateway virtual interface 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.
  - name: PeerBgpAsnExtended
    value: "{{ PeerBgpAsnExtended }}"
    description: The extended 32-bit ASN of the BGP peer for use with larger ASN values.
    description: The extended 32-bit ASN of the BGP peer for use with larger ASN values.

DELETE examples

delete_local_gateway_virtual_interface

Deletes the specified local gateway virtual interface.

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