UpdateCluster - Amazon DocumentDB


Modifies an elastic cluster. This includes updating admin-username/password, upgrading the API version, and setting up a backup window and maintenance window

Request Syntax

PUT /cluster/clusterArn HTTP/1.1 Content-type: application/json { "adminUserPassword": "string", "authType": "string", "backupRetentionPeriod": number, "clientToken": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] }

URI Request Parameters

The request uses the following URI parameters.


The ARN identifier of the elastic cluster.

Required: Yes

Request Body

The request accepts the following data in JSON format.


The password associated with the elastic cluster administrator. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

Type: String

Required: No


The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.

Type: String


Required: No


The number of days for which automatic snapshots are retained.

Type: Integer

Required: No


The client token for the elastic cluster.

Type: String

Required: No


The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod.

Type: String

Required: No


The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

Default: a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

Type: String

Required: No


The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

Type: Integer

Required: No


The number of shards assigned to the elastic cluster. Maximum is 32.

Type: Integer

Required: No


The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

Type: Integer

Required: No


The Amazon EC2 subnet IDs for the elastic cluster.

Type: Array of strings

Required: No


A list of EC2 VPC security groups to associate with the elastic cluster.

Type: Array of strings

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "cluster": { "adminUserName": "string", "authType": "string", "backupRetentionPeriod": number, "clusterArn": "string", "clusterEndpoint": "string", "clusterName": "string", "createTime": "string", "kmsKeyId": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "shards": [ { "createTime": "string", "shardId": "string", "status": "string" } ], "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "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.


Returns information about the updated elastic cluster.

Type: Cluster object


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


An exception that occurs when there are not sufficient permissions to perform an action.

HTTP Status Code: 403


There was an access conflict.

HTTP Status Code: 409


There was an internal server error.

HTTP Status Code: 500


The specified resource could not be located.

HTTP Status Code: 404


ThrottlingException will be thrown when request was denied due to request throttling.

HTTP Status Code: 429


A structure defining a validation exception.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: