CreateCluster
Creates a cluster in Amazon Aurora DSQL.
Request Syntax
POST /cluster HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"deletionProtectionEnabled": boolean,
"tags": {
"string" : "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
- deletionProtectionEnabled
-
If enabled, you can't delete your cluster. You must first disable this property before you can delete your cluster.
Type: Boolean
Required: No
-
A map of key and value pairs to use to tag your cluster.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 200 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
[a-zA-Z0-9_.:/=+\-@ ]*Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern:
[a-zA-Z0-9_.:/=+\-@ ]*Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"creationTime": number,
"deletionProtectionEnabled": boolean,
"identifier": "string",
"status": "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.
- arn
-
The ARN of the created cluster.
Type: String
- creationTime
-
The time of when created the cluster.
Type: Timestamp
- deletionProtectionEnabled
-
Whether deletion protection is enabled on this cluster.
Type: Boolean
- identifier
-
The ID of the created cluster.
Type: String
- status
-
The status of the created cluster.
Type: String
Valid Values:
CREATING | ACTIVE | UPDATING | DELETING | DELETED | FAILED
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
