ModifyDBCluster
Modify a setting for a 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.
- ApplyImmediately
-
A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the
PreferredMaintenanceWindow
setting for the DB cluster. If this parameter is set tofalse
, changes to the DB cluster are applied during the next maintenance window.The
ApplyImmediately
parameter only affects theNewDBClusterIdentifier
andMasterUserPassword
values. If you set theApplyImmediately
parameter value to false, then 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
-
- DBClusterIdentifier
-
The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.
Constraints:
-
Must match the identifier of an existing DBCluster.
Type: String
Required: Yes
-
- DBClusterParameterGroupName
-
The name of the DB cluster parameter group to use for the DB cluster.
Type: String
Required: No
- EnableIAMDatabaseAuthentication
-
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default:
false
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 the ApplyImmediately parameter is set to true.
For a list of valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.
Type: String
Required: No
- MasterUserPassword
-
The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
Type: String
Required: No
- NewDBClusterIdentifier
-
The new DB cluster identifier for the DB cluster when renaming a DB 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
-
- OptionGroupName
-
A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the
ApplyImmediately
parameter is set totrue
for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
Type: String
Required: No
- Port
-
The port number on which the DB cluster accepts connections.
Constraints: Value must be
1150-65535
Default: The same port as the original DB 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
- VpcSecurityGroupIds.VpcSecurityGroupId.N
-
A list of 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.
- DBCluster
-
Contains the details of an Amazon Neptune DB cluster.
This data type is used as a response element in the DescribeDBClusters action.
Type: DBCluster object
Errors
For information about the errors that are common to all actions, see DB Cluster Management API Error Messages and Codes.
- DBClusterAlreadyExistsFault
-
User already has a DB cluster with the given identifier.
HTTP Status Code: 400
- DBClusterNotFoundFault
-
DBClusterIdentifier does not refer to an existing DB cluster.
HTTP Status Code: 404
- DBClusterParameterGroupNotFound
-
DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.
HTTP Status Code: 404
- DBSubnetGroupNotFoundFault
-
DBSubnetGroupName does not refer to an existing DB subnet group.
HTTP Status Code: 404
- InvalidDBClusterStateFault
-
The DB cluster is not in a valid state.
HTTP Status Code: 400
- InvalidDBInstanceState
-
The specified DB instance is not in the available state.
HTTP Status Code: 400
- InvalidDBSecurityGroupState
-
The state of the DB security group does not allow deletion.
HTTP Status Code: 400
- InvalidDBSubnetGroupStateFault
-
The DB subnet group cannot be deleted because it is in use.
HTTP Status Code: 400
- InvalidSubnet
-
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
HTTP Status Code: 400
- InvalidVPCNetworkStateFault
-
DB subnet group does not cover all Availability Zones after it is created because users' change.
HTTP Status Code: 400
- StorageQuotaExceeded
-
Request would result in user exceeding 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: