service_link_virtual_interfaces
Creates, updates, deletes, gets or lists a service_link_virtual_interfaces resource.
Overview
| Name | service_link_virtual_interfaces |
| Type | Resource |
| Id | aws.ec2.service_link_virtual_interfaces |
Fields
The following fields are returned by SELECT queries:
- describe_service_link_virtual_interfaces
| Name | Datatype | Description |
|---|---|---|
configuration_state | string | The current state of the service link virtual interface. |
local_address | string | The IPv4 address assigned to the local gateway virtual interface on the Outpost side. |
outpost_arn | string | The Outpost Amazon Resource Number (ARN) for the service link virtual interface. |
outpost_id | string | The Outpost ID for the service link virtual interface. |
outpost_lag_id | string | The link aggregation group (LAG) ID for the service link virtual interface. |
owner_id | string | The ID of the Amazon Web Services account that owns the service link virtual interface.. |
peer_address | string | The IPv4 peer address for the service link virtual interface. |
peer_bgp_asn | integer | The ASN for the Border Gateway Protocol (BGP) associated with the service link virtual interface. |
service_link_virtual_interface_arn | string | The Amazon Resource Number (ARN) for the service link virtual interface. |
service_link_virtual_interface_id | string | The ID of the service link virtual interface. |
tags | string | The tags associated with the service link virtual interface. |
vlan | integer | The virtual local area network for the service link virtual interface. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_service_link_virtual_interfaces | select | region | ServiceLinkVirtualInterfaceId, Filter, MaxResults, NextToken, DryRun | Describes 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.
| Name | Datatype | Description |
|---|---|---|
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 | The 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. |
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. |
ServiceLinkVirtualInterfaceId | array | The IDs of the service link virtual interfaces. |
SELECT examples
- describe_service_link_virtual_interfaces
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 }}'
;