VirtualInterface

Information about a virtual interface.

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

amazonSideAsn

The autonomous system number (AS) for the Amazon side of the connection.

Type: Long

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 the 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

awsDeviceV2

The Direct Connect endpoint that terminates the physical connection.

Type: String

Required: No

awsLogicalDeviceId

The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

Type: String

Required: No

bgpPeers

The BGP peers configured on this virtual interface.

Type: Array of BGPPeer objects

Required: No

connectionId

The ID of the connection.

Type: String

Required: No

customerAddress

The IP address assigned to the customer interface.

Type: String

Required: No

customerRouterConfig

The customer router configuration.

Type: String

Required: No

directConnectGatewayId

The ID of the Direct Connect gateway.

Type: String

Required: No

jumboFrameCapable

Indicates whether jumbo frames are supported.

Type: Boolean

Required: No

location

The location of the connection.

Type: String

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

ownerAccount

The ID of the AWS account that owns the virtual interface.

Type: String

Required: No

region

The AWS Region where the virtual interface is located.

Type: String

Required: No

routeFilterPrefixes

The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

Type: Array of RouteFilterPrefix objects

Required: No

siteLinkEnabled

Indicates whether SiteLink is enabled.

Type: Boolean

Required: No

tags

The tags associated with the virtual interface.

Type: Array of Tag objects

Array Members: Minimum number of 1 item.

Required: No

virtualGatewayId

The ID of the virtual private gateway. Applies only to private virtual interfaces.

Type: String

Required: No

virtualInterfaceId

The ID of the virtual interface.

Type: String

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

virtualInterfaceState

The state of the virtual interface. The following are the possible values:

confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
available: A virtual interface that is able to forward traffic.
down: A virtual interface that is BGP down.
testing: A virtual interface is in this state immediately after calling StartBgpFailoverTest and remains in this state during the duration of the test.
deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
deleted: A virtual interface that cannot forward traffic.
rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.
unknown: The state of the virtual interface is not available.

Type: String

Required: No

virtualInterfaceType

The type of virtual interface. The possible values are private, public and transit.

Type: String

Required: No

vlan

The ID of the VLAN.

Type: Integer

Required: No

VirtualInterface

Contents

See Also