Class StepAdjustment
- java.lang.Object
-
- com.amazonaws.services.autoscaling.model.StepAdjustment
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class StepAdjustment extends Object implements Serializable, Cloneable
Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm.
For the following examples, suppose that you have an alarm with a breach threshold of 50:
-
If you want the adjustment to be triggered when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.
-
If you want the adjustment to be triggered when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.
There are a few rules for the step adjustments for your step policy:
-
The ranges of your step adjustments can't overlap or have a gap.
-
At most one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.
-
At most one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.
-
The upper and lower bound can't be null in the same step adjustment.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description StepAdjustment()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StepAdjustment
clone()
boolean
equals(Object obj)
Double
getMetricIntervalLowerBound()
The lower bound for the difference between the alarm threshold and the CloudWatch metric.Double
getMetricIntervalUpperBound()
The upper bound for the difference between the alarm threshold and the CloudWatch metric.Integer
getScalingAdjustment()
The amount by which to scale, based on the specified adjustment type.int
hashCode()
void
setMetricIntervalLowerBound(Double metricIntervalLowerBound)
The lower bound for the difference between the alarm threshold and the CloudWatch metric.void
setMetricIntervalUpperBound(Double metricIntervalUpperBound)
The upper bound for the difference between the alarm threshold and the CloudWatch metric.void
setScalingAdjustment(Integer scalingAdjustment)
The amount by which to scale, based on the specified adjustment type.String
toString()
Returns a string representation of this object; useful for testing and debugging.StepAdjustment
withMetricIntervalLowerBound(Double metricIntervalLowerBound)
The lower bound for the difference between the alarm threshold and the CloudWatch metric.StepAdjustment
withMetricIntervalUpperBound(Double metricIntervalUpperBound)
The upper bound for the difference between the alarm threshold and the CloudWatch metric.StepAdjustment
withScalingAdjustment(Integer scalingAdjustment)
The amount by which to scale, based on the specified adjustment type.
-
-
-
Method Detail
-
setMetricIntervalLowerBound
public void setMetricIntervalLowerBound(Double metricIntervalLowerBound)
The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.
- Parameters:
metricIntervalLowerBound
- The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.
-
getMetricIntervalLowerBound
public Double getMetricIntervalLowerBound()
The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.
- Returns:
- The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.
-
withMetricIntervalLowerBound
public StepAdjustment withMetricIntervalLowerBound(Double metricIntervalLowerBound)
The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.
- Parameters:
metricIntervalLowerBound
- The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMetricIntervalUpperBound
public void setMetricIntervalUpperBound(Double metricIntervalUpperBound)
The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.
The upper bound must be greater than the lower bound.
- Parameters:
metricIntervalUpperBound
- The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.The upper bound must be greater than the lower bound.
-
getMetricIntervalUpperBound
public Double getMetricIntervalUpperBound()
The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.
The upper bound must be greater than the lower bound.
- Returns:
- The upper bound for the difference between the alarm threshold
and the CloudWatch metric. If the metric value is above the
breach threshold, the upper bound is exclusive (the metric must
be less than the threshold plus the upper bound). Otherwise, it
is inclusive (the metric must be less than or equal to the
threshold plus the upper bound). A null value indicates positive
infinity.
The upper bound must be greater than the lower bound.
-
withMetricIntervalUpperBound
public StepAdjustment withMetricIntervalUpperBound(Double metricIntervalUpperBound)
The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.
The upper bound must be greater than the lower bound.
- Parameters:
metricIntervalUpperBound
- The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.The upper bound must be greater than the lower bound.
- 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 StepAdjustment 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.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public StepAdjustment clone()
-
-