ModifyCurrentDBClusterCapacity
Set the capacity of an Aurora Serverless DB cluster to a specific value.
Aurora Serverless scales seamlessly based on the workload on the DB cluster. In some
cases, the capacity might not scale
fast enough to meet a sudden change in workload, such as a large number of new transactions.
Call ModifyCurrentDBClusterCapacity
to set the capacity explicitly.
After this call sets the DB cluster capacity, Aurora Serverless can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.
For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
Important
If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that
prevent Aurora Serverless from finding a scaling point might be dropped. For more
information about scaling points,
see
Autoscaling for Aurora Serverless 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.
- Capacity
-
The DB cluster capacity.
When you change the capacity of a paused Aurora Serverless DB cluster, it automatically resumes.
Constraints:
-
Value must be
2,4,8,16,32,64,128, or256.
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 DB cluster.
Type: String
Required: Yes
-
- SecondsBeforeTimeout
-
The amount of time, in seconds, that Aurora Serverless tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
-
Value must be from 10 through 600.
Type: Integer
Required: No
-
- TimeoutAction
-
The action to take when the timeout is reached, either
ForceApplyCapacityChangeorRollbackCapacityChange.ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.RollbackCapacityChangeignores the capacity change if a scaling point is not found in the timeout period.Type: String
Required: No
Response Elements
The following elements are returned by the service.
- CurrentCapacity
-
The current capacity of the DB cluster.
Type: Integer
- DBClusterIdentifier
-
A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
Type: String
- PendingCapacity
-
A value that specifies the capacity that the DB cluster scales to next.
Type: Integer
- SecondsBeforeTimeout
-
The number of seconds before a call to
ModifyCurrentDBClusterCapacitytimes out.Type: Integer
- TimeoutAction
-
The timeout action of a call to
ModifyCurrentDBClusterCapacity, eitherForceApplyCapacityChangeorRollbackCapacityChange.Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- DBClusterNotFoundFault
-
DBClusterIdentifier doesn't refer to an existing DB cluster.
HTTP Status Code: 404
- InvalidDBClusterCapacityFault
-
Capacity isn't a valid Aurora Serverless DB cluster capacity. Valid capacity values are
2,4,8,16,32,64,128, and256.HTTP Status Code: 400
- InvalidDBClusterStateFault
-
The requested operation can't be performed while the cluster is in this state.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
