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.

Hierarchy

  • NewPrivateVirtualInterface

Properties

addressFamily? amazonAddress? asn authKey? customerAddress? directConnectGatewayId? enableSiteLink? mtu? tags? virtualGatewayId? virtualInterfaceName vlan

Properties

Optional addressFamily

addressFamily?: string

The address family for the BGP peer.

Optional amazonAddress

amazonAddress?: string

The IP address assigned to the Amazon interface.

asn

asn: undefined | number

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

The valid values are 1-2147483647.

Optional authKey

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.

Optional customerAddress

customerAddress?: string

The IP address assigned to the customer interface.

Optional directConnectGatewayId

directConnectGatewayId?: string

The ID of the Direct Connect gateway.

Optional enableSiteLink

enableSiteLink?: boolean

Indicates whether to enable or disable SiteLink.

Optional mtu

mtu?: 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?: string

The ID of the virtual private gateway.

virtualInterfaceName

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

vlan: undefined | number

The ID of the VLAN.

Settings

Member Visibility

Theme