com.amazonaws.services.applicationautoscaling.model

Class StepAdjustment

java.lang.Object

com.amazonaws.services.applicationautoscaling.model.StepAdjustment

All Implemented Interfaces:

Serializable, Cloneable

public class StepAdjustment
extends Object
implements Serializable, Cloneable

An object representing a step adjustment for a StepScalingPolicyConfiguration. 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 and Description
StepAdjustment()

Method Summary

Methods

Modifier and Type	Method and 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.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StepAdjustment

public StepAdjustment()

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 scalable dimension while a negative number removes from the current scalable dimension.

Parameters:

scalingAdjustment - The amount by which to scale, based on the specified adjustment type. A positive value adds to the current scalable dimension while a negative number removes from the current scalable dimension.

getScalingAdjustment

public Integer getScalingAdjustment()

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current scalable dimension while a negative number removes from the current scalable dimension.

Returns:

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current scalable dimension while a negative number removes from the current scalable dimension.

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 scalable dimension while a negative number removes from the current scalable dimension.

Parameters:

scalingAdjustment - The amount by which to scale, based on the specified adjustment type. A positive value adds to the current scalable dimension while a negative number removes from the current scalable dimension.

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 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 StepAdjustment clone()

Overrides:

clone in class Object