@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class TargetTrackingConfiguration extends Object implements Serializable, Cloneable, StructuredPojo
Describes a target tracking configuration to use with AWS Auto Scaling. Used with ScalingInstruction and ScalingPolicy.
Constructor and Description |
---|
TargetTrackingConfiguration() |
Modifier and Type | Method and Description |
---|---|
TargetTrackingConfiguration |
clone() |
boolean |
equals(Object obj) |
CustomizedScalingMetricSpecification |
getCustomizedScalingMetricSpecification()
A customized metric.
|
Boolean |
getDisableScaleIn()
Indicates whether scale in by the target tracking scaling policy is disabled.
|
Integer |
getEstimatedInstanceWarmup()
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
|
PredefinedScalingMetricSpecification |
getPredefinedScalingMetricSpecification()
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, to wait for a previous scale-out activity to take effect.
|
Double |
getTargetValue()
The target value for the metric.
|
int |
hashCode() |
Boolean |
isDisableScaleIn()
Indicates whether scale in by the target tracking scaling policy is disabled.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCustomizedScalingMetricSpecification(CustomizedScalingMetricSpecification customizedScalingMetricSpecification)
A customized metric.
|
void |
setDisableScaleIn(Boolean disableScaleIn)
Indicates whether scale in by the target tracking scaling policy is disabled.
|
void |
setEstimatedInstanceWarmup(Integer estimatedInstanceWarmup)
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
|
void |
setPredefinedScalingMetricSpecification(PredefinedScalingMetricSpecification predefinedScalingMetricSpecification)
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, to wait for a previous scale-out activity to take effect.
|
void |
setTargetValue(Double targetValue)
The target value for the metric.
|
String |
toString()
Returns a string representation of this object.
|
TargetTrackingConfiguration |
withCustomizedScalingMetricSpecification(CustomizedScalingMetricSpecification customizedScalingMetricSpecification)
A customized metric.
|
TargetTrackingConfiguration |
withDisableScaleIn(Boolean disableScaleIn)
Indicates whether scale in by the target tracking scaling policy is disabled.
|
TargetTrackingConfiguration |
withEstimatedInstanceWarmup(Integer estimatedInstanceWarmup)
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
|
TargetTrackingConfiguration |
withPredefinedScalingMetricSpecification(PredefinedScalingMetricSpecification predefinedScalingMetricSpecification)
A predefined metric.
|
TargetTrackingConfiguration |
withScaleInCooldown(Integer scaleInCooldown)
The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
|
TargetTrackingConfiguration |
withScaleOutCooldown(Integer scaleOutCooldown)
The amount of time, in seconds, to wait for a previous scale-out activity to take effect.
|
TargetTrackingConfiguration |
withTargetValue(Double targetValue)
The target value for the metric.
|
public void setPredefinedScalingMetricSpecification(PredefinedScalingMetricSpecification predefinedScalingMetricSpecification)
A predefined metric. You can specify either a predefined metric or a customized metric.
predefinedScalingMetricSpecification
- A predefined metric. You can specify either a predefined metric or a customized metric.public PredefinedScalingMetricSpecification getPredefinedScalingMetricSpecification()
A predefined metric. You can specify either a predefined metric or a customized metric.
public TargetTrackingConfiguration withPredefinedScalingMetricSpecification(PredefinedScalingMetricSpecification predefinedScalingMetricSpecification)
A predefined metric. You can specify either a predefined metric or a customized metric.
predefinedScalingMetricSpecification
- A predefined metric. You can specify either a predefined metric or a customized metric.public void setCustomizedScalingMetricSpecification(CustomizedScalingMetricSpecification customizedScalingMetricSpecification)
A customized metric. You can specify either a predefined metric or a customized metric.
customizedScalingMetricSpecification
- A customized metric. You can specify either a predefined metric or a customized metric.public CustomizedScalingMetricSpecification getCustomizedScalingMetricSpecification()
A customized metric. You can specify either a predefined metric or a customized metric.
public TargetTrackingConfiguration withCustomizedScalingMetricSpecification(CustomizedScalingMetricSpecification customizedScalingMetricSpecification)
A customized metric. You can specify either a predefined metric or a customized metric.
customizedScalingMetricSpecification
- A customized metric. You can specify either a predefined metric or a customized metric.public void setTargetValue(Double targetValue)
The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360.
targetValue
- The target value for the metric. Although this property accepts numbers of type Double, it won't accept
values that are either too small or too large. Values must be in the range of -2^360 to 2^360.public Double getTargetValue()
The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360.
public TargetTrackingConfiguration withTargetValue(Double targetValue)
The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360.
targetValue
- The target value for the metric. Although this property accepts numbers of type Double, it won't accept
values that are either too small or too large. Values must be in the range of -2^360 to 2^360.public void setDisableScaleIn(Boolean disableScaleIn)
Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true
,
scale in is disabled and the target tracking scaling policy doesn't remove capacity from the scalable resource.
Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable
resource.
The default value is false
.
disableScaleIn
- Indicates whether scale in by the target tracking scaling policy is disabled. If the value is
true
, scale in is disabled and the target tracking scaling policy doesn't remove capacity
from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can
remove capacity from the scalable resource.
The default value is false
.
public Boolean getDisableScaleIn()
Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true
,
scale in is disabled and the target tracking scaling policy doesn't remove capacity from the scalable resource.
Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable
resource.
The default value is false
.
true
, scale in is disabled and the target tracking scaling policy doesn't remove capacity
from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can
remove capacity from the scalable resource.
The default value is false
.
public TargetTrackingConfiguration withDisableScaleIn(Boolean disableScaleIn)
Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true
,
scale in is disabled and the target tracking scaling policy doesn't remove capacity from the scalable resource.
Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable
resource.
The default value is false
.
disableScaleIn
- Indicates whether scale in by the target tracking scaling policy is disabled. If the value is
true
, scale in is disabled and the target tracking scaling policy doesn't remove capacity
from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can
remove capacity from the scalable resource.
The default value is false
.
public Boolean isDisableScaleIn()
Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true
,
scale in is disabled and the target tracking scaling policy doesn't remove capacity from the scalable resource.
Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable
resource.
The default value is false
.
true
, scale in is disabled and the target tracking scaling policy doesn't remove capacity
from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can
remove capacity from the scalable resource.
The default value is false
.
public void setScaleOutCooldown(Integer scaleOutCooldown)
The amount of time, in seconds, to wait for a previous scale-out activity to take effect. This property is not used if the scalable resource is an Auto Scaling group.
With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends.
scaleOutCooldown
- The amount of time, in seconds, to wait for a previous scale-out activity to take effect. This property is
not used if the scalable resource is an Auto Scaling group.
With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends.
public Integer getScaleOutCooldown()
The amount of time, in seconds, to wait for a previous scale-out activity to take effect. This property is not used if the scalable resource is an Auto Scaling group.
With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends.
With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends.
public TargetTrackingConfiguration withScaleOutCooldown(Integer scaleOutCooldown)
The amount of time, in seconds, to wait for a previous scale-out activity to take effect. This property is not used if the scalable resource is an Auto Scaling group.
With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends.
scaleOutCooldown
- The amount of time, in seconds, to wait for a previous scale-out activity to take effect. This property is
not used if the scalable resource is an Auto Scaling group.
With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends.
public void setScaleInCooldown(Integer scaleInCooldown)
The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. This property is not used if the scalable resource is an Auto Scaling group.
With the scale-in cooldown period, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.
scaleInCooldown
- The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can
start. This property is not used if the scalable resource is an Auto Scaling group.
With the scale-in cooldown period, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.
public Integer getScaleInCooldown()
The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. This property is not used if the scalable resource is an Auto Scaling group.
With the scale-in cooldown period, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.
With the scale-in cooldown period, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.
public TargetTrackingConfiguration withScaleInCooldown(Integer scaleInCooldown)
The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. This property is not used if the scalable resource is an Auto Scaling group.
With the scale-in cooldown period, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.
scaleInCooldown
- The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can
start. This property is not used if the scalable resource is an Auto Scaling group.
With the scale-in cooldown period, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.
public void setEstimatedInstanceWarmup(Integer estimatedInstanceWarmup)
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.
estimatedInstanceWarmup
- The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
This value is used only if the resource is an Auto Scaling group.public Integer getEstimatedInstanceWarmup()
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.
public TargetTrackingConfiguration withEstimatedInstanceWarmup(Integer estimatedInstanceWarmup)
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.
estimatedInstanceWarmup
- The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
This value is used only if the resource is an Auto Scaling group.public String toString()
toString
in class Object
Object.toString()
public TargetTrackingConfiguration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.