• Public
  • Public/Protected
  • All

Interface NewPrivateVirtualInterface

Information about a private virtual interface.


  • NewPrivateVirtualInterface



Optional addressFamily

addressFamily: AddressFamily | string

The address family for the BGP peer.

Optional amazonAddress

amazonAddress: undefined | string

The IP address assigned to the Amazon interface.


asn: number | undefined

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

The valid values are 1-2147483647.

Optional authKey

authKey: undefined | string

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

Optional customerAddress

customerAddress: undefined | string

The IP address assigned to the customer interface.

Optional directConnectGatewayId

directConnectGatewayId: undefined | string

The ID of the Direct Connect gateway.

Optional enableSiteLink

enableSiteLink: undefined | false | true

Indicates whether to enable or disable SiteLink.

Optional mtu

mtu: undefined | number

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

Optional tags

tags: Tag[]

The tags associated with the private virtual interface.

Optional virtualGatewayId

virtualGatewayId: undefined | string

The ID of the virtual private gateway.


virtualInterfaceName: string | undefined

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: number | undefined

The ID of the VLAN.