Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateMultiRegionClusters

Creates multi-Region clusters in Amazon Aurora DSQL. Multi-Region clusters require a linked Region list, which is an array of the Regions in which you want to create linked clusters. Multi-Region clusters require a witness Region, which participates in quorum in failure scenarios.

Request Syntax


POST /multi-region-clusters HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "clusterProperties": { 
      "string" : { 
         "deletionProtectionEnabled": boolean,
         "tags": { 
            "string" : "string" 
         }
      }
   },
   "linkedRegionList": [ "string" ],
   "witnessRegion": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

If you don't specify a client token, the AWS SDK automatically generates one.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [!-~]+

Required: No

clusterProperties

A mapping of properties to use when creating linked clusters.

Type: String to LinkedClusterProperties object map

Key Length Constraints: Minimum length of 0. Maximum length of 20.

Required: No

linkedRegionList

An array of the Regions in which you want to create additional clusters.

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 20.

Required: Yes

witnessRegion

The witness Region of multi-Region clusters.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 20.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "linkedClusterArns": [ "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.

linkedClusterArns

An array that contains the ARNs of all linked clusters.

Type: Array of strings

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The submitted action has conflicts.

HTTP Status Code: 409

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ServiceQuotaExceededException

The service limit was exceeded.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input failed to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400