Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Interface NewPrivateVirtualInterface

Information about a private virtual interface.


  • NewPrivateVirtualInterface


addressFamily?: string

The address family for the BGP peer.

amazonAddress?: string

The IP address assigned to the Amazon interface.

asn: undefined | number

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

The valid values are 1-2147483647.

authKey?: string

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

customerAddress?: string

The IP address assigned to the customer interface.

directConnectGatewayId?: string

The ID of the Direct Connect gateway.

enableSiteLink?: boolean

Indicates whether to enable or disable SiteLink.

mtu?: number

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

tags?: Tag[]

The tags associated with the private virtual interface.

virtualGatewayId?: string

The ID of the virtual private gateway.

virtualInterfaceName: undefined | string

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 (-).

vlan: undefined | number

The ID of the VLAN.