v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14168671.3 KB

The UpdateCluster API allows you to modify both single-Region and multi-Region cluster configurations. With the multiRegionProperties parameter, you can add or modify witness Region support and manage peer relationships with clusters in other Regions.

Note that updating multi-Region clusters requires additional IAM permissions beyond those needed for standard cluster updates, as detailed in the Permissions section.

Required permissions

dsql:UpdateCluster

Permission to update a DSQL cluster.

Resources: arn:aws:dsql:_region_:_account-id_:cluster/_cluster-id_

dsql:PutMultiRegionProperties

Permission to configure multi-Region properties for a cluster.

Resources: arn:aws:dsql:_region_:_account-id_:cluster/_cluster-id_

dsql:GetCluster

Permission to retrieve cluster information.

Resources: arn:aws:dsql:_region_:_account-id_:cluster/_cluster-id_

dsql:AddPeerCluster

Permission to add peer clusters.

Resources:

  • Local cluster: arn:aws:dsql:_region_:_account-id_:cluster/_cluster-id_

  • Each peer cluster: exact ARN of each specified peer cluster

dsql:RemovePeerCluster

Permission to remove peer clusters. The dsql:RemovePeerCluster permission uses a wildcard ARN pattern to simplify permission management during updates.

Resources: arn:aws:dsql:*:_account-id_:cluster/*

dsql:PutWitnessRegion

Permission to set a witness Region.

Resources: arn:aws:dsql:_region_:_account-id_:cluster/_cluster-id_

Condition Keys: dsql:WitnessRegion (matching the specified witness Region)

This permission is checked both in the cluster Region and in the witness Region.

  • The witness region specified in multiRegionProperties.witnessRegion cannot be the same as the cluster's Region.

  • When updating clusters with peer relationships, permissions are checked for both adding and removing peers.

  • The dsql:RemovePeerCluster permission uses a wildcard ARN pattern to simplify permission management during updates.

post/cluster/{identifier}

Path parameters

identifierstring required

The ID of the cluster.

The ID of the cluster you want to update.

Request body

deletionProtectionEnabledboolean

Indicates whether deletion protection is enabled for a cluster.

kmsEncryptionKeystring

The KMS key that encrypts and protects the data on your cluster. You can specify the ARN, ID, or alias of an existing key or have Amazon Web Services create a default key for you.

clientTokenstring

Idempotency token so a request is only processed once.

Response

Success

identifierstring required

The ID of the cluster to update.

arnstring required

The ARN of the updated cluster.

status'CREATING' | 'ACTIVE' | 'IDLE' | 'INACTIVE' | 'UPDATING' | 'DELETING' | 'DELETED' | 'FAILED' | 'PENDING_SETUP' | 'PENDING_DELETE' required

The status of the updated cluster.

creationTimestring date-time required

The time of when the cluster was created.