Class PutScalingPolicyRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.autoscaling.model.AutoScalingRequest
software.amazon.awssdk.services.autoscaling.model.PutScalingPolicyRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutScalingPolicyRequest extends AutoScalingRequest implements ToCopyableBuilder<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>

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

      Returns:
      The name of the policy.

    • policyType

      public final String policyType()

      One of the following policy types:

      • TargetTrackingScaling

      • StepScaling

      • SimpleScaling (default)

      • PredictiveScaling

      Returns:
      One of the following policy types:

      • TargetTrackingScaling

      • StepScaling

      • SimpleScaling (default)

      • PredictiveScaling

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

      Required if the policy type is StepScaling or SimpleScaling. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.

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

      Required if the policy type is StepScaling or SimpleScaling. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.

    • 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. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.

      Valid only if the policy type is StepScaling or SimpleScaling. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.

      Some Auto Scaling groups use instance weights. In this case, set the MinAdjustmentMagnitude to a value that is at least as large as your largest instance weight.

      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 Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.

      Valid only if the policy type is StepScaling or SimpleScaling. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.

      Some Auto Scaling groups use instance weights. In this case, set the MinAdjustmentMagnitude to a value that is at least as large as your largest instance weight.

    • 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. For exact capacity, you must specify a non-negative value.

      Required if the policy type is SimpleScaling. (Not used with any other policy type.)

      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. For exact capacity, you must specify a non-negative value.

      Required if the policy type is SimpleScaling. (Not used with any other policy type.)

    • cooldown

      public final Integer cooldown()

      A cooldown period, in seconds, that applies to a specific simple scaling policy. When a cooldown period is specified here, it overrides the default cooldown.

      Valid only if the policy type is SimpleScaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

      Default: None

      Returns:
      A cooldown period, in seconds, that applies to a specific simple scaling policy. When a cooldown period is specified here, it overrides the default cooldown.

      Valid only if the policy type is SimpleScaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

      Default: None

    • metricAggregationType

      public final String metricAggregationType()

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

      Valid only if the policy type is StepScaling.

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

      Valid only if the policy type is StepScaling.

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

      Required if the policy type is StepScaling. (Not used with any other policy type.)

      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.

      Required if the policy type is StepScaling. (Not used with any other policy type.)

    • estimatedInstanceWarmup

      public final Integer estimatedInstanceWarmup()

      Not needed if the default instance warmup is defined for the group.

      The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This warm-up period applies to instances launched due to a specific target tracking or step scaling policy. When a warm-up period is specified here, it overrides the default instance warmup.

      Valid only if the policy type is TargetTrackingScaling or StepScaling.

      The default is to use the value for the default instance warmup defined for the group. If default instance warmup is null, then EstimatedInstanceWarmup falls back to the value of default cooldown.

      Returns:
      Not needed if the default instance warmup is defined for the group.

      The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This warm-up period applies to instances launched due to a specific target tracking or step scaling policy. When a warm-up period is specified here, it overrides the default instance warmup.

      Valid only if the policy type is TargetTrackingScaling or StepScaling.

      The default is to use the value for the default instance warmup defined for the group. If default instance warmup is null, then EstimatedInstanceWarmup falls back to the value of default cooldown.

    • targetTrackingConfiguration

      public final TargetTrackingConfiguration targetTrackingConfiguration()

      A target tracking scaling policy. Provides support for predefined or custom metrics.

      The following predefined metrics are available:

      • ASGAverageCPUUtilization

      • ASGAverageNetworkIn

      • ASGAverageNetworkOut

      • ALBRequestCountPerTarget

      If you specify ALBRequestCountPerTarget for the metric, you must specify the ResourceLabel property with the PredefinedMetricSpecification.

      For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.

      Required if the policy type is TargetTrackingScaling.

      Returns:
      A target tracking scaling policy. Provides support for predefined or custom metrics.

      The following predefined metrics are available:

      • ASGAverageCPUUtilization

      • ASGAverageNetworkIn

      • ASGAverageNetworkOut

      • ALBRequestCountPerTarget

      If you specify ALBRequestCountPerTarget for the metric, you must specify the ResourceLabel property with the PredefinedMetricSpecification.

      For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.

      Required if the policy type is TargetTrackingScaling.

    • enabled

      public final Boolean enabled()

      Indicates whether the scaling policy is enabled or disabled. The default is enabled. For more information, see Disable a scaling policy for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

      Returns:
      Indicates whether the scaling policy is enabled or disabled. The default is enabled. For more information, see Disable a scaling policy for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

    • predictiveScalingConfiguration

      public final PredictiveScalingConfiguration predictiveScalingConfiguration()

      A predictive scaling policy. Provides support for predefined and custom metrics.

      Predefined metrics include CPU utilization, network in/out, and the Application Load Balancer request count.

      For more information, see PredictiveScalingConfiguration in the Amazon EC2 Auto Scaling API Reference.

      Required if the policy type is PredictiveScaling.

      Returns:
      A predictive scaling policy. Provides support for predefined and custom metrics.

      Predefined metrics include CPU utilization, network in/out, and the Application Load Balancer request count.

      For more information, see PredictiveScalingConfiguration in the Amazon EC2 Auto Scaling API Reference.

      Required if the policy type is PredictiveScaling.

    • toBuilder

      public PutScalingPolicyRequest.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<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>
      Specified by:
      toBuilder in class AutoScalingRequest
      Returns:
      a builder for type T

    • builder

      public static PutScalingPolicyRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutScalingPolicyRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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