1.204.0

interface ScalingConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.RDS.CfnDBCluster.ScalingConfigurationProperty
Javasoftware.amazon.awscdk.services.rds.CfnDBCluster.ScalingConfigurationProperty
Pythonaws_cdk.aws_rds.CfnDBCluster.ScalingConfigurationProperty
TypeScript @aws-cdk/aws-rds » CfnDBCluster » ScalingConfigurationProperty

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 .

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

Valid for: Aurora DB clusters only

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as rds from '@aws-cdk/aws-rds';
const scalingConfigurationProperty: rds.CfnDBCluster.ScalingConfigurationProperty = {
  autoPause: false,
  maxCapacity: 123,
  minCapacity: 123,
  secondsBeforeTimeout: 123,
  secondsUntilAutoPause: 123,
  timeoutAction: 'timeoutAction',
};

Properties

NameTypeDescription
autoPause?boolean | IResolvableA value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode.
maxCapacity?numberThe maximum capacity for an Aurora DB cluster in serverless DB engine mode.
minCapacity?numberThe minimum capacity for an Aurora DB cluster in serverless DB engine mode.
secondsBeforeTimeout?numberThe amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action.
secondsUntilAutoPause?numberThe time, in seconds, before an Aurora DB cluster in serverless mode is paused.
timeoutAction?stringThe action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange .

autoPause?

Type: boolean | IResolvable (optional)

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

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.

maxCapacity?

Type: number (optional)

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.

minCapacity?

Type: number (optional)

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.

secondsBeforeTimeout?

Type: number (optional)

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.

secondsUntilAutoPause?

Type: number (optional)

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

Specify a value between 300 and 86,400 seconds.

timeoutAction?

Type: string (optional)

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 .

← PreviousNext →