Package software.amazon.awscdk.services.rds

Interface CfnDBCluster.ScalingConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDBCluster.ScalingConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDBCluster

@Stability(Stable)
public static interface CfnDBCluster.ScalingConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.rds.*;
 ScalingConfigurationProperty scalingConfigurationProperty = ScalingConfigurationProperty.builder()
         .autoPause(false)
         .maxCapacity(123)
         .minCapacity(123)
         .secondsBeforeTimeout(123)
         .secondsUntilAutoPause(123)
         .timeoutAction("timeoutAction")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDBCluster.ScalingConfigurationProperty.Builder	A builder for CfnDBCluster.ScalingConfigurationProperty
static final class	CfnDBCluster.ScalingConfigurationProperty.Jsii$Proxy	An implementation for CfnDBCluster.ScalingConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDBCluster.ScalingConfigurationProperty.Builder	builder()
default Object	getAutoPause()	Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode.
default Number	getMaxCapacity()	The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
default Number	getMinCapacity()	The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
default Number	getSecondsBeforeTimeout()	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.
default Number	getSecondsUntilAutoPause()	The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
default String	getTimeoutAction()	The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAutoPause

@Stability(Stable)
@Nullable
default Object getAutoPause()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-autopause

getMaxCapacity

@Stability(Stable)
@Nullable
default Number getMaxCapacity()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-maxcapacity

getMinCapacity

@Stability(Stable)
@Nullable
default Number getMinCapacity()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-mincapacity

getSecondsBeforeTimeout

@Stability(Stable)
@Nullable
default Number getSecondsBeforeTimeout()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-secondsbeforetimeout

getSecondsUntilAutoPause

@Stability(Stable)
@Nullable
default Number getSecondsUntilAutoPause()

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

Specify a value between 300 and 86,400 seconds.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-secondsuntilautopause

getTimeoutAction

@Stability(Stable)
@Nullable
default String getTimeoutAction()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-timeoutaction

builder

@Stability(Stable)
static CfnDBCluster.ScalingConfigurationProperty.Builder builder()

Returns:

a CfnDBCluster.ScalingConfigurationProperty.Builder of CfnDBCluster.ScalingConfigurationProperty