CreateDirectConnectGateway
Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways. A Direct Connect gateway is global and visible in any AWS Region after it is created. The virtual interfaces and virtual private gateways that are connected through a Direct Connect gateway can be in different AWS Regions. This enables you to connect to a VPC in any Region, regardless of the Region in which the virtual interfaces are located, and pass traffic between them.
Request Syntax
{
"amazonSideAsn": number,
"directConnectGatewayName": "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.
- amazonSideAsn
-
The autonomous system number (ASN) for Border Gateway Protocol (BGP) to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294. The default is 64512.
Type: Long
Required: No
- directConnectGatewayName
-
The name of the Direct Connect gateway.
Type: String
Required: Yes
Response Syntax
{
"directConnectGateway": {
"amazonSideAsn": number,
"directConnectGatewayId": "string",
"directConnectGatewayName": "string",
"directConnectGatewayState": "string",
"ownerAccount": "string",
"stateChangeError": "string"
}
}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.
- directConnectGateway
-
The Direct Connect gateway.
Type: DirectConnectGateway 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
