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

VirtualInterface

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

Contents

addressFamily

Indicates the address family for the BGP peer.

  • ipv4: IPv4 address family

  • ipv6: IPv6 address family

Type: String

Valid Values: ipv4 | ipv6

Required: No

amazonAddress

IP address assigned to the Amazon interface.

Example: 192.168.1.1/30 or 2001:db8::1/125

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.

Example: 65000

Type: Integer

Required: No

authKey

The authentication key for BGP configuration.

Example: asdf34example

Type: String

Required: No

bgpPeers

A list of the BGP peers configured on this virtual interface.

Type: Array of BGPPeer objects

Required: No

connectionId

The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

Example: dxcon-fg5678gh

Default: None

Type: String

Required: No

customerAddress

IP address assigned to the customer interface.

Example: 192.168.1.2/30 or 2001:db8::2/125

Type: String

Required: No

customerRouterConfig

Information for generating the customer router configuration.

Type: String

Required: No

directConnectGatewayId

The ID of the direct connect gateway.

Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

Type: String

Required: No

location

Where the connection is located.

Example: EqSV5

Default: None

Type: String

Required: No

ownerAccount

The AWS account that will own the new virtual interface.

Type: String

Required: No

routeFilterPrefixes

A list of routes to be advertised to the AWS network in this region (public virtual interface).

Type: Array of RouteFilterPrefix objects

Required: No

virtualGatewayId

The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

Example: vgw-123er56

Type: String

Required: No

virtualInterfaceId

The ID of the virtual interface.

Example: dxvif-123dfg56

Default: None

Type: String

Required: No

virtualInterfaceName

The name of the virtual interface assigned by the customer.

Example: "My VPC"

Type: String

Required: No

virtualInterfaceState

State of the virtual interface.

  • 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 will enter the 'Rejected' state.

Type: String

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

Required: No

virtualInterfaceType

The type of virtual interface.

Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

Type: String

Required: No

vlan

The VLAN ID.

Example: 101

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: