modify_current_db_cluster_capacity¶
Operation¶
async
¶
modify_current_db_cluster_capacity(input: ModifyCurrentDBClusterCapacityInput, plugins: list[Plugin] | None = None) -> ModifyCurrentDBClusterCapacityOutput
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 ModifyCurrentDBClusterCapacity 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.
Warning
If you call ModifyCurrentDBClusterCapacity 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.
Note: This operation only applies to Aurora Serverless v1 DB clusters.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ModifyCurrentDBClusterCapacityInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
ModifyCurrentDBClusterCapacityOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyCurrentDBClusterCapacityInput structure.
Attributes¶
class-attribute
instance-attribute
¶
capacity: int | None = ...
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.
class-attribute
instance-attribute
¶
db_cluster_identifier: str | None = ...
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.
class-attribute
instance-attribute
¶
seconds_before_timeout: int | None = ...
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.
class-attribute
instance-attribute
¶
timeout_action: str | None = ...
The action to take when the timeout is reached, either
ForceApplyCapacityChange or RollbackCapacityChange.
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.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyCurrentDBClusterCapacityOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
current_capacity: int | None = ...
The current capacity of the DB cluster.
class-attribute
instance-attribute
¶
db_cluster_identifier: str | None = ...
A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
class-attribute
instance-attribute
¶
pending_capacity: int | None = ...
A value that specifies the capacity that the DB cluster scales to next.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.