software.amazon.awssdk.services.autoscalingplans.model

Interface TargetTrackingConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<TargetTrackingConfiguration.Builder,TargetTrackingConfiguration>, SdkBuilder<TargetTrackingConfiguration.Builder,TargetTrackingConfiguration>, SdkPojo

Enclosing class:

TargetTrackingConfiguration

public static interface TargetTrackingConfiguration.Builder
extends SdkPojo, CopyableBuilder<TargetTrackingConfiguration.Builder,TargetTrackingConfiguration>

Method Summary

Modifier and Type	Method and Description
default TargetTrackingConfiguration.Builder	customizedScalingMetricSpecification(Consumer<CustomizedScalingMetricSpecification.Builder> customizedScalingMetricSpecification) A customized metric.
TargetTrackingConfiguration.Builder	customizedScalingMetricSpecification(CustomizedScalingMetricSpecification customizedScalingMetricSpecification) A customized metric.
TargetTrackingConfiguration.Builder	disableScaleIn(Boolean disableScaleIn) Indicates whether scale in by the target tracking scaling policy is disabled.
TargetTrackingConfiguration.Builder	estimatedInstanceWarmup(Integer estimatedInstanceWarmup) The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
default TargetTrackingConfiguration.Builder	predefinedScalingMetricSpecification(Consumer<PredefinedScalingMetricSpecification.Builder> predefinedScalingMetricSpecification) A predefined metric.
TargetTrackingConfiguration.Builder	predefinedScalingMetricSpecification(PredefinedScalingMetricSpecification predefinedScalingMetricSpecification) A predefined metric.
TargetTrackingConfiguration.Builder	scaleInCooldown(Integer scaleInCooldown) The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.
TargetTrackingConfiguration.Builder	scaleOutCooldown(Integer scaleOutCooldown) The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.
TargetTrackingConfiguration.Builder	targetValue(Double targetValue) The target value for the metric.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

predefinedScalingMetricSpecification

TargetTrackingConfiguration.Builder predefinedScalingMetricSpecification(PredefinedScalingMetricSpecification predefinedScalingMetricSpecification)

A predefined metric.

Parameters:

predefinedScalingMetricSpecification - A predefined metric.

Returns:

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

predefinedScalingMetricSpecification

default TargetTrackingConfiguration.Builder predefinedScalingMetricSpecification(Consumer<PredefinedScalingMetricSpecification.Builder> predefinedScalingMetricSpecification)

A predefined metric.

This is a convenience that creates an instance of the PredefinedScalingMetricSpecification.Builder avoiding the need to create one manually via PredefinedScalingMetricSpecification.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to predefinedScalingMetricSpecification(PredefinedScalingMetricSpecification).

Parameters:

predefinedScalingMetricSpecification - a consumer that will call methods on PredefinedScalingMetricSpecification.Builder

Returns:

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

See Also:

predefinedScalingMetricSpecification(PredefinedScalingMetricSpecification)

customizedScalingMetricSpecification

TargetTrackingConfiguration.Builder customizedScalingMetricSpecification(CustomizedScalingMetricSpecification customizedScalingMetricSpecification)

A customized metric.

Parameters:

customizedScalingMetricSpecification - A customized metric.

Returns:

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

customizedScalingMetricSpecification

default TargetTrackingConfiguration.Builder customizedScalingMetricSpecification(Consumer<CustomizedScalingMetricSpecification.Builder> customizedScalingMetricSpecification)

A customized metric.

This is a convenience that creates an instance of the CustomizedScalingMetricSpecification.Builder avoiding the need to create one manually via CustomizedScalingMetricSpecification.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customizedScalingMetricSpecification(CustomizedScalingMetricSpecification).

Parameters:

customizedScalingMetricSpecification - a consumer that will call methods on CustomizedScalingMetricSpecification.Builder

Returns:

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

See Also:

customizedScalingMetricSpecification(CustomizedScalingMetricSpecification)

targetValue

TargetTrackingConfiguration.Builder targetValue(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.

disableScaleIn

TargetTrackingConfiguration.Builder disableScaleIn(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.

scaleOutCooldown

TargetTrackingConfiguration.Builder scaleOutCooldown(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.

scaleInCooldown

TargetTrackingConfiguration.Builder scaleInCooldown(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.

estimatedInstanceWarmup

TargetTrackingConfiguration.Builder estimatedInstanceWarmup(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.