AWS::RDS::DBCluster ScalingConfiguration - AWS CloudFormation
SyntaxPropertiesExamples

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::RDS::DBCluster ScalingConfiguration

The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless v1 DB cluster.

For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use the ServerlessV2ScalingConfiguration property.

Valid for: Aurora Serverless v1 DB clusters only

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "AutoPause" : Boolean,
  "MaxCapacity" : Integer,
  "MinCapacity" : Integer,
  "SecondsBeforeTimeout" : Integer,
  "SecondsUntilAutoPause" : Integer,
  "TimeoutAction" : String
}

YAML

  AutoPause: Boolean
  MaxCapacity: Integer
  MinCapacity: Integer
  SecondsBeforeTimeout: Integer
  SecondsUntilAutoPause: Integer
  TimeoutAction: String

Properties

AutoPause

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, and 256.

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

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, and 256.

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

The minimum capacity must be less than or equal to the maximum capacity.

Required: No

Type: Integer

Update requires: No interruption

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 60 and 600 seconds.

Required: No

Type: Integer

Update requires: No interruption

SecondsUntilAutoPause

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

Specify a value between 300 and 86,400 seconds.

Required: No

Type: Integer

Update requires: No interruption

TimeoutAction

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.

RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.

Important

If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.

For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

Required: No

Type: String

Update requires: No interruption

Examples

The following example specifies a scaling configuration for a DB cluster.

Specifying 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