NewPrivateVirtualInterface - Amazon Direct Connect
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

NewPrivateVirtualInterface

Information about a private virtual interface.

Contents

virtualInterfaceName

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

Type: String

Required: Yes

vlan

The ID of the VLAN.

Type: Integer

Required: Yes

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

asn

The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.

Note

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.

  • The asnLong attribute accepts both ASN and long ASN ranges.

  • If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.

The valid values are 1-2147483646.

Type: Integer

Required: No

asnLong

The long ASN for a new private virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.

Note

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.

  • The asnLong attribute accepts both ASN and long ASN ranges.

  • If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.

Type: Long

Required: No

authKey

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

Type: String

Required: No

customerAddress

The IP address assigned to the customer interface.

Type: String

Required: No

directConnectGatewayId

The ID of the Direct Connect gateway.

Type: String

Required: No

Indicates whether to enable or disable SiteLink.

Type: Boolean

Required: No

mtu

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

Type: Integer

Required: No

tags

The tags associated with the private virtual interface.

Type: Array of Tag objects

Array Members: Minimum number of 1 item.

Required: No

virtualGatewayId

The ID of the virtual private gateway.

Type: String

Required: No

See Also

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