ModifyDBCluster
Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
Note
This action only applies to Aurora DB clusters.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- 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 indicates 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 disabled, changes to the DB cluster are applied during the next maintenance window.The
ApplyImmediately
parameter only affects theEnableIAMDatabaseAuthentication
,MasterUserPassword
, andNewDBClusterIdentifier
values. If theApplyImmediately
parameter is disabled, then changes to theEnableIAMDatabaseAuthentication
,MasterUserPassword
, andNewDBClusterIdentifier
values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of theApplyImmediately
parameter.By default, this parameter is disabled.
Type: Boolean
Required: No
- BacktrackWindow
-
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
-
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Type: Long
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 CloudWatch Logs for a specific DB cluster.
Type: CloudwatchLogsExportConfiguration object
Required: No
- CopyTagsToSnapshot
-
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
Type: Boolean
Required: No
- DBClusterIdentifier
-
The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
Constraints: This identifier must match the identifier of an existing DB cluster.
Type: String
Required: Yes
- DBClusterParameterGroupName
-
The name of the DB cluster parameter group to use for the DB cluster.
Type: String
Required: No
- DBInstanceParameterGroupName
-
The name of the DB parameter group to apply to all instances of the DB cluster.
Note
When you apply a parameter group using the
DBInstanceParameterGroupName
parameter, the DB cluster isn't rebooted automatically. Also, parameter changes aren't applied during the next maintenance window but instead are applied immediately.Default: The existing name setting
Constraints:
-
The DB parameter group must be in the same DB parameter group family as this DB cluster.
-
The
DBInstanceParameterGroupName
parameter is only valid in combination with theAllowMajorVersionUpgrade
parameter.
Type: String
Required: No
-
- DeletionProtection
-
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
Type: Boolean
Required: No
- EnableHttpEndpoint
-
A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
Type: Boolean
Required: No
- EnableIAMDatabaseAuthentication
-
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
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
aurora
(for MySQL 5.6-compatible Aurora), use the following command:aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for
aurora-mysql
(for MySQL 5.7-compatible Aurora), use the following command:aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for
aurora-postgresql
, use the following command:aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
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
-
Can't 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
is enabled 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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
Type: String
Required: No
- ScalingConfiguration
-
The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in
serverless
DB engine mode.Type: ScalingConfiguration object
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 Aurora DB cluster.
This data type is used as a response element in the
DescribeDBClusters
,StopDBCluster
, andStartDBCluster
actions.Type: DBCluster object
Errors
For information about the errors that are common to all actions, see Common Errors.
- DBClusterAlreadyExistsFault
-
The user already has a DB cluster with the given identifier.
HTTP Status Code: 400
- DBClusterNotFoundFault
-
DBClusterIdentifier
doesn't refer to an existing DB cluster.HTTP Status Code: 404
- DBClusterParameterGroupNotFound
-
DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group.HTTP Status Code: 404
- DBSubnetGroupNotFoundFault
-
DBSubnetGroupName
doesn't refer to an existing DB subnet group.HTTP Status Code: 404
- DomainNotFoundFault
-
Domain
doesn't refer to an existing Active Directory domain.HTTP Status Code: 404
- InvalidDBClusterStateFault
-
The requested operation can't be performed while the cluster is in this state.
HTTP Status Code: 400
- InvalidDBInstanceState
-
The DB instance isn't in a valid state.
HTTP Status Code: 400
- InvalidDBSecurityGroupState
-
The state of the DB security group doesn't allow deletion.
HTTP Status Code: 400
- InvalidDBSubnetGroupStateFault
-
The DB subnet group cannot be deleted because it's 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
-
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
HTTP Status Code: 400
- StorageQuotaExceeded
-
The request would result in the user exceeding the allowed amount of storage available across all DB instances.
HTTP Status Code: 400
Example
Sample Request
https://rds.us-east-1.amazonaws.com/ ?Action=ModifyDBCluster &DBClusterIdentifier=sample-cluster3 &SignatureMethod=HmacSHA256 &SignatureVersion=4 &Version=2014-10-31 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIADQKE4SARGYLE/20140725/us-east-1/rds/aws4_request &X-Amz-Date=20140725T161457Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=d6d1c65c2e94f5800ab411a3f7336625820b103713b6c063430900514e21d784
Sample Response
<ModifyDBClusterResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/"> <ModifyDBClusterResult> <DBCluster> <Engine>aurora5.6</Engine> <Status>available</Status> <BackupRetentionPeriod>0</BackupRetentionPeriod> <DBSubnetGroup>my-subgroup</DBSubnetGroup> <EngineVersion>5.6.10a</EngineVersion> <Endpoint>sample-cluster3.cluster-cefgqfx9y5fy.us-east-1.rds.amazonaws.com</Endpoint> <DBClusterIdentifier>sample-cluster3</DBClusterIdentifier> <PreferredBackupWindow>07:06-07:36</PreferredBackupWindow> <PreferredMaintenanceWindow>tue:10:18-tue:10:48</PreferredMaintenanceWindow> <DBClusterMembers> <DBClusterMember> <IsClusterWriter>true</IsClusterWriter> <DBInstanceIdentifier>sample-cluster3-master</DBInstanceIdentifier> </DBClusterMember> <DBClusterMember> <IsClusterWriter>false</IsClusterWriter> <DBInstanceIdentifier>sample-cluster3-read1</DBInstanceIdentifier> </DBClusterMember> </DBClusterMembers> <AllocatedStorage>15</AllocatedStorage> <MasterUsername>awsuser</MasterUsername> </DBCluster> </ModifyDBClusterResult> <ResponseMetadata> <RequestId>d2cd0e2f-1416-11e4-9210-cf99df4125d0</RequestId> </ResponseMetadata> </ModifyDBClusterResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: