Class StepScalingPolicyConfiguration

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

Represents a step scaling policy configuration to use with Application Auto Scaling.

For more information, see Step scaling policies in the Application Auto Scaling User Guide.

See Also:

  • Method Details

    • adjustmentType

      public final AdjustmentType adjustmentType()

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

      AdjustmentType is required if you are adding a new step scaling policy configuration.

      If the service returns an enum value that is not available in the current SDK version, adjustmentType will return AdjustmentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from adjustmentTypeAsString().

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

      AdjustmentType is required if you are adding a new step scaling policy configuration.

      See Also:

    • adjustmentTypeAsString

      public final String adjustmentTypeAsString()

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

      AdjustmentType is required if you are adding a new step scaling policy configuration.

      If the service returns an enum value that is not available in the current SDK version, adjustmentType will return AdjustmentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from adjustmentTypeAsString().

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

      AdjustmentType is required if you are adding a new step scaling policy configuration.

      See Also:

    • 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.

      At least one step adjustment is required if you are adding a new step scaling policy configuration.

      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.

      At least one step adjustment is required if you are adding a new step scaling policy configuration.

    • minAdjustmentMagnitude

      public final Integer minAdjustmentMagnitude()

      The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks.

      Returns:
      The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks.

    • cooldown

      public final Integer cooldown()

      The amount of time, in seconds, to wait for a previous scaling activity to take effect. If not specified, the default value is 300. For more information, see Cooldown period in the Application Auto Scaling User Guide.

      Returns:
      The amount of time, in seconds, to wait for a previous scaling activity to take effect. If not specified, the default value is 300. For more information, see Cooldown period in the Application Auto Scaling User Guide.

    • metricAggregationType

      public final MetricAggregationType metricAggregationType()

      The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.

      If the service returns an enum value that is not available in the current SDK version, metricAggregationType will return MetricAggregationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricAggregationTypeAsString().

      Returns:
      The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.
      See Also:

    • metricAggregationTypeAsString

      public final String metricAggregationTypeAsString()

      The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.

      If the service returns an enum value that is not available in the current SDK version, metricAggregationType will return MetricAggregationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricAggregationTypeAsString().

      Returns:
      The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.
      See Also:

    • toBuilder

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

    • builder

      public static StepScalingPolicyConfiguration.Builder builder()

    • serializableBuilderClass

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