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(value=Stable)
public static interface CfnDBCluster.ScalingConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 .

Currently, AWS CloudFormation only supports Aurora Serverless v1. AWS CloudFormation doesn't support Aurora Serverless v2.

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)
         .secondsUntilAutoPause(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDBCluster.ScalingConfigurationProperty.Builder	builder()
default Object	getAutoPause() A value that 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	getSecondsUntilAutoPause() The time, in seconds, before an Aurora DB cluster in `serverless` mode is paused.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAutoPause

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

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.

getMaxCapacity

@Stability(value=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.

getMinCapacity

@Stability(value=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.

getSecondsUntilAutoPause

@Stability(value=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.

builder

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

Returns:

a CfnDBCluster.ScalingConfigurationProperty.Builder of CfnDBCluster.ScalingConfigurationProperty