Class ScalingPolicy

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

Describes a scaling policy.

See Also:

  • Method Details

    • autoScalingGroupName

      public final String autoScalingGroupName()

      The name of the Auto Scaling group.

      Returns:
      The name of the Auto Scaling group.

    • policyName

      public final String policyName()

      The name of the scaling policy.

      Returns:
      The name of the scaling policy.

    • policyARN

      public final String policyARN()

      The Amazon Resource Name (ARN) of the policy.

      Returns:
      The Amazon Resource Name (ARN) of the policy.

    • policyType

      public final String policyType()

      One of the following policy types:

      • TargetTrackingScaling

      • StepScaling

      • SimpleScaling (default)

      • PredictiveScaling

      For more information, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.

      Returns:
      One of the following policy types:

      • TargetTrackingScaling

      • StepScaling

      • SimpleScaling (default)

      • PredictiveScaling

      For more information, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.

    • adjustmentType

      public final String adjustmentType()

      Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

      Returns:
      Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

    • minAdjustmentStep

      public final Integer minAdjustmentStep()

      Available for backward compatibility. Use MinAdjustmentMagnitude instead.

      Returns:
      Available for backward compatibility. Use MinAdjustmentMagnitude instead.

    • minAdjustmentMagnitude

      public final Integer minAdjustmentMagnitude()

      The minimum value to scale by when the adjustment type is PercentChangeInCapacity.

      Returns:
      The minimum value to scale by when the adjustment type is PercentChangeInCapacity.

    • scalingAdjustment

      public final Integer scalingAdjustment()

      The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

      Returns:
      The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

    • cooldown

      public final Integer cooldown()

      The duration of the policy's cooldown period, in seconds.

      Returns:
      The duration of the policy's cooldown period, in seconds.

    • hasStepAdjustments

      public final boolean hasStepAdjustments()
      For responses, this returns true if the service returned a value for the StepAdjustments 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.

    • stepAdjustments

      public final List<StepAdjustment> stepAdjustments()

      A set of adjustments that enable you to scale based on the size of the alarm breach.

      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 hasStepAdjustments() method.

      Returns:
      A set of adjustments that enable you to scale based on the size of the alarm breach.

    • metricAggregationType

      public final String metricAggregationType()

      The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.

      Returns:
      The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.

    • estimatedInstanceWarmup

      public final Integer estimatedInstanceWarmup()

      The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

      Returns:
      The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

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

      The CloudWatch alarms related to the policy.

      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:
      The CloudWatch alarms related to the policy.

    • targetTrackingConfiguration

      public final TargetTrackingConfiguration targetTrackingConfiguration()

      A target tracking scaling policy.

      Returns:
      A target tracking scaling policy.

    • enabled

      public final Boolean enabled()

      Indicates whether the policy is enabled (true) or disabled (false).

      Returns:
      Indicates whether the policy is enabled (true) or disabled (false).

    • predictiveScalingConfiguration

      public final PredictiveScalingConfiguration predictiveScalingConfiguration()

      A predictive scaling policy.

      Returns:
      A predictive scaling policy.

    • toBuilder

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

    • builder

      public static ScalingPolicy.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.