software.amazon.awssdk.services.applicationautoscaling.model

Interface TargetTrackingScalingPolicyConfiguration.Builder

All Superinterfaces:

CopyableBuilder<TargetTrackingScalingPolicyConfiguration.Builder,TargetTrackingScalingPolicyConfiguration>, SdkBuilder<TargetTrackingScalingPolicyConfiguration.Builder,TargetTrackingScalingPolicyConfiguration>

Enclosing class:

TargetTrackingScalingPolicyConfiguration

public static interface TargetTrackingScalingPolicyConfiguration.Builder
extends CopyableBuilder<TargetTrackingScalingPolicyConfiguration.Builder,TargetTrackingScalingPolicyConfiguration>

Method Summary

Modifier and Type	Method and Description
default TargetTrackingScalingPolicyConfiguration.Builder	customizedMetricSpecification(Consumer<CustomizedMetricSpecification.Builder> customizedMetricSpecification) Reserved for future use.
TargetTrackingScalingPolicyConfiguration.Builder	customizedMetricSpecification(CustomizedMetricSpecification customizedMetricSpecification) Reserved for future use.
TargetTrackingScalingPolicyConfiguration.Builder	disableScaleIn(Boolean disableScaleIn) Indicates whether scale in by the target tracking policy is disabled.
default TargetTrackingScalingPolicyConfiguration.Builder	predefinedMetricSpecification(Consumer<PredefinedMetricSpecification.Builder> predefinedMetricSpecification) A predefined metric.
TargetTrackingScalingPolicyConfiguration.Builder	predefinedMetricSpecification(PredefinedMetricSpecification predefinedMetricSpecification) A predefined metric.
TargetTrackingScalingPolicyConfiguration.Builder	scaleInCooldown(Integer scaleInCooldown) The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.
TargetTrackingScalingPolicyConfiguration.Builder	scaleOutCooldown(Integer scaleOutCooldown) The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.
TargetTrackingScalingPolicyConfiguration.Builder	targetValue(Double targetValue) The target value for the metric.

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

targetValue

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

predefinedMetricSpecification

TargetTrackingScalingPolicyConfiguration.Builder predefinedMetricSpecification(PredefinedMetricSpecification predefinedMetricSpecification)

A predefined metric.

Parameters:

predefinedMetricSpecification - A predefined metric.

Returns:

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

predefinedMetricSpecification

default TargetTrackingScalingPolicyConfiguration.Builder predefinedMetricSpecification(Consumer<PredefinedMetricSpecification.Builder> predefinedMetricSpecification)

A predefined metric.

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

Parameters:

predefinedMetricSpecification - a consumer that will call methods on PredefinedMetricSpecification.Builder

Returns:

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

See Also:

predefinedMetricSpecification(PredefinedMetricSpecification)

customizedMetricSpecification

TargetTrackingScalingPolicyConfiguration.Builder customizedMetricSpecification(CustomizedMetricSpecification customizedMetricSpecification)

Reserved for future use.

Parameters:

customizedMetricSpecification - Reserved for future use.

Returns:

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

customizedMetricSpecification

default TargetTrackingScalingPolicyConfiguration.Builder customizedMetricSpecification(Consumer<CustomizedMetricSpecification.Builder> customizedMetricSpecification)

Reserved for future use.

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

Parameters:

customizedMetricSpecification - a consumer that will call methods on CustomizedMetricSpecification.Builder

Returns:

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

See Also:

customizedMetricSpecification(CustomizedMetricSpecification)

scaleOutCooldown

TargetTrackingScalingPolicyConfiguration.Builder scaleOutCooldown(Integer scaleOutCooldown)

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

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.

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

TargetTrackingScalingPolicyConfiguration.Builder scaleInCooldown(Integer scaleInCooldown)

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

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

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, Application Auto Scaling scales out your scalable target immediately.

Returns:

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

disableScaleIn

TargetTrackingScalingPolicyConfiguration.Builder disableScaleIn(Boolean disableScaleIn)

Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

Parameters:

disableScaleIn - Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking 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.