software.amazon.awssdk.services.rds.model

Interface ScalingConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ScalingConfiguration.Builder,ScalingConfiguration>, SdkBuilder<ScalingConfiguration.Builder,ScalingConfiguration>, SdkPojo

Enclosing class:

ScalingConfiguration

public static interface ScalingConfiguration.Builder
extends SdkPojo, CopyableBuilder<ScalingConfiguration.Builder,ScalingConfiguration>

Method Summary

Modifier and Type	Method and Description
ScalingConfiguration.Builder	autoPause(Boolean autoPause) A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode.
ScalingConfiguration.Builder	maxCapacity(Integer maxCapacity) The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
ScalingConfiguration.Builder	minCapacity(Integer minCapacity) The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
ScalingConfiguration.Builder	secondsBeforeTimeout(Integer 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.
ScalingConfiguration.Builder	secondsUntilAutoPause(Integer secondsUntilAutoPause) The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
ScalingConfiguration.Builder	timeoutAction(String timeoutAction) The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

minCapacity

ScalingConfiguration.Builder minCapacity(Integer 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.

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:

Returns a reference to this object so that method calls can be chained together.

maxCapacity

ScalingConfiguration.Builder maxCapacity(Integer 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.

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:

Returns a reference to this object so that method calls can be chained together.

autoPause

ScalingConfiguration.Builder autoPause(Boolean 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.

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:

Returns a reference to this object so that method calls can be chained together.

secondsUntilAutoPause

ScalingConfiguration.Builder secondsUntilAutoPause(Integer secondsUntilAutoPause)

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

Specify a value between 300 and 86,400 seconds.

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:

Returns a reference to this object so that method calls can be chained together.

timeoutAction

ScalingConfiguration.Builder timeoutAction(String 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.

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:

Returns a reference to this object so that method calls can be chained together.

secondsBeforeTimeout

ScalingConfiguration.Builder secondsBeforeTimeout(Integer 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.

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:

Returns a reference to this object so that method calls can be chained together.