ScalingPolicy (AWS Java SDK :: Services :: Auto Scaling 2.20.29 API)

java.lang.Object
- software.amazon.awssdk.services.autoscaling.model.ScalingPolicy

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ScalingPolicy.Builder,ScalingPolicy>

@Generated(value="software.amazon.awssdk:codegen")
public final class ScalingPolicy
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ScalingPolicy.Builder,ScalingPolicy>

Describes a scaling policy.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ScalingPolicy.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ScalingPolicy.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`adjustmentType()` Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage).
`List<Alarm>`	`alarms()` The CloudWatch alarms related to the policy.
`String`	`autoScalingGroupName()` The name of the Auto Scaling group.
`static ScalingPolicy.Builder`	`builder()`
`Integer`	`cooldown()` The duration of the policy's cooldown period, in seconds.
`Boolean`	`enabled()` Indicates whether the policy is enabled (`true`) or disabled (`false`).
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Integer`	`estimatedInstanceWarmup()` The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAlarms()` For responses, this returns true if the service returned a value for the Alarms property.
`int`	`hashCode()`
`boolean`	`hasStepAdjustments()` For responses, this returns true if the service returned a value for the StepAdjustments property.
`String`	`metricAggregationType()` The aggregation type for the CloudWatch metrics.
`Integer`	`minAdjustmentMagnitude()` The minimum value to scale by when the adjustment type is `PercentChangeInCapacity`.
`Integer`	`minAdjustmentStep()` Available for backward compatibility.
`String`	`policyARN()` The Amazon Resource Name (ARN) of the policy.
`String`	`policyName()` The name of the scaling policy.
`String`	`policyType()` One of the following policy types:
`PredictiveScalingConfiguration`	`predictiveScalingConfiguration()` A predictive scaling policy.
`Integer`	`scalingAdjustment()` The amount by which to scale, based on the specified adjustment type.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ScalingPolicy.Builder>`	`serializableBuilderClass()`
`List<StepAdjustment>`	`stepAdjustments()` A set of adjustments that enable you to scale based on the size of the alarm breach.
`TargetTrackingConfiguration`	`targetTrackingConfiguration()` A target tracking scaling policy.
`ScalingPolicy.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ScalingPolicy.Builder,ScalingPolicy>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class ScalingPolicy

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

autoScalingGroupName

policyName

policyARN

policyType

adjustmentType

minAdjustmentStep

minAdjustmentMagnitude

scalingAdjustment

cooldown

hasStepAdjustments

stepAdjustments

metricAggregationType

estimatedInstanceWarmup

hasAlarms

alarms

targetTrackingConfiguration

enabled

predictiveScalingConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields