Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1463248219.5 KB

Provisions a private virtual interface to be owned by the specified Amazon Web Services account.

Virtual interfaces created using this action must be confirmed by the owner using ConfirmPrivateVirtualInterface. Until then, the virtual interface is in the Confirming state and is not available to handle traffic.

post/#X-Amz-Target=OvertureService.AllocatePrivateVirtualInterface

Headers

X-Amz-Target'OvertureService.AllocatePrivateVirtualInterface' required

Request body

connectionIdstring required

The ID of the connection on which the private virtual interface is provisioned.

ownerAccountstring required

The ID of the Amazon Web Services account that owns the virtual private interface.

Response

Success

ownerAccountstring

The ID of the Amazon Web Services account that owns the virtual interface.

virtualInterfaceIdstring

The ID of the virtual interface.

locationstring

The location of the connection.

connectionIdstring

The ID of the connection.

virtualInterfaceTypestring

The type of virtual interface. The possible values are <code>private</code> and <code>public</code>.

virtualInterfaceNamestring

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

vlaninteger

The ID of the VLAN.

asninteger
<p>The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.</p> <p>The valid values are 1-2147483647.</p>
amazonSideAsninteger

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

authKeystring

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

amazonAddressstring

The IP address assigned to the Amazon interface.

customerAddressstring

The IP address assigned to the customer interface.

addressFamily'ipv4' | 'ipv6'

The address family for the BGP peer.

virtualInterfaceState'confirming' | 'verifying' | 'pending' | 'available' | 'down' | 'deleting' | 'deleted' | 'rejected' | 'unknown'
<p>The state of the virtual interface. The following are the possible values:</p> <ul> <li> <p> <code>confirming</code>: 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.</p> </li> <li> <p> <code>verifying</code>: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.</p> </li> <li> <p> <code>pending</code>: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.</p> </li> <li> <p> <code>available</code>: A virtual interface that is able to forward traffic.</p> </li> <li> <p> <code>down</code>: A virtual interface that is BGP down.</p> </li> <li> <p> <code>deleting</code>: A virtual interface is in this state immediately after calling <a>DeleteVirtualInterface</a> until it can no longer forward traffic.</p> </li> <li> <p> <code>deleted</code>: A virtual interface that cannot forward traffic.</p> </li> <li> <p> <code>rejected</code>: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the <code>Confirming</code> state is deleted by the virtual interface owner, the virtual interface enters the <code>Rejected</code> state.</p> </li> <li> <p> <code>unknown</code>: The state of the virtual interface is not available.</p> </li> </ul>
customerRouterConfigstring

The customer router configuration.

mtuinteger

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

jumboFrameCapableboolean

Indicates whether jumbo frames (9001 MTU) are supported.

virtualGatewayIdstring

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

directConnectGatewayIdstring

The ID of the Direct Connect gateway.

regionstring

The Amazon Web Services Region where the virtual interface is located.

awsDeviceV2string

The Direct Connect endpoint that terminates the physical connection.

awsLogicalDeviceIdstring

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

siteLinkEnabledboolean

Indicates whether SiteLink is enabled.