CreateTransitVirtualInterface
Creates a transit virtual interface. A transit virtual interface should be used to access one or more transit gateways associated with Direct Connect gateways. A transit virtual interface enables the connection of multiple VPCs attached to a transit gateway to a Direct Connect gateway.
Important
If you associate your transit gateway with one or more Direct Connect gateways, the Autonomous System Number (ASN) used by the transit gateway and the Direct Connect gateway must be different. For example, if you use the default ASN 64512 for both your the transit gateway and Direct Connect gateway, the association request fails.
A jumbo MTU value must be either 1500 or 8500. No other values will be accepted. Setting the MTU of a virtual interface to 8500 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces.
Request Syntax
{
"connectionId": "string",
"newTransitVirtualInterface": {
"addressFamily": "string",
"amazonAddress": "string",
"asn": number,
"authKey": "string",
"customerAddress": "string",
"directConnectGatewayId": "string",
"enableSiteLink": boolean,
"mtu": number,
"tags": [
{
"key": "string",
"value": "string"
}
],
"virtualInterfaceName": "string",
"vlan": number
}
}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.
Type: String
Required: Yes
- newTransitVirtualInterface
-
Information about the transit virtual interface.
Type: NewTransitVirtualInterface object
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 a 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:
