Skip to content

/AWS1/CL_RDSSCALINGCONF

Contains the scaling configuration of an Aurora Serverless v1 DB cluster.

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

CONSTRUCTOR

IMPORTING

Optional arguments:

IV_MINCAPACITY TYPE /AWS1/RDSINTEGEROPTIONAL /AWS1/RDSINTEGEROPTIONAL

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.

IV_MAXCAPACITY TYPE /AWS1/RDSINTEGEROPTIONAL /AWS1/RDSINTEGEROPTIONAL

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.

IV_AUTOPAUSE TYPE /AWS1/RDSBOOLEANOPTIONAL /AWS1/RDSBOOLEANOPTIONAL

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).

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.

IV_SECONDSUNTILAUTOPAUSE TYPE /AWS1/RDSINTEGEROPTIONAL /AWS1/RDSINTEGEROPTIONAL

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

Specify a value between 300 and 86,400 seconds.

IV_TIMEOUTACTION TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

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.

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.

IV_SECONDSBEFORETIMEOUT TYPE /AWS1/RDSINTEGEROPTIONAL /AWS1/RDSINTEGEROPTIONAL

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.

Queryable Attributes

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.

Accessible with the following methods

Method Description
GET_MINCAPACITY() Getter for MINCAPACITY, with configurable default
ASK_MINCAPACITY() Getter for MINCAPACITY w/ exceptions if field has no value
HAS_MINCAPACITY() Determine if MINCAPACITY has a value

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.

Accessible with the following methods

Method Description
GET_MAXCAPACITY() Getter for MAXCAPACITY, with configurable default
ASK_MAXCAPACITY() Getter for MAXCAPACITY w/ exceptions if field has no value
HAS_MAXCAPACITY() Determine if MAXCAPACITY has a value

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).

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.

Accessible with the following methods

Method Description
GET_AUTOPAUSE() Getter for AUTOPAUSE, with configurable default
ASK_AUTOPAUSE() Getter for AUTOPAUSE w/ exceptions if field has no value
HAS_AUTOPAUSE() Determine if AUTOPAUSE has a value

SecondsUntilAutoPause

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

Specify a value between 300 and 86,400 seconds.

Accessible with the following methods

Method Description
GET_SECONDSUNTILAUTOPAUSE() Getter for SECONDSUNTILAUTOPAUSE, with configurable default
ASK_SECONDSUNTILAUTOPAUSE() Getter for SECONDSUNTILAUTOPAUSE w/ exceptions if field has
HAS_SECONDSUNTILAUTOPAUSE() Determine if SECONDSUNTILAUTOPAUSE has a value

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.

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.

Accessible with the following methods

Method Description
GET_TIMEOUTACTION() Getter for TIMEOUTACTION, with configurable default
ASK_TIMEOUTACTION() Getter for TIMEOUTACTION w/ exceptions if field has no value
HAS_TIMEOUTACTION() Determine if TIMEOUTACTION has a value

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.

Accessible with the following methods

Method Description
GET_SECONDSBEFORETIMEOUT() Getter for SECONDSBEFORETIMEOUT, with configurable default
ASK_SECONDSBEFORETIMEOUT() Getter for SECONDSBEFORETIMEOUT w/ exceptions if field has n
HAS_SECONDSBEFORETIMEOUT() Determine if SECONDSBEFORETIMEOUT has a value