Package 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("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:

  • Method Details

    • 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()

      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:
      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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ScalingConfiguration.Builder,ScalingConfiguration>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.