com.amazonaws.services.applicationautoscaling.model

Class TargetTrackingScalingPolicyConfiguration

java.lang.Object

com.amazonaws.services.applicationautoscaling.model.TargetTrackingScalingPolicyConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Represents a target tracking scaling policy configuration.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
TargetTrackingScalingPolicyConfiguration()

Method Summary

Modifier and Type	Method and Description
TargetTrackingScalingPolicyConfiguration	clone()
boolean	equals(Object obj)
CustomizedMetricSpecification	getCustomizedMetricSpecification() Reserved for future use.
Boolean	getDisableScaleIn() Indicates whether scale in by the target tracking policy is disabled.
PredefinedMetricSpecification	getPredefinedMetricSpecification() A predefined metric.
Integer	getScaleInCooldown() The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.
Integer	getScaleOutCooldown() The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.
Double	getTargetValue() The target value for the metric.
int	hashCode()
Boolean	isDisableScaleIn() Indicates whether scale in by the target tracking policy is disabled.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setCustomizedMetricSpecification(CustomizedMetricSpecification customizedMetricSpecification) Reserved for future use.
void	setDisableScaleIn(Boolean disableScaleIn) Indicates whether scale in by the target tracking policy is disabled.
void	setPredefinedMetricSpecification(PredefinedMetricSpecification predefinedMetricSpecification) A predefined metric.
void	setScaleInCooldown(Integer scaleInCooldown) The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.
void	setScaleOutCooldown(Integer scaleOutCooldown) The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.
void	setTargetValue(Double targetValue) The target value for the metric.
String	toString() Returns a string representation of this object; useful for testing and debugging.
TargetTrackingScalingPolicyConfiguration	withCustomizedMetricSpecification(CustomizedMetricSpecification customizedMetricSpecification) Reserved for future use.
TargetTrackingScalingPolicyConfiguration	withDisableScaleIn(Boolean disableScaleIn) Indicates whether scale in by the target tracking policy is disabled.
TargetTrackingScalingPolicyConfiguration	withPredefinedMetricSpecification(PredefinedMetricSpecification predefinedMetricSpecification) A predefined metric.
TargetTrackingScalingPolicyConfiguration	withScaleInCooldown(Integer scaleInCooldown) The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.
TargetTrackingScalingPolicyConfiguration	withScaleOutCooldown(Integer scaleOutCooldown) The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.
TargetTrackingScalingPolicyConfiguration	withTargetValue(Double targetValue) The target value for the metric.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TargetTrackingScalingPolicyConfiguration

public TargetTrackingScalingPolicyConfiguration()

Method Detail

setTargetValue

public void setTargetValue(Double targetValue)

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

Parameters:

targetValue - The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

getTargetValue

public Double getTargetValue()

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

Returns:

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

withTargetValue

public TargetTrackingScalingPolicyConfiguration withTargetValue(Double targetValue)

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

Parameters:

targetValue - The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

Returns:

Returns a reference to this object so that method calls can be chained together.

setPredefinedMetricSpecification

public void setPredefinedMetricSpecification(PredefinedMetricSpecification predefinedMetricSpecification)

A predefined metric.

Parameters:

predefinedMetricSpecification - A predefined metric.

getPredefinedMetricSpecification

public PredefinedMetricSpecification getPredefinedMetricSpecification()

A predefined metric.

Returns:

A predefined metric.

withPredefinedMetricSpecification

public TargetTrackingScalingPolicyConfiguration withPredefinedMetricSpecification(PredefinedMetricSpecification predefinedMetricSpecification)

A predefined metric.

Parameters:

predefinedMetricSpecification - A predefined metric.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCustomizedMetricSpecification

public void setCustomizedMetricSpecification(CustomizedMetricSpecification customizedMetricSpecification)

Reserved for future use.

Parameters:

customizedMetricSpecification - Reserved for future use.

getCustomizedMetricSpecification

public CustomizedMetricSpecification getCustomizedMetricSpecification()

Reserved for future use.

Returns:

Reserved for future use.

withCustomizedMetricSpecification

public TargetTrackingScalingPolicyConfiguration withCustomizedMetricSpecification(CustomizedMetricSpecification customizedMetricSpecification)

Reserved for future use.

Parameters:

customizedMetricSpecification - Reserved for future use.

Returns:

Returns a reference to this object so that method calls can be chained together.

setScaleOutCooldown

public void setScaleOutCooldown(Integer scaleOutCooldown)

The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.

While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.

Parameters:

scaleOutCooldown - The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.

While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.

getScaleOutCooldown

public Integer getScaleOutCooldown()

The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.

While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.

Returns:

The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.

While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.

withScaleOutCooldown

public TargetTrackingScalingPolicyConfiguration withScaleOutCooldown(Integer scaleOutCooldown)

The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.

While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.

Parameters:

scaleOutCooldown - The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.

While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.

Returns:

Returns a reference to this object so that method calls can be chained together.

setScaleInCooldown

public void setScaleInCooldown(Integer scaleInCooldown)

The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.

The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.

Parameters:

scaleInCooldown - The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.

The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.

getScaleInCooldown

public Integer getScaleInCooldown()

The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.

The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.

Returns:

The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.

The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.

withScaleInCooldown

public TargetTrackingScalingPolicyConfiguration withScaleInCooldown(Integer scaleInCooldown)

The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.

The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.

Parameters:

scaleInCooldown - The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.

The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDisableScaleIn

public void setDisableScaleIn(Boolean disableScaleIn)

Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

Parameters:

disableScaleIn - Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

getDisableScaleIn

public Boolean getDisableScaleIn()

Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

Returns:

Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

withDisableScaleIn

public TargetTrackingScalingPolicyConfiguration withDisableScaleIn(Boolean disableScaleIn)

Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

Parameters:

disableScaleIn - Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

Returns:

Returns a reference to this object so that method calls can be chained together.

isDisableScaleIn

public Boolean isDisableScaleIn()

Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

Returns:

Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

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

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.