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.96.0 (build 921e240)", date="2024-04-10T22:22:34.204Z") @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:
  • 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