software.amazon.awssdk.services.rds.model

Class ScalingConfiguration

java.lang.Object

software.amazon.awssdk.services.rds.model.ScalingConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ScalingConfiguration.Builder,ScalingConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class ScalingConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ScalingConfiguration.Builder,ScalingConfiguration>

Contains the scaling configuration of an Aurora Serverless v1 DB cluster.

For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ScalingConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	autoPause() A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode.
static ScalingConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxCapacity() The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
Integer	minCapacity() The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
List<SdkField<?>>	sdkFields()
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.
Integer	secondsUntilAutoPause() The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
static Class<? extends ScalingConfiguration.Builder>	serializableBuilderClass()
String	timeoutAction() The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.
ScalingConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

minCapacity

public final 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.

Returns:

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.

maxCapacity

public final 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.

Returns:

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.

autoPause

public final 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.

Returns:

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.

secondsUntilAutoPause

public final 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.

Returns:

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

Specify a value between 300 and 86,400 seconds.

timeoutAction

public final 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.

Returns:

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.

secondsBeforeTimeout

public final 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.

Returns:

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.

toBuilder

public ScalingConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ScalingConfiguration.Builder,ScalingConfiguration>

builder

public static ScalingConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends ScalingConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo