AWS Direct Connect
API Reference (API Version 2012-10-25)

VirtualInterface

Information about a virtual interface.

Contents

addressFamily

The address family for the BGP peer.

Type: String

Valid Values: ipv4 | ipv6

Required: No

amazonAddress

The IP address assigned to the Amazon interface.

Type: String

Required: No

amazonSideAsn

The autonomous system number (ASN) for the Amazon side of the connection.

Type: Long

Required: No

asn

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

Type: Integer

Required: No

authKey

The authentication key for BGP configuration.

Type: String

Required: No

awsDeviceV2

The Direct Connect endpoint on which the virtual interface terminates.

Type: String

Required: No

bgpPeers

The BGP peers configured on this virtual interface.

Type: Array of BGPPeer objects

Required: No

connectionId

The ID of the connection.

Type: String

Required: No

customerAddress

The IP address assigned to the customer interface.

Type: String

Required: No

customerRouterConfig

The customer router configuration.

Type: String

Required: No

directConnectGatewayId

The ID of the Direct Connect gateway.

Type: String

Required: No

jumboFrameCapable

Indicates whether jumbo frames (9001 MTU) are supported.

Type: Boolean

Required: No

location

The location of the connection.

Type: String

Required: No

mtu

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

Type: Integer

Required: No

ownerAccount

The ID of the AWS account that owns the virtual interface.

Type: String

Required: No

region

The AWS Region where the virtual interface is located.

Type: String

Required: No

routeFilterPrefixes

The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

Type: Array of RouteFilterPrefix objects

Required: No

virtualGatewayId

The ID of the virtual private gateway. Applies only to private virtual interfaces.

Type: String

Required: No

virtualInterfaceId

The ID of the virtual interface.

Type: String

Required: No

virtualInterfaceName

The name of the virtual interface assigned by the customer network.

Type: String

Required: No

virtualInterfaceState

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.

Type: String

Valid Values: confirming | verifying | pending | available | down | deleting | deleted | rejected

Required: No

virtualInterfaceType

The type of virtual interface. The possible values are private and public.

Type: String

Required: No

vlan

The ID of the VLAN.

Type: Integer

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: