software.amazon.awssdk.services.applicationautoscaling.model

Interface StepScalingPolicyConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

StepScalingPolicyConfiguration

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

Method Summary

Modifier and Type	Method and Description
StepScalingPolicyConfiguration.Builder	adjustmentType(AdjustmentType adjustmentType) Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted (for example, an absolute number or a percentage).
StepScalingPolicyConfiguration.Builder	adjustmentType(String adjustmentType) Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted (for example, an absolute number or a percentage).
StepScalingPolicyConfiguration.Builder	cooldown(Integer cooldown) The amount of time, in seconds, to wait for a previous scaling activity to take effect.
StepScalingPolicyConfiguration.Builder	metricAggregationType(MetricAggregationType metricAggregationType) The aggregation type for the CloudWatch metrics.
StepScalingPolicyConfiguration.Builder	metricAggregationType(String metricAggregationType) The aggregation type for the CloudWatch metrics.
StepScalingPolicyConfiguration.Builder	minAdjustmentMagnitude(Integer minAdjustmentMagnitude) The minimum value to scale by when the adjustment type is PercentChangeInCapacity.
StepScalingPolicyConfiguration.Builder	stepAdjustments(Collection<StepAdjustment> stepAdjustments) A set of adjustments that enable you to scale based on the size of the alarm breach.
StepScalingPolicyConfiguration.Builder	stepAdjustments(Consumer<StepAdjustment.Builder>... stepAdjustments) A set of adjustments that enable you to scale based on the size of the alarm breach.
StepScalingPolicyConfiguration.Builder	stepAdjustments(StepAdjustment... stepAdjustments) A set of adjustments that enable you to scale based on the size of the alarm breach.

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

adjustmentType

StepScalingPolicyConfiguration.Builder adjustmentType(String adjustmentType)

Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

AdjustmentType is required if you are adding a new step scaling policy configuration.

Parameters:

adjustmentType - Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

AdjustmentType is required if you are adding a new step scaling policy configuration.

Returns:

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

See Also:

AdjustmentType, AdjustmentType

adjustmentType

StepScalingPolicyConfiguration.Builder adjustmentType(AdjustmentType adjustmentType)

Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

AdjustmentType is required if you are adding a new step scaling policy configuration.

Parameters:

adjustmentType - Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

AdjustmentType is required if you are adding a new step scaling policy configuration.

Returns:

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

See Also:

AdjustmentType, AdjustmentType

stepAdjustments

StepScalingPolicyConfiguration.Builder stepAdjustments(Collection<StepAdjustment> stepAdjustments)

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

At least one step adjustment is required if you are adding a new step scaling policy configuration.

Parameters:

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

At least one step adjustment is required if you are adding a new step scaling policy configuration.

Returns:

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

stepAdjustments

StepScalingPolicyConfiguration.Builder stepAdjustments(StepAdjustment... stepAdjustments)

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

At least one step adjustment is required if you are adding a new step scaling policy configuration.

Parameters:

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

At least one step adjustment is required if you are adding a new step scaling policy configuration.

Returns:

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

stepAdjustments

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

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

At least one step adjustment is required if you are adding a new step scaling policy configuration.

This is a convenience method that creates an instance of the StepAdjustment.Builder avoiding the need to create one manually via StepAdjustment.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #stepAdjustments(List).

Parameters:

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

Returns:

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

See Also:

#stepAdjustments(java.util.Collection)

minAdjustmentMagnitude

StepScalingPolicyConfiguration.Builder minAdjustmentMagnitude(Integer minAdjustmentMagnitude)

The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks.

Parameters:

minAdjustmentMagnitude - The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks.

Returns:

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

cooldown

StepScalingPolicyConfiguration.Builder cooldown(Integer cooldown)

The amount of time, in seconds, to wait for a previous scaling activity to take effect. If not specified, the default value is 300. For more information, see Cooldown period in the Application Auto Scaling User Guide.

Parameters:

cooldown - The amount of time, in seconds, to wait for a previous scaling activity to take effect. If not specified, the default value is 300. For more information, see Cooldown period in the Application Auto Scaling User Guide.

Returns:

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

metricAggregationType

StepScalingPolicyConfiguration.Builder metricAggregationType(String metricAggregationType)

The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.

Parameters:

metricAggregationType - The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.

Returns:

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

See Also:

MetricAggregationType, MetricAggregationType

metricAggregationType

StepScalingPolicyConfiguration.Builder metricAggregationType(MetricAggregationType metricAggregationType)

The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.

Parameters:

metricAggregationType - The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.

Returns:

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

See Also:

MetricAggregationType, MetricAggregationType