aws.directconnect.describe_virtual_interfaces

Example SQL Queries

SELECT * FROM
aws.directconnect.describe_virtual_interfaces;

Description

Displays all virtual interfaces for an Amazon Web Services account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned.

A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer network.

• View All Direct Connect Tables
• Boto3 Reference

Table Definition

Column Name	Column Data Type
connection_id Input Column The ID of the connection.	VARCHAR
virtual_interface_id Input Column The ID of the virtual interface.	VARCHAR
_aws_profile Input Column The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.	STRUCT( "type" VARCHAR, "name" VARCHAR, "account_id" VARCHAR, "via_profile_name" VARCHAR, "assumed_role_arn" VARCHAR, "organization" STRUCT( "account_name" VARCHAR, "id" VARCHAR, "tags" STRUCT( "key" VARCHAR, "value" VARCHAR )[], "master_account" STRUCT( "id" VARCHAR, "email" VARCHAR ), "parents" STRUCT( "type" VARCHAR, "id" VARCHAR, "name" VARCHAR, "tags" STRUCT( "key" VARCHAR, "value" VARCHAR )[] )[] ) )
Show child fields _aws_profile.account_id The AWS account id _aws_profile.assumed_role_arn The ARN of the assumed role _aws_profile.name The unique name of the profile. _aws_profile.organization Information about this profile's membership in the AWS organization. Show child fields _aws_profile.organization.account_name The name of account speciifed by the organization _aws_profile.organization.id The organization id _aws_profile.organization.master_account Show child fields _aws_profile.organization.master_account.email The organization master account email address _aws_profile.organization.master_account.id The organization master account id _aws_profile.organization.parents[] Show child fields _aws_profile.organization.parents[].id The id of the parent _aws_profile.organization.parents[].name The name of the parent _aws_profile.organization.parents[].tags[] Show child fields _aws_profile.organization.parents[].tags[].key _aws_profile.organization.parents[].tags[].value _aws_profile.organization.parents[].type The type of parent can be an organization unit or a root _aws_profile.organization.tags[] Show child fields _aws_profile.organization.tags[].key _aws_profile.organization.tags[].value _aws_profile.type The type of profile, either 'credentials' or 'assumed_role' _aws_profile.via_profile_name This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
_aws_region Input Column The AWS region to use.	VARCHAR
virtual_interfaces The virtual interfaces	STRUCT( "owner_account" VARCHAR, "virtual_interface_id" VARCHAR, "location" VARCHAR, "connection_id" VARCHAR, "virtual_interface_type" VARCHAR, "virtual_interface_name" VARCHAR, "vlan" BIGINT, "asn" BIGINT, "amazon_side_asn" BIGINT, "auth_key" VARCHAR, "amazon_address" VARCHAR, "customer_address" VARCHAR, "address_family" VARCHAR, "virtual_interface_state" VARCHAR, "customer_router_config" VARCHAR, "mtu" BIGINT, "jumbo_frame_capable" BOOLEAN, "virtual_gateway_id" VARCHAR, "direct_connect_gateway_id" VARCHAR, "route_filter_prefixes" STRUCT( "cidr" VARCHAR )[], "bgp_peers" STRUCT( "bgp_peer_id" VARCHAR, "asn" BIGINT, "auth_key" VARCHAR, "address_family" VARCHAR, "amazon_address" VARCHAR, "customer_address" VARCHAR, "bgp_peer_state" VARCHAR, "bgp_status" VARCHAR, "aws_device_v2" VARCHAR, "aws_logical_device_id" VARCHAR )[], "region" VARCHAR, "aws_device_v2" VARCHAR, "aws_logical_device_id" VARCHAR, "tags" STRUCT( "key" VARCHAR, "value" VARCHAR )[], "site_link_enabled" BOOLEAN )[]
Show child fields virtual_interfaces[] Show child fields virtual_interfaces[].address_family The address family for the BGP peer. virtual_interfaces[].amazon_address The IP address assigned to the Amazon interface. virtual_interfaces[].amazon_side_asn The autonomous system number (ASN) for the Amazon side of the connection. virtual_interfaces[].asn The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. The valid values are 1-2147483647. virtual_interfaces[].auth_key The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters. virtual_interfaces[].aws_device_v2 The Direct Connect endpoint that terminates the physical connection. virtual_interfaces[].aws_logical_device_id The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection. virtual_interfaces[].bgp_peers[] Show child fields virtual_interfaces[].bgp_peers[].address_family The address family for the BGP peer. virtual_interfaces[].bgp_peers[].amazon_address The IP address assigned to the Amazon interface. virtual_interfaces[].bgp_peers[].asn The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. virtual_interfaces[].bgp_peers[].auth_key The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters. virtual_interfaces[].bgp_peers[].aws_device_v2 The Direct Connect endpoint that terminates the BGP peer. virtual_interfaces[].bgp_peers[].aws_logical_device_id The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection. virtual_interfaces[].bgp_peers[].bgp_peer_id The ID of the BGP peer. virtual_interfaces[].bgp_peers[].bgp_peer_state The state of the BGP peer. The following are the possible values: verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces. pending: The BGP peer is created, and remains in this state until it is ready to be established. available: The BGP peer is ready to be established. deleting: The BGP peer is being deleted. deleted: The BGP peer is deleted and cannot be established. virtual_interfaces[].bgp_peers[].bgp_status The status of the BGP peer. The following are the possible values: up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session. down: The BGP peer is down. unknown: The BGP peer status is not available. virtual_interfaces[].bgp_peers[].customer_address The IP address assigned to the customer interface. virtual_interfaces[].connection_id The ID of the connection. virtual_interfaces[].customer_address The IP address assigned to the customer interface. virtual_interfaces[].customer_router_config The customer router configuration. virtual_interfaces[].direct_connect_gateway_id The ID of the Direct Connect gateway. virtual_interfaces[].jumbo_frame_capable Indicates whether jumbo frames are supported. virtual_interfaces[].location The location of the connection. virtual_interfaces[].mtu The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500 virtual_interfaces[].owner_account The ID of the Amazon Web Services account that owns the virtual interface. virtual_interfaces[].region The Amazon Web Services Region where the virtual interface is located. virtual_interfaces[].route_filter_prefixes[] Show child fields virtual_interfaces[].route_filter_prefixes[].cidr The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter. virtual_interfaces[].site_link_enabled Indicates whether SiteLink is enabled. virtual_interfaces[].tags[] Show child fields virtual_interfaces[].tags[].key The key. virtual_interfaces[].tags[].value The value. virtual_interfaces[].virtual_gateway_id The ID of the virtual private gateway. Applies only to private virtual interfaces. virtual_interfaces[].virtual_interface_id The ID of the virtual interface. virtual_interfaces[].virtual_interface_name The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-). virtual_interfaces[].virtual_interface_state The state of the virtual interface. The following are the possible values: confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner. verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created. pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic. available: A virtual interface that is able to forward traffic. down: A virtual interface that is BGP down. deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic. deleted: A virtual interface that cannot forward traffic. rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state. unknown: The state of the virtual interface is not available. virtual_interfaces[].virtual_interface_type The type of virtual interface. The possible values are private, public and transit. virtual_interfaces[].vlan The ID of the VLAN.

Note

Tables may require input columns to have values specified before the table can return it’s rows. The values for input parameters are set in the where clause of the query typically using = or IN.