NewTransitVirtualInterface - AWS Direct Connect
ContentsSee Also

NewTransitVirtualInterface

Information about a transit virtual interface.

Contents

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.

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

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

  • If you enter a 4-byte ASN for the asn parameter, the API returns an error.

  • If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields.

Type: Integer

Required: No

asnLong

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

Note the following limitations when using asnLong:

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

  • asnLong accepts any valid ASN value, regardless if it's 2-byte or 4-byte.

  • When using a 4-byte asnLong, the API response returns 0 for the legacy asn attribute since 4-byte ASN values exceed the maximum supported value of 2,147,483,647.

  • If you are using a 2-byte ASN, the API response will include the 2-byte value for both the asn and asnLong fields.

  • 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 transitive virtual interface.

Type: Array of Tag objects

Array Members: Minimum number of 1 item.

Required: No

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: No

vlan

The ID of the VLAN.

Type: Integer

Required: No

See Also

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