Modify Current Db Cluster Capacity
rds_modify_current_db_cluster_capacity | R Documentation |
Set the capacity of an Aurora Serverless v1 DB cluster to a specific value¶
Description¶
Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.
Aurora Serverless v1 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 modify_current_db_cluster_capacity
to set the capacity
explicitly.
After this call sets the DB cluster capacity, Aurora Serverless v1 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 v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
If you call modify_current_db_cluster_capacity
with the default
TimeoutAction
, connections that prevent Aurora Serverless v1 from
finding a scaling point might be dropped. For more information about
scaling points, see Autoscaling for Aurora Serverless
v1
in the Amazon Aurora User Guide.
This operation only applies to Aurora Serverless v1 DB clusters.
Usage¶
rds_modify_current_db_cluster_capacity(DBClusterIdentifier, Capacity,
SecondsBeforeTimeout, TimeoutAction)
Arguments¶
DBClusterIdentifier
[required] The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
Constraints:
Must match the identifier of an existing DB cluster.
Capacity
The DB cluster capacity.
When you change the capacity of a paused Aurora Serverless v1 DB cluster, it automatically resumes.
Constraints:
For Aurora MySQL, valid capacity values are
1
,2
,4
,8
,16
,32
,64
,128
, and256
.For Aurora PostgreSQL, valid capacity values are
2
,4
,8
,16
,32
,64
,192
, and384
.
SecondsBeforeTimeout
The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
Specify a value between 10 and 600 seconds.
TimeoutAction
The action to take when the timeout is reached, either
ForceApplyCapacityChange
orRollbackCapacityChange
.ForceApplyCapacityChange
, the default, sets the capacity to the specified value as soon as possible.RollbackCapacityChange
ignores the capacity change if a scaling point isn't found in the timeout period.
Value¶
A list with the following syntax:
list(
DBClusterIdentifier = "string",
PendingCapacity = 123,
CurrentCapacity = 123,
SecondsBeforeTimeout = 123,
TimeoutAction = "string"
)