software.amazon.awssdk.services.autoscalingplans.model

Class TargetTrackingConfiguration

java.lang.Object

software.amazon.awssdk.services.autoscalingplans.model.TargetTrackingConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TargetTrackingConfiguration.Builder,TargetTrackingConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class TargetTrackingConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TargetTrackingConfiguration.Builder,TargetTrackingConfiguration>

Describes a target tracking configuration. Used with ScalingInstruction and ScalingPolicy.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TargetTrackingConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static TargetTrackingConfiguration.Builder	builder()
CustomizedScalingMetricSpecification	customizedScalingMetricSpecification() A customized metric.
Boolean	disableScaleIn() Indicates whether scale in by the target tracking scaling policy is disabled.
boolean	equals(Object obj)
Integer	estimatedInstanceWarmup() The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
PredefinedScalingMetricSpecification	predefinedScalingMetricSpecification() A predefined metric.
Integer	scaleInCooldown() The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.
Integer	scaleOutCooldown() The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.
List<SdkField<?>>	sdkFields()
static Class<? extends TargetTrackingConfiguration.Builder>	serializableBuilderClass()
Double	targetValue() The target value for the metric.
TargetTrackingConfiguration.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

predefinedScalingMetricSpecification

public PredefinedScalingMetricSpecification predefinedScalingMetricSpecification()

A predefined metric.

Returns:

A predefined metric.

customizedScalingMetricSpecification

public CustomizedScalingMetricSpecification customizedScalingMetricSpecification()

A customized metric.

Returns:

A customized metric.

targetValue

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

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

disableScaleIn

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

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.

scaleOutCooldown

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

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.

scaleInCooldown

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

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.

estimatedInstanceWarmup

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

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.

toBuilder

public TargetTrackingConfiguration.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<TargetTrackingConfiguration.Builder,TargetTrackingConfiguration>

Returns:

a builder for type T

builder

public static TargetTrackingConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends TargetTrackingConfiguration.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.