software.amazon.awssdk.services.autoscaling.model

Interface ScalingPolicy.Builder

All Superinterfaces:

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

Enclosing class:

ScalingPolicy

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

Method Summary

Modifier and Type	Method and Description
ScalingPolicy.Builder	adjustmentType(String adjustmentType) The adjustment type, which specifies how ScalingAdjustment is interpreted.
ScalingPolicy.Builder	alarms(Alarm... alarms) The CloudWatch alarms related to the policy.
ScalingPolicy.Builder	alarms(Collection<Alarm> alarms) The CloudWatch alarms related to the policy.
ScalingPolicy.Builder	alarms(Consumer<Alarm.Builder>... alarms) The CloudWatch alarms related to the policy.
ScalingPolicy.Builder	autoScalingGroupName(String autoScalingGroupName) The name of the Auto Scaling group.
ScalingPolicy.Builder	cooldown(Integer cooldown) The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.
ScalingPolicy.Builder	estimatedInstanceWarmup(Integer estimatedInstanceWarmup) The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
ScalingPolicy.Builder	metricAggregationType(String metricAggregationType) The aggregation type for the CloudWatch metrics.
ScalingPolicy.Builder	minAdjustmentMagnitude(Integer minAdjustmentMagnitude) The minimum number of instances to scale.
ScalingPolicy.Builder	minAdjustmentStep(Integer minAdjustmentStep) Available for backward compatibility.
ScalingPolicy.Builder	policyARN(String policyARN) The Amazon Resource Name (ARN) of the policy.
ScalingPolicy.Builder	policyName(String policyName) The name of the scaling policy.
ScalingPolicy.Builder	policyType(String policyType) The policy type.
ScalingPolicy.Builder	scalingAdjustment(Integer scalingAdjustment) The amount by which to scale, based on the specified adjustment type.
ScalingPolicy.Builder	stepAdjustments(Collection<StepAdjustment> stepAdjustments) A set of adjustments that enable you to scale based on the size of the alarm breach.
ScalingPolicy.Builder	stepAdjustments(Consumer<StepAdjustment.Builder>... stepAdjustments) A set of adjustments that enable you to scale based on the size of the alarm breach.
ScalingPolicy.Builder	stepAdjustments(StepAdjustment... stepAdjustments) A set of adjustments that enable you to scale based on the size of the alarm breach.
default ScalingPolicy.Builder	targetTrackingConfiguration(Consumer<TargetTrackingConfiguration.Builder> targetTrackingConfiguration) A target tracking scaling policy.
ScalingPolicy.Builder	targetTrackingConfiguration(TargetTrackingConfiguration targetTrackingConfiguration) A target tracking scaling policy.

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

autoScalingGroupName

ScalingPolicy.Builder autoScalingGroupName(String autoScalingGroupName)

The name of the Auto Scaling group.

Parameters:

autoScalingGroupName - The name of the Auto Scaling group.

Returns:

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

policyName

ScalingPolicy.Builder policyName(String policyName)

The name of the scaling policy.

Parameters:

policyName - The name of the scaling policy.

Returns:

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

policyARN

ScalingPolicy.Builder policyARN(String policyARN)

The Amazon Resource Name (ARN) of the policy.

Parameters:

policyARN - The Amazon Resource Name (ARN) of the policy.

Returns:

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

policyType

ScalingPolicy.Builder policyType(String policyType)

The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling.

Parameters:

policyType - The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling.

Returns:

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

adjustmentType

ScalingPolicy.Builder adjustmentType(String adjustmentType)

The adjustment type, which specifies how ScalingAdjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

Parameters:

adjustmentType - The adjustment type, which specifies how ScalingAdjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

Returns:

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

minAdjustmentStep

ScalingPolicy.Builder minAdjustmentStep(Integer minAdjustmentStep)

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

Parameters:

minAdjustmentStep - Available for backward compatibility. Use MinAdjustmentMagnitude instead.

Returns:

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

minAdjustmentMagnitude

ScalingPolicy.Builder minAdjustmentMagnitude(Integer minAdjustmentMagnitude)

The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.

Parameters:

minAdjustmentMagnitude - The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.

Returns:

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

scalingAdjustment

ScalingPolicy.Builder scalingAdjustment(Integer scalingAdjustment)

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

Parameters:

scalingAdjustment - The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

Returns:

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

cooldown

ScalingPolicy.Builder cooldown(Integer cooldown)

The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.

Parameters:

cooldown - The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.

Returns:

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

stepAdjustments

ScalingPolicy.Builder stepAdjustments(Collection<StepAdjustment> stepAdjustments)

A set of adjustments that enable you to scale based on the size of the alarm breach.

Parameters:

stepAdjustments - A set of adjustments that enable you to scale based on the size of the alarm breach.

Returns:

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

stepAdjustments

ScalingPolicy.Builder stepAdjustments(StepAdjustment... stepAdjustments)

A set of adjustments that enable you to scale based on the size of the alarm breach.

Parameters:

stepAdjustments - A set of adjustments that enable you to scale based on the size of the alarm breach.

Returns:

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

stepAdjustments

ScalingPolicy.Builder stepAdjustments(Consumer<StepAdjustment.Builder>... stepAdjustments)

A set of adjustments that enable you to scale based on the size of the alarm breach.

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

Parameters:

stepAdjustments - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#stepAdjustments(List)

metricAggregationType

ScalingPolicy.Builder metricAggregationType(String metricAggregationType)

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.

Parameters:

metricAggregationType - The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.

Returns:

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

estimatedInstanceWarmup

ScalingPolicy.Builder estimatedInstanceWarmup(Integer estimatedInstanceWarmup)

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

Parameters:

estimatedInstanceWarmup - The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

Returns:

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

alarms

ScalingPolicy.Builder alarms(Collection<Alarm> alarms)

The CloudWatch alarms related to the policy.

Parameters:

alarms - The CloudWatch alarms related to the policy.

Returns:

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

alarms

ScalingPolicy.Builder alarms(Alarm... alarms)

The CloudWatch alarms related to the policy.

Parameters:

alarms - The CloudWatch alarms related to the policy.

Returns:

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

alarms

ScalingPolicy.Builder alarms(Consumer<Alarm.Builder>... alarms)

The CloudWatch alarms related to the policy.

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

Parameters:

alarms - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#alarms(List)

targetTrackingConfiguration

ScalingPolicy.Builder targetTrackingConfiguration(TargetTrackingConfiguration targetTrackingConfiguration)

A target tracking scaling policy.

Parameters:

targetTrackingConfiguration - A target tracking scaling policy.

Returns:

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

targetTrackingConfiguration

default ScalingPolicy.Builder targetTrackingConfiguration(Consumer<TargetTrackingConfiguration.Builder> targetTrackingConfiguration)

A target tracking scaling policy.

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

Parameters:

targetTrackingConfiguration - a consumer that will call methods on TargetTrackingConfiguration.Builder

Returns:

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

See Also:

targetTrackingConfiguration(TargetTrackingConfiguration)