Skip to main content

service_link_virtual_interfaces

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

Overview

Nameservice_link_virtual_interfaces
TypeResource
Idaws.ec2.service_link_virtual_interfaces

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
configuration_statestringThe current state of the service link virtual interface.
local_addressstringThe IPv4 address assigned to the local gateway virtual interface on the Outpost side.
outpost_arnstringThe Outpost Amazon Resource Number (ARN) for the service link virtual interface.
outpost_idstringThe Outpost ID for the service link virtual interface.
outpost_lag_idstringThe link aggregation group (LAG) ID for the service link virtual interface.
owner_idstringThe ID of the Amazon Web Services account that owns the service link virtual interface..
peer_addressstringThe IPv4 peer address for the service link virtual interface.
peer_bgp_asnintegerThe ASN for the Border Gateway Protocol (BGP) associated with the service link virtual interface.
service_link_virtual_interface_arnstringThe Amazon Resource Number (ARN) for the service link virtual interface.
service_link_virtual_interface_idstringThe ID of the service link virtual interface.
tagsstringThe tags associated with the service link virtual interface.
vlanintegerThe virtual local area network for the service link virtual interface.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_service_link_virtual_interfacesselectregionServiceLinkVirtualInterfaceId, Filter, MaxResults, NextToken, DryRunDescribes the Outpost service link virtual interfaces.

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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)
DryRunbooleanChecks 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.
FilterarrayThe filters to use for narrowing down the request. The following filters are supported: outpost-lag-id - The ID of the Outpost LAG. outpost-arn - The Outpost ARN. owner-id - The ID of the Amazon Web Services account that owns the service link virtual interface. state - The state of the Outpost LAG. vlan - The ID of the address pool. service-link-virtual-interface-id - The ID of the service link virtual interface. local-gateway-virtual-interface-id - The ID of the local gateway virtual interface.
MaxResultsintegerThe maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
NextTokenstringThe token for the next page of results.
ServiceLinkVirtualInterfaceIdarrayThe IDs of the service link virtual interfaces.

SELECT examples

Describes the Outpost service link virtual interfaces.

SELECT
configuration_state,
local_address,
outpost_arn,
outpost_id,
outpost_lag_id,
owner_id,
peer_address,
peer_bgp_asn,
service_link_virtual_interface_arn,
service_link_virtual_interface_id,
tags,
vlan
FROM aws.ec2.service_link_virtual_interfaces
WHERE region = '{{ region }}' -- required
AND ServiceLinkVirtualInterfaceId = '{{ ServiceLinkVirtualInterfaceId }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND DryRun = '{{ DryRun }}'
;