Package software.amazon.awssdk.services.autoscaling.model

Interface PutScalingPolicyRequest.Builder

All Superinterfaces:

CopyableBuilder<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>, SdkBuilder<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>

Enclosing class:

PutScalingPolicyRequest

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

Method Summary

Modifier and Type	Method	Description
PutScalingPolicyRequest.Builder	adjustmentType(String adjustmentType)	The adjustment type.
PutScalingPolicyRequest.Builder	autoScalingGroupName(String autoScalingGroupName)	The name or ARN of the group.
PutScalingPolicyRequest.Builder	cooldown(Integer cooldown)	The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start.
PutScalingPolicyRequest.Builder	estimatedInstanceWarmup(Integer estimatedInstanceWarmup)	The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
PutScalingPolicyRequest.Builder	metricAggregationType(String metricAggregationType)	The aggregation type for the CloudWatch metrics.
PutScalingPolicyRequest.Builder	minAdjustmentMagnitude(Integer minAdjustmentMagnitude)	The minimum number of instances to scale.
PutScalingPolicyRequest.Builder	minAdjustmentStep(Integer minAdjustmentStep)	Available for backward compatibility.
PutScalingPolicyRequest.Builder	policyName(String policyName)	The name of the policy.
PutScalingPolicyRequest.Builder	policyType(String policyType)	The policy type.
PutScalingPolicyRequest.Builder	scalingAdjustment(Integer scalingAdjustment)	The amount by which to scale, based on the specified adjustment type.
PutScalingPolicyRequest.Builder	stepAdjustments(Collection<StepAdjustment> stepAdjustments)	A set of adjustments that enable you to scale based on the size of the alarm breach.
PutScalingPolicyRequest.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.utils.builder.CopyableBuilder

copy

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

apply, build

Method Detail

autoScalingGroupName

PutScalingPolicyRequest.Builder autoScalingGroupName(String autoScalingGroupName)

The name or ARN of the group.

Parameters:

autoScalingGroupName - The name or ARN of the group.

Returns:

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

policyName

PutScalingPolicyRequest.Builder policyName(String policyName)

The name of the policy.

Parameters:

policyName - The name of the policy.

Returns:

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

policyType

PutScalingPolicyRequest.Builder policyType(String policyType)

The policy type. Valid values are SimpleScaling and StepScaling. If the policy type is null, the value is treated as SimpleScaling.

Parameters:

policyType - The policy type. Valid values are SimpleScaling and StepScaling. If the policy type is null, the value is treated as SimpleScaling.

Returns:

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

adjustmentType

PutScalingPolicyRequest.Builder adjustmentType(String adjustmentType)

The adjustment type. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

For more information, see Dynamic Scaling in the Auto Scaling User Guide.

Parameters:

adjustmentType - The adjustment type. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

For more information, see Dynamic Scaling in the Auto Scaling User Guide.

Returns:

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

minAdjustmentStep

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

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

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

This parameter is required if the policy type is SimpleScaling and not supported otherwise.

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.

This parameter is required if the policy type is SimpleScaling and not supported otherwise.

Returns:

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

cooldown

PutScalingPolicyRequest.Builder cooldown(Integer cooldown)

The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies.

This parameter is not supported unless the policy type is SimpleScaling.

For more information, see Auto Scaling Cooldowns in the Auto Scaling User Guide.

Parameters:

cooldown - The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies.

This parameter is not supported unless the policy type is SimpleScaling.

For more information, see Auto Scaling Cooldowns in the Auto Scaling User Guide.

Returns:

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

metricAggregationType

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

This parameter is not supported if the policy type is SimpleScaling.

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.

This parameter is not supported if the policy type is SimpleScaling.

Returns:

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

stepAdjustments

PutScalingPolicyRequest.Builder stepAdjustments(Collection<StepAdjustment> stepAdjustments)

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

This parameter is required if the policy type is StepScaling and not supported otherwise.

Parameters:

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

This parameter is required if the policy type is StepScaling and not supported otherwise.

Returns:

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

stepAdjustments

PutScalingPolicyRequest.Builder stepAdjustments(StepAdjustment... stepAdjustments)

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

This parameter is required if the policy type is StepScaling and not supported otherwise.

NOTE: This method appends the values to the existing list (if any). Use #setStepAdjustments(java.util.Collection) or #withStepAdjustments(java.util.Collection) if you want to override the existing values.

Parameters:

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

This parameter is required if the policy type is StepScaling and not supported otherwise.

Returns:

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

estimatedInstanceWarmup

PutScalingPolicyRequest.Builder estimatedInstanceWarmup(Integer estimatedInstanceWarmup)

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.

This parameter is not supported if the policy type is SimpleScaling.

Parameters:

estimatedInstanceWarmup - The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.

This parameter is not supported if the policy type is SimpleScaling.

Returns:

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