TargetTrackingConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.autoscalingplans.model.TargetTrackingConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

TargetTrackingConfiguration()

Constructors
Constructor and Description
`TargetTrackingConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
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, 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 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, 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.
`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, after a scale-out activity completes before another scale-out activity can start.
`TargetTrackingConfiguration`	`withTargetValue(Double targetValue)` The target value for the metric.

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

- Constructor Detail
  - TargetTrackingConfiguration
```
public TargetTrackingConfiguration()
```
- Method Detail
  - setPredefinedScalingMetricSpecification
```
public void setPredefinedScalingMetricSpecification(PredefinedScalingMetricSpecification predefinedScalingMetricSpecification)
```
    A predefined metric. You can specify either a predefined metric or a customized metric.
    
    Parameters:
    
    predefinedScalingMetricSpecification - A predefined metric. You can specify either a predefined metric or a customized metric.
  - getPredefinedScalingMetricSpecification
```
public PredefinedScalingMetricSpecification getPredefinedScalingMetricSpecification()
```
    A predefined metric. You can specify either a predefined metric or a customized metric.
    
    Returns:
    
    A predefined metric. You can specify either a predefined metric or a customized metric.
  - withPredefinedScalingMetricSpecification
```
public TargetTrackingConfiguration withPredefinedScalingMetricSpecification(PredefinedScalingMetricSpecification predefinedScalingMetricSpecification)
```
    A predefined metric. You can specify either a predefined metric or a customized metric.
    
    Parameters:
    
    predefinedScalingMetricSpecification - A predefined metric. You can specify either a predefined metric or a customized metric.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCustomizedScalingMetricSpecification
```
public void setCustomizedScalingMetricSpecification(CustomizedScalingMetricSpecification customizedScalingMetricSpecification)
```
    A customized metric. You can specify either a predefined metric or a customized metric.
    
    Parameters:
    
    customizedScalingMetricSpecification - A customized metric. You can specify either a predefined metric or a customized metric.
  - getCustomizedScalingMetricSpecification
```
public CustomizedScalingMetricSpecification getCustomizedScalingMetricSpecification()
```
    A customized metric. You can specify either a predefined metric or a customized metric.
    
    Returns:
    
    A customized metric. You can specify either a predefined metric or a customized metric.
  - withCustomizedScalingMetricSpecification
```
public TargetTrackingConfiguration withCustomizedScalingMetricSpecification(CustomizedScalingMetricSpecification customizedScalingMetricSpecification)
```
    A customized metric. You can specify either a predefined metric or a customized metric.
    
    Parameters:
    
    customizedScalingMetricSpecification - A customized metric. You can specify either a predefined metric or a customized metric.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 TargetTrackingConfiguration 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.
  - setDisableScaleIn
```
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.
    
    Parameters:
    
    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.
  - getDisableScaleIn
```
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.
    
    Returns:
    
    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.
  - withDisableScaleIn
```
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.
    
    Parameters:
    
    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.
    
    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 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.
    
    Returns:
    
    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.
  - 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. This value is not used if the scalable resource is an Auto Scaling group.
    
    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. This value is not used if the scalable resource is an Auto Scaling group.
    
    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. This value is not used if the scalable resource is an Auto Scaling group.
    
    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. This value is not used if the scalable resource is an Auto Scaling group.
    
    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 TargetTrackingConfiguration withScaleOutCooldown(Integer scaleOutCooldown)
```
    The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start. This value is not used if the scalable resource is an Auto Scaling group.
    
    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. This value is not used if the scalable resource is an Auto Scaling group.
    
    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. This value is not used if the scalable resource is an Auto Scaling group.
    
    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, AWS 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. This value is not used if the scalable resource is an Auto Scaling group.
    
    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, AWS 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. This value is not used if the scalable resource is an Auto Scaling group.
    
    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, AWS 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. This value is not used if the scalable resource is an Auto Scaling group.
    
    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, AWS Auto Scaling scales out your scalable target immediately.
  - withScaleInCooldown
```
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 value is not used if the scalable resource is an Auto Scaling group.
    
    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, AWS 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. This value is not used if the scalable resource is an Auto Scaling group.
    
    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, AWS Auto Scaling scales out your scalable target immediately.
    
    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. This value is used only if the resource is an Auto Scaling group.
    
    Parameters:
    
    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.
  - getEstimatedInstanceWarmup
```
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.
    
    Returns:
    
    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.
  - withEstimatedInstanceWarmup
```
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.
    
    Parameters:
    
    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.
    
    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. 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 TargetTrackingConfiguration 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.

Did this page help you?

Class TargetTrackingConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TargetTrackingConfiguration

Method Detail

setPredefinedScalingMetricSpecification

getPredefinedScalingMetricSpecification

withPredefinedScalingMetricSpecification

setCustomizedScalingMetricSpecification

getCustomizedScalingMetricSpecification

withCustomizedScalingMetricSpecification

setTargetValue

getTargetValue

withTargetValue

setDisableScaleIn

getDisableScaleIn

withDisableScaleIn

isDisableScaleIn

setScaleOutCooldown

getScaleOutCooldown

withScaleOutCooldown

setScaleInCooldown

getScaleInCooldown

withScaleInCooldown

setEstimatedInstanceWarmup

getEstimatedInstanceWarmup

withEstimatedInstanceWarmup

toString

equals

hashCode

clone

marshall