AWS Direct Connect
API Reference (API Version 2012-10-25)

CreateDirectConnectGatewayAssociation

Creates an association between a Direct Connect gateway and a virtual private gateway. The virtual private gateway must be attached to a VPC and must not be associated with another Direct Connect gateway.

Request Syntax

{ "addAllowedPrefixesToDirectConnectGateway": [ { "cidr": "string" } ], "directConnectGatewayId": "string", "gatewayId": "string", "virtualGatewayId": "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.

addAllowedPrefixesToDirectConnectGateway

The Amazon VPC prefixes to advertise to the Direct Connect gateway

This parameter is required when you create an association to a transit gateway.

For information about how to set the prefixes, see Allowed Prefixes in the AWS Direct Connect User Guide.

Type: Array of RouteFilterPrefix objects

Required: No

directConnectGatewayId

The ID of the Direct Connect gateway.

Type: String

Required: Yes

gatewayId

The ID of the virtual private gateway or transit gateway.

Type: String

Required: No

virtualGatewayId

This parameter has been deprecated.

The ID of the virtual private gateway.

Type: String

Required: No

Response Syntax

{ "directConnectGatewayAssociation": { "allowedPrefixesToDirectConnectGateway": [ { "cidr": "string" } ], "associatedGateway": { "id": "string", "ownerAccount": "string", "region": "string", "type": "string" }, "associationId": "string", "associationState": "string", "directConnectGatewayId": "string", "directConnectGatewayOwnerAccount": "string", "stateChangeError": "string", "virtualGatewayId": "string", "virtualGatewayOwnerAccount": "string", "virtualGatewayRegion": "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.

directConnectGatewayAssociation

The association to be created.

Type: DirectConnectGatewayAssociation 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: