software.amazon.awssdk.services.applicationautoscaling.model

Interface TargetTrackingScalingPolicyConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

TargetTrackingScalingPolicyConfiguration

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

Method Summary

Modifier and Type	Method and Description
default TargetTrackingScalingPolicyConfiguration.Builder	customizedMetricSpecification(Consumer<CustomizedMetricSpecification.Builder> customizedMetricSpecification) A customized metric.
TargetTrackingScalingPolicyConfiguration.Builder	customizedMetricSpecification(CustomizedMetricSpecification customizedMetricSpecification) A customized metric.
TargetTrackingScalingPolicyConfiguration.Builder	disableScaleIn(Boolean disableScaleIn) Indicates whether scale in by the target tracking scaling 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, to wait for a previous scale-out activity to take effect.
TargetTrackingScalingPolicyConfiguration.Builder	targetValue(Double targetValue) The target value for the metric.

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

equalsBySdkFields, 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

targetValue

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

predefinedMetricSpecification

TargetTrackingScalingPolicyConfiguration.Builder predefinedMetricSpecification(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.

predefinedMetricSpecification

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

A predefined metric. You can specify either a predefined metric or a customized 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)

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.

customizedMetricSpecification

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

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

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, 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 300 for the following scalable targets:

• ECS services

• Spot Fleet requests

• EMR clusters

• AppStream 2.0 fleets

• Aurora DB clusters

• Amazon SageMaker endpoint variants

• Custom resources

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

• DynamoDB tables

• DynamoDB global secondary indexes

• Amazon Comprehend document classification and entity recognizer endpoints

• Lambda provisioned concurrency

• Amazon Keyspaces tables

• 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 300 for the following scalable targets:

• ECS services

• Spot Fleet requests

• EMR clusters

• AppStream 2.0 fleets

• Aurora DB clusters

• Amazon SageMaker endpoint variants

• Custom resources

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

• DynamoDB tables

• DynamoDB global secondary indexes

• Amazon Comprehend document classification and entity recognizer endpoints

• Lambda provisioned concurrency

• Amazon Keyspaces tables

• Amazon MSK broker storage

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.

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 300 for the following scalable targets:

• ECS services

• Spot Fleet requests

• EMR clusters

• AppStream 2.0 fleets

• Aurora DB clusters

• Amazon SageMaker endpoint variants

• Custom resources

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

• DynamoDB tables

• DynamoDB global secondary indexes

• Amazon Comprehend document classification and entity recognizer endpoints

• Lambda provisioned concurrency

• Amazon Keyspaces tables

• 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 300 for the following scalable targets:

• ECS services

• Spot Fleet requests

• EMR clusters

• AppStream 2.0 fleets

• Aurora DB clusters

• Amazon SageMaker endpoint variants

• Custom resources

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

• DynamoDB tables

• DynamoDB global secondary indexes

• Amazon Comprehend document classification and entity recognizer endpoints

• Lambda provisioned concurrency

• Amazon Keyspaces tables

• Amazon MSK broker storage

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