Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

UpdateCluster - Amazon Aurora DSQL

UpdateCluster

Updates a cluster.

Request Syntax

POST /cluster/identifier HTTP/1.1 Content-type: application/json { "clientToken": "string", "deletionProtectionEnabled": boolean }

URI Request Parameters

The request uses the following URI parameters.

identifier

The ID of the cluster you want to update.

Required: Yes

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

Specifies whether to enable deletion protection in your cluster.

Type: Boolean

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "arn": "string", "creationTime": number, "deletionProtectionEnabled": boolean, "identifier": "string", "linkedClusterArns": [ "string" ], "status": "string", "witnessRegion": "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 updated cluster.

Type: String

creationTime

The time of when the cluster was created.

Type: Timestamp

deletionProtectionEnabled

Whether deletion protection is enabled for the updated cluster.

Type: Boolean

identifier

The ID of the cluster to update.

Type: String

linkedClusterArns

The ARNs of the clusters linked to the updated cluster. Applicable only for multi-Region clusters.

Type: Array of strings

status

The status of the updated cluster.

Type: String

Valid Values: CREATING | ACTIVE | UPDATING | DELETING | DELETED | FAILED

witnessRegion

The Region that receives all data you write to linked clusters.

Type: String

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

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

ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 404

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:

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.