AllocateTransitVirtualInterface
Provisions a transit virtual interface to be owned by the specified AWS account. Use this type of interface to connect a transit gateway to your Direct Connect gateway.
The owner of a connection provisions a transit virtual interface to be owned by the specified AWS account.
After you create a transit virtual interface, it must be confirmed by the owner using ConfirmTransitVirtualInterface. Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traffic.
Request Syntax
{
"connectionId": "string",
"newTransitVirtualInterfaceAllocation": {
"addressFamily": "string",
"amazonAddress": "string",
"asn": number,
"authKey": "string",
"customerAddress": "string",
"mtu": number,
"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 transit virtual interface is provisioned.
Type: String
Required: Yes
- newTransitVirtualInterfaceAllocation
-
Information about the transit virtual interface.
Type: NewTransitVirtualInterfaceAllocation object
Required: Yes
- ownerAccount
-
The ID of the AWS account that owns the transit virtual interface.
Type: String
Required: Yes
Response Syntax
{
"virtualInterface": {
"addressFamily": "string",
"amazonAddress": "string",
"amazonSideAsn": number,
"asn": number,
"authKey": "string",
"awsDeviceV2": "string",
"awsLogicalDeviceId": "string",
"bgpPeers": [
{
"addressFamily": "string",
"amazonAddress": "string",
"asn": 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",
"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.
- virtualInterface
-
Information about the transit virtual interface.
Type: VirtualInterface object
Errors
For information about the errors that are common to all actions, see Common Errors.
- DirectConnectClientException
-
One or more parameters are not valid.
HTTP Status Code: 400
- DirectConnectServerException
-
A server-side error occurred.
HTTP Status Code: 400
- DuplicateTagKeysException
-
A tag key was specified more than once.
HTTP Status Code: 400
- TooManyTagsException
-
You have reached the limit on the number of tags that can be assigned.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
