Package software.amazon.awscdk.services.rds

Class CfnDBCluster.ScalingConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.rds.CfnDBCluster.ScalingConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDBCluster.ScalingConfigurationProperty>

Enclosing interface:

CfnDBCluster.ScalingConfigurationProperty

@Stability(Stable)
public static final class CfnDBCluster.ScalingConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDBCluster.ScalingConfigurationProperty>

A builder for CfnDBCluster.ScalingConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDBCluster.ScalingConfigurationProperty.Builder	autoPause(Boolean autoPause)	Sets the value of CfnDBCluster.ScalingConfigurationProperty.getAutoPause()
CfnDBCluster.ScalingConfigurationProperty.Builder	autoPause(IResolvable autoPause)	Sets the value of CfnDBCluster.ScalingConfigurationProperty.getAutoPause()
CfnDBCluster.ScalingConfigurationProperty	build()	Builds the configured instance.
CfnDBCluster.ScalingConfigurationProperty.Builder	maxCapacity(Number maxCapacity)	Sets the value of CfnDBCluster.ScalingConfigurationProperty.getMaxCapacity()
CfnDBCluster.ScalingConfigurationProperty.Builder	minCapacity(Number minCapacity)	Sets the value of CfnDBCluster.ScalingConfigurationProperty.getMinCapacity()
CfnDBCluster.ScalingConfigurationProperty.Builder	secondsBeforeTimeout(Number secondsBeforeTimeout)	Sets the value of CfnDBCluster.ScalingConfigurationProperty.getSecondsBeforeTimeout()
CfnDBCluster.ScalingConfigurationProperty.Builder	secondsUntilAutoPause(Number secondsUntilAutoPause)	Sets the value of CfnDBCluster.ScalingConfigurationProperty.getSecondsUntilAutoPause()
CfnDBCluster.ScalingConfigurationProperty.Builder	timeoutAction(String timeoutAction)	Sets the value of CfnDBCluster.ScalingConfigurationProperty.getTimeoutAction()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

autoPause

@Stability(Stable)
public CfnDBCluster.ScalingConfigurationProperty.Builder autoPause(Boolean autoPause)

Sets the value of CfnDBCluster.ScalingConfigurationProperty.getAutoPause()

Parameters:

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

Returns:

this

autoPause

@Stability(Stable)
public CfnDBCluster.ScalingConfigurationProperty.Builder autoPause(IResolvable autoPause)

Sets the value of CfnDBCluster.ScalingConfigurationProperty.getAutoPause()

Parameters:

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

Returns:

this

maxCapacity

@Stability(Stable)
public CfnDBCluster.ScalingConfigurationProperty.Builder maxCapacity(Number maxCapacity)

Sets the value of CfnDBCluster.ScalingConfigurationProperty.getMaxCapacity()

Parameters:

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.

Returns:

this

minCapacity

@Stability(Stable)
public CfnDBCluster.ScalingConfigurationProperty.Builder minCapacity(Number minCapacity)

Sets the value of CfnDBCluster.ScalingConfigurationProperty.getMinCapacity()

Parameters:

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.

Returns:

this

secondsBeforeTimeout

@Stability(Stable)
public CfnDBCluster.ScalingConfigurationProperty.Builder secondsBeforeTimeout(Number secondsBeforeTimeout)

Sets the value of CfnDBCluster.ScalingConfigurationProperty.getSecondsBeforeTimeout()

Parameters:

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.

Returns:

this

secondsUntilAutoPause

@Stability(Stable)
public CfnDBCluster.ScalingConfigurationProperty.Builder secondsUntilAutoPause(Number secondsUntilAutoPause)

Sets the value of CfnDBCluster.ScalingConfigurationProperty.getSecondsUntilAutoPause()

Parameters:

secondsUntilAutoPause - The time, in seconds, before an Aurora DB cluster in serverless mode is paused. Specify a value between 300 and 86,400 seconds.

Returns:

this

timeoutAction

@Stability(Stable)
public CfnDBCluster.ScalingConfigurationProperty.Builder timeoutAction(String timeoutAction)

Sets the value of CfnDBCluster.ScalingConfigurationProperty.getTimeoutAction()

Parameters:

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 .

Returns:

this

build

@Stability(Stable)
public CfnDBCluster.ScalingConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDBCluster.ScalingConfigurationProperty>

Returns:

a new instance of CfnDBCluster.ScalingConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided