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 to use with Application Auto Scaling.

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() A customized metric.
Boolean	getDisableScaleIn() Indicates whether scale in by the target tracking scaling 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, 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	setCustomizedMetricSpecification(CustomizedMetricSpecification customizedMetricSpecification) A customized metric.
void	setDisableScaleIn(Boolean disableScaleIn) Indicates whether scale in by the target tracking scaling 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, 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.
TargetTrackingScalingPolicyConfiguration	withCustomizedMetricSpecification(CustomizedMetricSpecification customizedMetricSpecification) A customized metric.
TargetTrackingScalingPolicyConfiguration	withDisableScaleIn(Boolean disableScaleIn) Indicates whether scale in by the target tracking scaling 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, to wait for a previous scale-out activity to take effect.
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. 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. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.

Parameters:

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. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.

getTargetValue

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. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.

Returns:

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. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.

withTargetValue

public TargetTrackingScalingPolicyConfiguration 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. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.

Parameters:

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. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.

Returns:

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

setPredefinedMetricSpecification

public void setPredefinedMetricSpecification(PredefinedMetricSpecification predefinedMetricSpecification)

A predefined metric. You can specify either a predefined metric or a customized metric.

Parameters:

predefinedMetricSpecification - A predefined metric. You can specify either a predefined metric or a customized metric.

getPredefinedMetricSpecification

public PredefinedMetricSpecification getPredefinedMetricSpecification()

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.

withPredefinedMetricSpecification

public TargetTrackingScalingPolicyConfiguration withPredefinedMetricSpecification(PredefinedMetricSpecification predefinedMetricSpecification)

A predefined metric. You can specify either a predefined metric or a customized metric.

Parameters:

predefinedMetricSpecification - 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.

setCustomizedMetricSpecification

public void setCustomizedMetricSpecification(CustomizedMetricSpecification customizedMetricSpecification)

A customized metric. You can specify either a predefined metric or a customized metric.

Parameters:

customizedMetricSpecification - A customized metric. You can specify either a predefined metric or a customized metric.

getCustomizedMetricSpecification

public CustomizedMetricSpecification getCustomizedMetricSpecification()

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.

withCustomizedMetricSpecification

public TargetTrackingScalingPolicyConfiguration withCustomizedMetricSpecification(CustomizedMetricSpecification customizedMetricSpecification)

A customized metric. You can specify either a predefined metric or a customized metric.

Parameters:

customizedMetricSpecification - 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.

setScaleOutCooldown

public void setScaleOutCooldown(Integer scaleOutCooldown)

The amount of time, in seconds, to wait for a previous scale-out activity to take effect.

With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Application 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. While the cooldown period is in effect, the capacity added by the initiating scale-out activity is calculated as part of the desired capacity for the next scale-out activity.

Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:

• AppStream 2.0 fleets

• Aurora DB clusters

• ECS services

• EMR clusters

• Neptune clusters

• SageMaker endpoint variants

• Spot Fleets

• Custom resources

For all other scalable targets, the default value is 0:

• Amazon Comprehend document classification and entity recognizer endpoints

• DynamoDB tables and global secondary indexes

• Amazon Keyspaces tables

• Lambda provisioned concurrency

• Amazon MSK broker storage

Parameters:

scaleOutCooldown - The amount of time, in seconds, to wait for a previous scale-out activity to take effect.

With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Application 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. While the cooldown period is in effect, the capacity added by the initiating scale-out activity is calculated as part of the desired capacity for the next scale-out activity.

Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:

• AppStream 2.0 fleets

• Aurora DB clusters

• ECS services

• EMR clusters

• Neptune clusters

• SageMaker endpoint variants

• Spot Fleets

• Custom resources

For all other scalable targets, the default value is 0:

• Amazon Comprehend document classification and entity recognizer endpoints

• DynamoDB tables and global secondary indexes

• Amazon Keyspaces tables

• Lambda provisioned concurrency

• Amazon MSK broker storage

getScaleOutCooldown

public Integer getScaleOutCooldown()

The amount of time, in seconds, to wait for a previous scale-out activity to take effect.

With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Application 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. While the cooldown period is in effect, the capacity added by the initiating scale-out activity is calculated as part of the desired capacity for the next scale-out activity.

Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:

• AppStream 2.0 fleets

• Aurora DB clusters

• ECS services

• EMR clusters

• Neptune clusters

• SageMaker endpoint variants

• Spot Fleets

• Custom resources

For all other scalable targets, the default value is 0:

• Amazon Comprehend document classification and entity recognizer endpoints

• DynamoDB tables and global secondary indexes

• Amazon Keyspaces tables

• Lambda provisioned concurrency

• Amazon MSK broker storage

Returns:

The amount of time, in seconds, to wait for a previous scale-out activity to take effect.

With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Application 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. While the cooldown period is in effect, the capacity added by the initiating scale-out activity is calculated as part of the desired capacity for the next scale-out activity.

Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:

• AppStream 2.0 fleets

• Aurora DB clusters

• ECS services

• EMR clusters

• Neptune clusters

• SageMaker endpoint variants

• Spot Fleets

• Custom resources

For all other scalable targets, the default value is 0:

• Amazon Comprehend document classification and entity recognizer endpoints

• DynamoDB tables and global secondary indexes

• Amazon Keyspaces tables

• Lambda provisioned concurrency

• Amazon MSK broker storage

withScaleOutCooldown

public TargetTrackingScalingPolicyConfiguration withScaleOutCooldown(Integer scaleOutCooldown)

The amount of time, in seconds, to wait for a previous scale-out activity to take effect.

With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Application 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. While the cooldown period is in effect, the capacity added by the initiating scale-out activity is calculated as part of the desired capacity for the next scale-out activity.

Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:

• AppStream 2.0 fleets

• Aurora DB clusters

• ECS services

• EMR clusters

• Neptune clusters

• SageMaker endpoint variants

• Spot Fleets

• Custom resources

For all other scalable targets, the default value is 0:

• Amazon Comprehend document classification and entity recognizer endpoints

• DynamoDB tables and global secondary indexes

• Amazon Keyspaces tables

• Lambda provisioned concurrency

• Amazon MSK broker storage

Parameters:

scaleOutCooldown - The amount of time, in seconds, to wait for a previous scale-out activity to take effect.

With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Application 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. While the cooldown period is in effect, the capacity added by the initiating scale-out activity is calculated as part of the desired capacity for the next scale-out activity.

Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:

• AppStream 2.0 fleets

• Aurora DB clusters

• ECS services

• EMR clusters

• Neptune clusters

• SageMaker endpoint variants

• Spot Fleets

• Custom resources

For all other scalable targets, the default value is 0:

• Amazon Comprehend document classification and entity recognizer endpoints

• DynamoDB tables and global secondary indexes

• Amazon Keyspaces tables

• Lambda provisioned concurrency

• Amazon MSK broker storage

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.

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, Application Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.

Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:

• AppStream 2.0 fleets

• Aurora DB clusters

• ECS services

• EMR clusters

• Neptune clusters

• SageMaker endpoint variants

• Spot Fleets

• Custom resources

For all other scalable targets, the default value is 0:

• Amazon Comprehend document classification and entity recognizer endpoints

• DynamoDB tables and global secondary indexes

• Amazon Keyspaces tables

• Lambda provisioned concurrency

• Amazon MSK broker storage

Parameters:

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

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, Application Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.

Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:

• AppStream 2.0 fleets

• Aurora DB clusters

• ECS services

• EMR clusters

• Neptune clusters

• SageMaker endpoint variants

• Spot Fleets

• Custom resources

For all other scalable targets, the default value is 0:

• Amazon Comprehend document classification and entity recognizer endpoints

• DynamoDB tables and global secondary indexes

• Amazon Keyspaces tables

• Lambda provisioned concurrency

• Amazon MSK broker storage

getScaleInCooldown

public Integer getScaleInCooldown()

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

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, Application Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.

Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:

• AppStream 2.0 fleets

• Aurora DB clusters

• ECS services

• EMR clusters

• Neptune clusters

• SageMaker endpoint variants

• Spot Fleets

• Custom resources

For all other scalable targets, the default value is 0:

• Amazon Comprehend document classification and entity recognizer endpoints

• DynamoDB tables and global secondary indexes

• Amazon Keyspaces tables

• Lambda provisioned concurrency

• Amazon MSK broker storage

Returns:

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

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, Application Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.

Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:

• AppStream 2.0 fleets

• Aurora DB clusters

• ECS services

• EMR clusters

• Neptune clusters

• SageMaker endpoint variants

• Spot Fleets

• Custom resources

For all other scalable targets, the default value is 0:

• Amazon Comprehend document classification and entity recognizer endpoints

• DynamoDB tables and global secondary indexes

• Amazon Keyspaces tables

• Lambda provisioned concurrency

• Amazon MSK broker storage

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.

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, Application Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.

Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:

• AppStream 2.0 fleets

• Aurora DB clusters

• ECS services

• EMR clusters

• Neptune clusters

• SageMaker endpoint variants

• Spot Fleets

• Custom resources

For all other scalable targets, the default value is 0:

• Amazon Comprehend document classification and entity recognizer endpoints

• DynamoDB tables and global secondary indexes

• Amazon Keyspaces tables

• Lambda provisioned concurrency

• Amazon MSK broker storage

Parameters:

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

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, Application Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.

Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:

• AppStream 2.0 fleets

• Aurora DB clusters

• ECS services

• EMR clusters

• Neptune clusters

• SageMaker endpoint variants

• Spot Fleets

• Custom resources

For all other scalable targets, the default value is 0:

• Amazon Comprehend document classification and entity recognizer endpoints

• DynamoDB tables and global secondary indexes

• Amazon Keyspaces tables

• Lambda provisioned concurrency

• Amazon MSK broker storage

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 won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. 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 won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. 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 won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. 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 won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false.

withDisableScaleIn

public TargetTrackingScalingPolicyConfiguration 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 won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. 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 won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. 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 won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. 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 won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false.

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 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.