Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

AllocatePrivateVirtualInterface

Provisions a private virtual interface to be owned by the specified AWS 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.

Request Syntax


{
   "connectionId": "string",
   "newPrivateVirtualInterfaceAllocation": { 
      "addressFamily": "string",
      "amazonAddress": "string",
      "asn": number,
      "asnLong": number,
      "authKey": "string",
      "customerAddress": "string",
      "mtu": number,
      "rateLimit": "string",
      "tags": [ 
         { 
            "key": "string",
            "value": "string"
         }
      ],
      "virtualInterfaceName": "string",
      "vlan": number
   },
   "ownerAccount": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

connectionId

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

Type: String

Required: Yes

newPrivateVirtualInterfaceAllocation

Information about the private virtual interface.

Type: NewPrivateVirtualInterfaceAllocation object

Required: Yes

ownerAccount

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

Type: String

Required: Yes

Response Syntax


{
   "addressFamily": "string",
   "amazonAddress": "string",
   "amazonSideAsn": number,
   "asn": number,
   "asnLong": number,
   "authKey": "string",
   "awsDeviceV2": "string",
   "awsLogicalDeviceId": "string",
   "bgpPeers": [ 
      { 
         "addressFamily": "string",
         "amazonAddress": "string",
         "asn": number,
         "asnLong": number,
         "authKey": "string",
         "awsDeviceV2": "string",
         "awsLogicalDeviceId": "string",
         "bgpPeerId": "string",
         "bgpPeerState": "string",
         "bgpStatus": "string",
         "customerAddress": "string"
      }
   ],
   "connectionId": "string",
   "customerAddress": "string",
   "customerRouterConfig": "string",
   "directConnectGatewayId": "string",
   "jumboFrameCapable": boolean,
   "location": "string",
   "mtu": number,
   "ownerAccount": "string",
   "prefixPoolAllocatedCountIpv4": number,
   "prefixPoolAllocatedCountIpv6": number,
   "rateLimit": "string",
   "region": "string",
   "routeFilterPrefixes": [ 
      { 
         "cidr": "string"
      }
   ],
   "siteLinkEnabled": boolean,
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "virtualGatewayId": "string",
   "virtualInterfaceId": "string",
   "virtualInterfaceName": "string",
   "virtualInterfaceState": "string",
   "virtualInterfaceType": "string",
   "vlan": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

addressFamily

The address family for the BGP peer.

Type: String

Valid Values: ipv4 | ipv6

amazonAddress

The IP address assigned to the Amazon interface.

Type: String

amazonSideAsn

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

Type: Long

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

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

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

awsDeviceV2

The Direct Connect endpoint that terminates the physical connection.

Type: String

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

bgpPeers

The BGP peers configured on this virtual interface.

Type: Array of BGPPeer objects

connectionId

The ID of the connection.

Type: String

customerAddress

The IP address assigned to the customer interface.

Type: String

customerRouterConfig

The customer router configuration.

Type: String

directConnectGatewayId

The ID of the Direct Connect gateway.

Type: String

jumboFrameCapable

Indicates whether jumbo frames are supported.

Type: Boolean

location

The location of the connection.

Type: String

mtu

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

Type: Integer

ownerAccount

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

Type: String

prefixPoolAllocatedCountIpv4

The number of inbound IPv4 route prefixes allocated to the virtual interface. Not applicable to public virtual interfaces.

Type: Integer

Valid Range: Minimum value of 0.

prefixPoolAllocatedCountIpv6

The number of inbound IPv6 route prefixes allocated to the virtual interface. Not applicable to public virtual interfaces.

Type: Integer

Valid Range: Minimum value of 0.

rateLimit

The rate limit (bandwidth allocation) applied to the virtual interface. The value must be one of the supported bandwidth values and cannot exceed the bandwidth of the parent connection or LAG. Supported values: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 600Mbps, 700Mbps, 800Mbps, 900Mbps, 1Gbps, 1.2Gbps, 1.5Gbps, 1.8Gbps, 2Gbps, 2.1Gbps, 2.4Gbps, 2.7Gbps, 3Gbps, 3.2Gbps, 3.6Gbps, 4Gbps, 5Gbps, 6Gbps, 7Gbps, 8Gbps, 9Gbps, 10Gbps, 12Gbps, 15Gbps, 18Gbps, 20Gbps, 21Gbps, 24Gbps, 27Gbps, 30Gbps, 32Gbps, 36Gbps, 40Gbps, 50Gbps, 60Gbps, 70Gbps, 80Gbps, 100Gbps, 120Gbps, 150Gbps, 180Gbps, 200Gbps, 210Gbps, 240Gbps, 270Gbps, 300Gbps, 320Gbps, 360Gbps, 400Gbps, 450Gbps, 480Gbps, 500Gbps, 540Gbps, 600Gbps, 700Gbps, 800Gbps, 900Gbps, 1Tbps, 1.1Tbps, 1.2Tbps, 1.3Tbps, 1.4Tbps, 1.5Tbps, 1.6Tbps.