ScalingPolicy (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.autoscaling.model.ScalingPolicy

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ScalingPolicy
extends Object
implements Serializable, Cloneable

Describes a scaling policy.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ScalingPolicy()

Constructors
Constructor and Description
`ScalingPolicy()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ScalingPolicy`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAdjustmentType()` The adjustment type, which specifies how `ScalingAdjustment` is interpreted.
`List<Alarm>`	`getAlarms()` The CloudWatch alarms related to the policy.
`String`	`getAutoScalingGroupName()` The name of the Auto Scaling group.
`Integer`	`getCooldown()` The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.
`Boolean`	`getEnabled()` Indicates whether the policy is enabled (`true`) or disabled (`false`).
`Integer`	`getEstimatedInstanceWarmup()` The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
`String`	`getMetricAggregationType()` The aggregation type for the CloudWatch metrics.
`Integer`	`getMinAdjustmentMagnitude()` The minimum number of instances to scale.
`Integer`	`getMinAdjustmentStep()` Available for backward compatibility.
`String`	`getPolicyARN()` The Amazon Resource Name (ARN) of the policy.
`String`	`getPolicyName()` The name of the scaling policy.
`String`	`getPolicyType()` The policy type.
`Integer`	`getScalingAdjustment()` The amount by which to scale, based on the specified adjustment type.
`List<StepAdjustment>`	`getStepAdjustments()` A set of adjustments that enable you to scale based on the size of the alarm breach.
`TargetTrackingConfiguration`	`getTargetTrackingConfiguration()` A target tracking scaling policy.
`int`	`hashCode()`
`Boolean`	`isEnabled()` Indicates whether the policy is enabled (`true`) or disabled (`false`).
`void`	`setAdjustmentType(String adjustmentType)` The adjustment type, which specifies how `ScalingAdjustment` is interpreted.
`void`	`setAlarms(Collection<Alarm> alarms)` The CloudWatch alarms related to the policy.
`void`	`setAutoScalingGroupName(String autoScalingGroupName)` The name of the Auto Scaling group.
`void`	`setCooldown(Integer cooldown)` The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.
`void`	`setEnabled(Boolean enabled)` Indicates whether the policy is enabled (`true`) or disabled (`false`).
`void`	`setEstimatedInstanceWarmup(Integer estimatedInstanceWarmup)` The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
`void`	`setMetricAggregationType(String metricAggregationType)` The aggregation type for the CloudWatch metrics.
`void`	`setMinAdjustmentMagnitude(Integer minAdjustmentMagnitude)` The minimum number of instances to scale.
`void`	`setMinAdjustmentStep(Integer minAdjustmentStep)` Available for backward compatibility.
`void`	`setPolicyARN(String policyARN)` The Amazon Resource Name (ARN) of the policy.
`void`	`setPolicyName(String policyName)` The name of the scaling policy.
`void`	`setPolicyType(String policyType)` The policy type.
`void`	`setScalingAdjustment(Integer scalingAdjustment)` The amount by which to scale, based on the specified adjustment type.
`void`	`setStepAdjustments(Collection<StepAdjustment> stepAdjustments)` A set of adjustments that enable you to scale based on the size of the alarm breach.
`void`	`setTargetTrackingConfiguration(TargetTrackingConfiguration targetTrackingConfiguration)` A target tracking scaling policy.
`String`	`toString()` Returns a string representation of this object.
`ScalingPolicy`	`withAdjustmentType(String adjustmentType)` The adjustment type, which specifies how `ScalingAdjustment` is interpreted.
`ScalingPolicy`	`withAlarms(Alarm... alarms)` The CloudWatch alarms related to the policy.
`ScalingPolicy`	`withAlarms(Collection<Alarm> alarms)` The CloudWatch alarms related to the policy.
`ScalingPolicy`	`withAutoScalingGroupName(String autoScalingGroupName)` The name of the Auto Scaling group.
`ScalingPolicy`	`withCooldown(Integer cooldown)` The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.
`ScalingPolicy`	`withEnabled(Boolean enabled)` Indicates whether the policy is enabled (`true`) or disabled (`false`).
`ScalingPolicy`	`withEstimatedInstanceWarmup(Integer estimatedInstanceWarmup)` The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
`ScalingPolicy`	`withMetricAggregationType(String metricAggregationType)` The aggregation type for the CloudWatch metrics.
`ScalingPolicy`	`withMinAdjustmentMagnitude(Integer minAdjustmentMagnitude)` The minimum number of instances to scale.
`ScalingPolicy`	`withMinAdjustmentStep(Integer minAdjustmentStep)` Available for backward compatibility.
`ScalingPolicy`	`withPolicyARN(String policyARN)` The Amazon Resource Name (ARN) of the policy.
`ScalingPolicy`	`withPolicyName(String policyName)` The name of the scaling policy.
`ScalingPolicy`	`withPolicyType(String policyType)` The policy type.
`ScalingPolicy`	`withScalingAdjustment(Integer scalingAdjustment)` The amount by which to scale, based on the specified adjustment type.
`ScalingPolicy`	`withStepAdjustments(Collection<StepAdjustment> stepAdjustments)` A set of adjustments that enable you to scale based on the size of the alarm breach.
`ScalingPolicy`	`withStepAdjustments(StepAdjustment... stepAdjustments)` A set of adjustments that enable you to scale based on the size of the alarm breach.
`ScalingPolicy`	`withTargetTrackingConfiguration(TargetTrackingConfiguration targetTrackingConfiguration)` A target tracking scaling policy.

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

- Constructor Detail
  - ScalingPolicy
```
public ScalingPolicy()
```
- Method Detail
  - setAutoScalingGroupName
```
public void setAutoScalingGroupName(String autoScalingGroupName)
```
    The name of the Auto Scaling group.
    
    Parameters:
    
    autoScalingGroupName - The name of the Auto Scaling group.
  - getAutoScalingGroupName
```
public String getAutoScalingGroupName()
```
    The name of the Auto Scaling group.
    
    Returns:
    
    The name of the Auto Scaling group.
  - withAutoScalingGroupName
```
public ScalingPolicy withAutoScalingGroupName(String autoScalingGroupName)
```
    The name of the Auto Scaling group.
    
    Parameters:
    
    autoScalingGroupName - The name of the Auto Scaling group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPolicyName
```
public void setPolicyName(String policyName)
```
    The name of the scaling policy.
    
    Parameters:
    
    policyName - The name of the scaling policy.
  - getPolicyName
```
public String getPolicyName()
```
    The name of the scaling policy.
    
    Returns:
    
    The name of the scaling policy.
  - withPolicyName
```
public ScalingPolicy withPolicyName(String policyName)
```
    The name of the scaling policy.
    
    Parameters:
    
    policyName - The name of the scaling policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPolicyARN
```
public void setPolicyARN(String policyARN)
```
    The Amazon Resource Name (ARN) of the policy.
    
    Parameters:
    
    policyARN - The Amazon Resource Name (ARN) of the policy.
  - getPolicyARN
```
public String getPolicyARN()
```
    The Amazon Resource Name (ARN) of the policy.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the policy.
  - withPolicyARN
```
public ScalingPolicy withPolicyARN(String policyARN)
```
    The Amazon Resource Name (ARN) of the policy.
    
    Parameters:
    
    policyARN - The Amazon Resource Name (ARN) of the policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPolicyType
```
public void setPolicyType(String policyType)
```
    The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling.
    
    Parameters:
    
    policyType - The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling.
  - getPolicyType
```
public String getPolicyType()
```
    The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling.
    
    Returns:
    
    The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling.
  - withPolicyType
```
public ScalingPolicy withPolicyType(String policyType)
```
    The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling.
    
    Parameters:
    
    policyType - The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAdjustmentType
```
public void setAdjustmentType(String adjustmentType)
```
    The adjustment type, which specifies how ScalingAdjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
    
    Parameters:
    
    adjustmentType - The adjustment type, which specifies how ScalingAdjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
  - getAdjustmentType
```
public String getAdjustmentType()
```
    The adjustment type, which specifies how ScalingAdjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
    
    Returns:
    
    The adjustment type, which specifies how ScalingAdjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
  - withAdjustmentType
```
public ScalingPolicy withAdjustmentType(String adjustmentType)
```
    The adjustment type, which specifies how ScalingAdjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
    
    Parameters:
    
    adjustmentType - The adjustment type, which specifies how ScalingAdjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMinAdjustmentStep
```
public void setMinAdjustmentStep(Integer minAdjustmentStep)
```
    Available for backward compatibility. Use MinAdjustmentMagnitude instead.
    
    Parameters:
    
    minAdjustmentStep - Available for backward compatibility. Use MinAdjustmentMagnitude instead.
  - getMinAdjustmentStep
```
public Integer getMinAdjustmentStep()
```
    Available for backward compatibility. Use MinAdjustmentMagnitude instead.
    
    Returns:
    
    Available for backward compatibility. Use MinAdjustmentMagnitude instead.
  - withMinAdjustmentStep
```
public ScalingPolicy withMinAdjustmentStep(Integer minAdjustmentStep)
```
    Available for backward compatibility. Use MinAdjustmentMagnitude instead.
    
    Parameters:
    
    minAdjustmentStep - Available for backward compatibility. Use MinAdjustmentMagnitude instead.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMinAdjustmentMagnitude
```
public void setMinAdjustmentMagnitude(Integer minAdjustmentMagnitude)
```
    The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.
    
    Parameters:
    
    minAdjustmentMagnitude - The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.
  - getMinAdjustmentMagnitude
```
public Integer getMinAdjustmentMagnitude()
```
    The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.
    
    Returns:
    
    The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.
  - withMinAdjustmentMagnitude
```
public ScalingPolicy withMinAdjustmentMagnitude(Integer minAdjustmentMagnitude)
```
    The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.
    
    Parameters:
    
    minAdjustmentMagnitude - The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setScalingAdjustment
```
public void setScalingAdjustment(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.
    
    Parameters:
    
    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.
  - getScalingAdjustment
```
public Integer getScalingAdjustment()
```
    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.
  - withScalingAdjustment
```
public ScalingPolicy withScalingAdjustment(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCooldown
```
public void setCooldown(Integer cooldown)
```
    The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.
    
    Parameters:
    
    cooldown - The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.
  - getCooldown
```
public Integer getCooldown()
```
    The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.
    
    Returns:
    
    The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.
  - withCooldown
```
public ScalingPolicy withCooldown(Integer cooldown)
```
    The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.
    
    Parameters:
    
    cooldown - The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getStepAdjustments
```
public List<StepAdjustment> getStepAdjustments()
```
    A set of adjustments that enable you to scale based on the size of the alarm breach.
    
    Returns:
    
    A set of adjustments that enable you to scale based on the size of the alarm breach.
  - setStepAdjustments
```
public void setStepAdjustments(Collection<StepAdjustment> stepAdjustments)
```
    A set of adjustments that enable you to scale based on the size of the alarm breach.
    
    Parameters:
    
    stepAdjustments - A set of adjustments that enable you to scale based on the size of the alarm breach.
  - withStepAdjustments
```
public ScalingPolicy withStepAdjustments(StepAdjustment... stepAdjustments)
```
    A set of adjustments that enable you to scale based on the size of the alarm breach.
    
    NOTE: This method appends the values to the existing list (if any). Use setStepAdjustments(java.util.Collection) or withStepAdjustments(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    stepAdjustments - A set of adjustments that enable you to scale based on the size of the alarm breach.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withStepAdjustments
```
public ScalingPolicy withStepAdjustments(Collection<StepAdjustment> stepAdjustments)
```
    A set of adjustments that enable you to scale based on the size of the alarm breach.
    
    Parameters:
    
    stepAdjustments - A set of adjustments that enable you to scale based on the size of the alarm breach.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetricAggregationType
```
public void setMetricAggregationType(String metricAggregationType)
```
    The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.
    
    Parameters:
    
    metricAggregationType - The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.
  - getMetricAggregationType
```
public String getMetricAggregationType()
```
    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.
  - withMetricAggregationType
```
public ScalingPolicy withMetricAggregationType(String metricAggregationType)
```
    The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.
    
    Parameters:
    
    metricAggregationType - The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEstimatedInstanceWarmup
```
public void setEstimatedInstanceWarmup(Integer estimatedInstanceWarmup)
```
    The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
    
    Parameters:
    
    estimatedInstanceWarmup - The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
  - getEstimatedInstanceWarmup
```
public Integer getEstimatedInstanceWarmup()
```
    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.
  - withEstimatedInstanceWarmup
```
public ScalingPolicy withEstimatedInstanceWarmup(Integer estimatedInstanceWarmup)
```
    The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
    
    Parameters:
    
    estimatedInstanceWarmup - The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAlarms
```
public List<Alarm> getAlarms()
```
    The CloudWatch alarms related to the policy.
    
    Returns:
    
    The CloudWatch alarms related to the policy.
  - setAlarms
```
public void setAlarms(Collection<Alarm> alarms)
```
    The CloudWatch alarms related to the policy.
    
    Parameters:
    
    alarms - The CloudWatch alarms related to the policy.
  - withAlarms
```
public ScalingPolicy withAlarms(Alarm... alarms)
```
    The CloudWatch alarms related to the policy.
    
    NOTE: This method appends the values to the existing list (if any). Use setAlarms(java.util.Collection) or withAlarms(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    alarms - The CloudWatch alarms related to the policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAlarms
```
public ScalingPolicy withAlarms(Collection<Alarm> alarms)
```
    The CloudWatch alarms related to the policy.
    
    Parameters:
    
    alarms - The CloudWatch alarms related to the policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTargetTrackingConfiguration
```
public void setTargetTrackingConfiguration(TargetTrackingConfiguration targetTrackingConfiguration)
```
    A target tracking scaling policy.
    
    Parameters:
    
    targetTrackingConfiguration - A target tracking scaling policy.
  - getTargetTrackingConfiguration
```
public TargetTrackingConfiguration getTargetTrackingConfiguration()
```
    A target tracking scaling policy.
    
    Returns:
    
    A target tracking scaling policy.
  - withTargetTrackingConfiguration
```
public ScalingPolicy withTargetTrackingConfiguration(TargetTrackingConfiguration targetTrackingConfiguration)
```
    A target tracking scaling policy.
    
    Parameters:
    
    targetTrackingConfiguration - A target tracking scaling policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnabled
```
public void setEnabled(Boolean enabled)
```
    Indicates whether the policy is enabled (true) or disabled (false).
    
    Parameters:
    
    enabled - Indicates whether the policy is enabled (true) or disabled (false).
  - getEnabled
```
public Boolean getEnabled()
```
    Indicates whether the policy is enabled (true) or disabled (false).
    
    Returns:
    
    Indicates whether the policy is enabled (true) or disabled (false).
  - withEnabled
```
public ScalingPolicy withEnabled(Boolean enabled)
```
    Indicates whether the policy is enabled (true) or disabled (false).
    
    Parameters:
    
    enabled - Indicates whether the policy is enabled (true) or disabled (false).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnabled
```
public Boolean isEnabled()
```
    Indicates whether the policy is enabled (true) or disabled (false).
    
    Returns:
    
    Indicates whether the policy is enabled (true) or disabled (false).
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ScalingPolicy clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class ScalingPolicy

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ScalingPolicy

Method Detail

setAutoScalingGroupName

getAutoScalingGroupName

withAutoScalingGroupName

setPolicyName

getPolicyName

withPolicyName

setPolicyARN

getPolicyARN

withPolicyARN

setPolicyType

getPolicyType

withPolicyType

setAdjustmentType

getAdjustmentType

withAdjustmentType

setMinAdjustmentStep

getMinAdjustmentStep

withMinAdjustmentStep

setMinAdjustmentMagnitude

getMinAdjustmentMagnitude

withMinAdjustmentMagnitude

setScalingAdjustment

getScalingAdjustment

withScalingAdjustment

setCooldown

getCooldown

withCooldown

getStepAdjustments

setStepAdjustments

withStepAdjustments

withStepAdjustments

setMetricAggregationType

getMetricAggregationType

withMetricAggregationType

setEstimatedInstanceWarmup

getEstimatedInstanceWarmup

withEstimatedInstanceWarmup

getAlarms

setAlarms

withAlarms

withAlarms

setTargetTrackingConfiguration

getTargetTrackingConfiguration

withTargetTrackingConfiguration

setEnabled

getEnabled

withEnabled

isEnabled

toString

equals

hashCode

clone