AWS::RDS::DBCluster ScalingConfiguration
The ScalingConfiguration
property type specifies the scaling
configuration of an Aurora Serverless DB cluster.
For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "AutoPause" :
Boolean
, "MaxCapacity" :Integer
, "MinCapacity" :Integer
, "SecondsUntilAutoPause" :Integer
}
YAML
AutoPause:
Boolean
MaxCapacity:Integer
MinCapacity:Integer
SecondsUntilAutoPause:Integer
Properties
AutoPause
-
A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in
serverless
DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).Note If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
Required: No
Type: Boolean
Update requires: No interruption
MaxCapacity
-
The maximum capacity for an Aurora DB cluster in
serverless
DB engine mode.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
.The maximum capacity must be greater than or equal to the minimum capacity.
Required: No
Type: Integer
Update requires: No interruption
MinCapacity
-
The minimum capacity for an Aurora DB cluster in
serverless
DB engine mode.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
.The minimum capacity must be less than or equal to the maximum capacity.
Required: No
Type: Integer
Update requires: No interruption
SecondsUntilAutoPause
-
The time, in seconds, before an Aurora DB cluster in
serverless
mode is paused.Required: No
Type: Integer
Update requires: No interruption
Examples
The following specifies a scaling configuration.
For a sample template that configures an Aurora Serverless DB cluster, see Creating an Amazon Aurora Serverless DB Cluster.
JSON
"ScalingConfiguration" : { "AutoPause" : true, "MinCapacity" : 4, "MaxCapacity" : 32, "SecondsUntilAutoPause" : 1000 }
YAML
ScalingConfiguration: AutoPause: true MinCapacity: 4 MaxCapacity: 32 SecondsUntilAutoPause: 1000