Amazon DocumentDB
Developer Guide


Modifies a setting for an Amazon DocumentDB DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.


The DB cluster identifier for the cluster that is being modified. This parameter is not case sensitive.


  • Must match the identifier of an existing DBCluster.

Type: String

Required: Yes


A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is set to false, changes to the DB cluster are applied during the next maintenance window.

The ApplyImmediately parameter affects only the NewDBClusterIdentifier and MasterUserPassword values. If you set this parameter value to false, the changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

Type: Boolean

Required: No


The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1


  • Must be a value from 1 to 35.

Type: Integer

Required: No


The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific DB instance or DB cluster. The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs.

Type: CloudwatchLogsExportConfiguration object

Required: No


The name of the DB cluster parameter group to use for the DB cluster.

Type: String

Required: No


The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true.

Type: String

Required: No


The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 41 characters.

Type: String

Required: No


The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.


  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster2

Type: String

Required: No


The port number on which the DB cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original DB cluster.

Type: Integer

Required: No


The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region.


  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

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

The default is 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


A list of virtual private cloud (VPC) security groups that the DB cluster will belong to.

Type: Array of strings

Required: No

Response Elements

The following element is returned by the service.


Detailed information about a DB cluster.

Type: DBCluster object


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


You already have a DB cluster with the given identifier.

HTTP Status Code: 400


DBClusterIdentifier doesn't refer to an existing DB cluster.

HTTP Status Code: 404


DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.

HTTP Status Code: 404


DBSubnetGroupName doesn't refer to an existing DB subnet group.

HTTP Status Code: 404


The DB cluster isn't in a valid state.

HTTP Status Code: 400


The specified DB instance isn't in the available state.

HTTP Status Code: 400


The state of the DB security group doesn't allow deletion.

HTTP Status Code: 400


The DB subnet group can't be deleted because it's in use.

HTTP Status Code: 400


The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).

HTTP Status Code: 400


The DB subnet group doesn't cover all Availability Zones after it is created because of changes that were made.

HTTP Status Code: 400


The request would cause you to exceed the allowed amount of storage available across all DB instances.

HTTP Status Code: 400

See Also

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