Package software.amazon.awscdk.services.rds

Enum TimeoutAction

java.lang.Object

java.lang.Enum<TimeoutAction>

software.amazon.awscdk.services.rds.TimeoutAction

All Implemented Interfaces:

Serializable, Comparable<TimeoutAction>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:08.423Z")
@Stability(Stable)
public enum TimeoutAction
extends Enum<TimeoutAction>

TimeoutAction defines the action to take when a timeout occurs if a scaling point is not found.

Example:

 Vpc vpc;
 ServerlessCluster cluster = ServerlessCluster.Builder.create(this, "AnotherCluster")
         .engine(DatabaseClusterEngine.AURORA_POSTGRESQL)
         .copyTagsToSnapshot(true) // whether to save the cluster tags when creating the snapshot. Default is 'true'
         .parameterGroup(ParameterGroup.fromParameterGroupName(this, "ParameterGroup", "default.aurora-postgresql11"))
         .vpc(vpc)
         .scaling(ServerlessScalingOptions.builder()
                 .autoPause(Duration.minutes(10)) // default is to pause after 5 minutes of idle time
                 .minCapacity(AuroraCapacityUnit.ACU_8) // default is 2 Aurora capacity units (ACUs)
                 .maxCapacity(AuroraCapacityUnit.ACU_32) // default is 16 Aurora capacity units (ACUs)
                 .timeout(Duration.seconds(100)) // default is 5 minutes
                 .timeoutAction(TimeoutAction.FORCE_APPLY_CAPACITY_CHANGE)
                 .build())
         .build();
 

See Also:

• https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v1.how-it-works.html#aurora-serverless.how-it-works.timeout-action

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FORCE_APPLY_CAPACITY_CHANGE	FORCE_APPLY_CAPACITY_CHANGE sets the capacity to the specified value as soon as possible.
ROLLBACK_CAPACITY_CHANGE	ROLLBACK_CAPACITY_CHANGE ignores the capacity change if a scaling point is not found.

Method Summary

Modifier and Type	Method	Description
static TimeoutAction	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TimeoutAction[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FORCE_APPLY_CAPACITY_CHANGE

@Stability(Stable)
public static final TimeoutAction FORCE_APPLY_CAPACITY_CHANGE

FORCE_APPLY_CAPACITY_CHANGE sets the capacity to the specified value as soon as possible.

Transactions may be interrupted, and connections to temporary tables and locks may be dropped. Only select this option if your application can recover from dropped connections or incomplete transactions.

ROLLBACK_CAPACITY_CHANGE

@Stability(Stable)
public static final TimeoutAction ROLLBACK_CAPACITY_CHANGE

ROLLBACK_CAPACITY_CHANGE ignores the capacity change if a scaling point is not found.

This is the default behavior.

Method Details

values

public static TimeoutAction[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TimeoutAction valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null