Package software.amazon.awssdk.services.opsworks.model

Class AutoScalingThresholds

java.lang.Object
software.amazon.awssdk.services.opsworks.model.AutoScalingThresholds
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AutoScalingThresholds.Builder,AutoScalingThresholds>
@Generated("software.amazon.awssdk:codegen") public final class AutoScalingThresholds extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AutoScalingThresholds.Builder,AutoScalingThresholds>

Describes a load-based auto scaling upscaling or downscaling threshold configuration, which specifies when OpsWorks Stacks starts or stops load-based instances.

See Also:

  • Method Details

    • instanceCount

      public final Integer instanceCount()

      The number of instances to add or remove when the load exceeds a threshold.

      Returns:
      The number of instances to add or remove when the load exceeds a threshold.

    • thresholdsWaitTime

      public final Integer thresholdsWaitTime()

      The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.

      Returns:
      The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.

    • ignoreMetricsTime

      public final Integer ignoreMetricsTime()

      The amount of time (in minutes) after a scaling event occurs that OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. IgnoreMetricsTime allows you to direct OpsWorks Stacks to suppress scaling events long enough to get the new instances online.

      Returns:
      The amount of time (in minutes) after a scaling event occurs that OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. IgnoreMetricsTime allows you to direct OpsWorks Stacks to suppress scaling events long enough to get the new instances online.

    • cpuThreshold

      public final Double cpuThreshold()

      The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.

      Returns:
      The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.

    • memoryThreshold

      public final Double memoryThreshold()

      The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.

      Returns:
      The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.

    • loadThreshold

      public final Double loadThreshold()

      The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing).

      Returns:
      The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing).

    • hasAlarms

      public final boolean hasAlarms()
      For responses, this returns true if the service returned a value for the Alarms property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • alarms

      public final List<String> alarms()

      Custom CloudWatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack.

      To use custom alarms, you must update your service role to allow cloudwatch:DescribeAlarms. You can either have OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see Allowing OpsWorks Stacks to Act on Your Behalf.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAlarms() method.

      Returns:
      Custom CloudWatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack.

      To use custom alarms, you must update your service role to allow cloudwatch:DescribeAlarms. You can either have OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see Allowing OpsWorks Stacks to Act on Your Behalf.

    • toBuilder

      public AutoScalingThresholds.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<AutoScalingThresholds.Builder,AutoScalingThresholds>
      Returns:
      a builder for type T

    • builder

      public static AutoScalingThresholds.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AutoScalingThresholds.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.