ModifyDBCluster
Modifies a setting for an Amazon DocumentDB 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.
- DBClusterIdentifier
-
The cluster identifier for the cluster that is being modified. This parameter is not case sensitive.
Constraints:
-
Must match the identifier of an existing
DBCluster
.
Type: String
Required: Yes
-
- AllowMajorVersionUpgrade
-
A value that indicates whether major version upgrades are allowed.
Constraints: You must allow major version upgrades when specifying a value for the
EngineVersion
parameter that is a different major version than the DB cluster's current version.Type: Boolean
Required: No
- ApplyImmediately
-
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 cluster. If this parameter is set tofalse
, changes to the cluster are applied during the next maintenance window.The
ApplyImmediately
parameter affects only theNewDBClusterIdentifier
andMasterUserPassword
values. If you set this parameter value tofalse
, the changes to theNewDBClusterIdentifier
andMasterUserPassword
values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of theApplyImmediately
parameter.Default:
false
Type: Boolean
Required: No
- BackupRetentionPeriod
-
The number of days for which automated backups are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
-
Must be a value from 1 to 35.
Type: Integer
Required: No
-
- CloudwatchLogsExportConfiguration
-
The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The
EnableLogTypes
andDisableLogTypes
arrays determine which logs are exported (or not exported) to CloudWatch Logs.Type: CloudwatchLogsExportConfiguration object
Required: No
- DBClusterParameterGroupName
-
The name of the cluster parameter group to use for the cluster.
Type: String
Required: No
- DeletionProtection
-
Specifies whether this cluster can be deleted. If
DeletionProtection
is enabled, the cluster cannot be deleted unless it is modified andDeletionProtection
is disabled.DeletionProtection
protects clusters from being accidentally deleted.Type: Boolean
Required: No
- EngineVersion
-
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
ApplyImmediately
is enabled.To list all of the available engine versions for Amazon DocumentDB use the following command:
aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"
Type: String
Required: No
- MasterUserPassword
-
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 100 characters.
Type: String
Required: No
- NewDBClusterIdentifier
-
The new cluster identifier for the cluster when renaming a cluster. This value is stored as a lowercase string.
Constraints:
-
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
-
- Port
-
The port number on which the cluster accepts connections.
Constraints: Must be a value from
1150
to65535
.Default: The same port as the original cluster.
Type: Integer
Required: No
- PreferredBackupWindow
-
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.
Constraints:
-
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
-
- PreferredMaintenanceWindow
-
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
- StorageType
-
The storage type to associate with the DB cluster.
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type -
standard | iopt1
Default value is
standard
Type: String
Required: No
- VpcSecurityGroupIds.VpcSecurityGroupId.N
-
A list of virtual private cloud (VPC) security groups that the cluster will belong to.
Type: Array of strings
Required: No
Response Elements
The following element is returned by the service.
- DBCluster
-
Detailed information about a cluster.
Type: DBCluster object
Errors
For information about the errors that are common to all actions, see Common Errors.
- DBClusterAlreadyExistsFault
-
You already have a cluster with the given identifier.
HTTP Status Code: 400
- DBClusterNotFoundFault
-
DBClusterIdentifier
doesn't refer to an existing cluster.HTTP Status Code: 404
- DBClusterParameterGroupNotFound
-
DBClusterParameterGroupName
doesn't refer to an existing cluster parameter group.HTTP Status Code: 404
- DBSubnetGroupNotFoundFault
-
DBSubnetGroupName
doesn't refer to an existing subnet group.HTTP Status Code: 404
- InvalidDBClusterStateFault
-
The cluster isn't in a valid state.
HTTP Status Code: 400
- InvalidDBInstanceState
-
The specified instance isn't in the available state.
HTTP Status Code: 400
- InvalidDBSecurityGroupState
-
The state of the security group doesn't allow deletion.
HTTP Status Code: 400
- InvalidDBSubnetGroupStateFault
-
The subnet group can't be deleted because it's in use.
HTTP Status Code: 400
- InvalidSubnet
-
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
- InvalidVPCNetworkStateFault
-
The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.
HTTP Status Code: 400
- StorageQuotaExceeded
-
The request would cause you to exceed the allowed amount of storage available across all 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: