software.amazon.awssdk.services.autoscaling.model

Interface PutScalingPolicyRequest.Builder

All Superinterfaces:

AutoScalingRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>, SdkBuilder<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

PutScalingPolicyRequest

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

Method Summary

Modifier and Type	Method and Description
PutScalingPolicyRequest.Builder	adjustmentType(String adjustmentType) Specifies whether the ScalingAdjustment parameter is an absolute number or a percentage of the current capacity.
PutScalingPolicyRequest.Builder	autoScalingGroupName(String autoScalingGroupName) The name of the Auto Scaling group.
PutScalingPolicyRequest.Builder	cooldown(Integer cooldown) The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities 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	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
PutScalingPolicyRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
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 a simple scaling policy scales the Auto Scaling group in response to an alarm breach.
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(Consumer<StepAdjustment.Builder>... 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.
default PutScalingPolicyRequest.Builder	targetTrackingConfiguration(Consumer<TargetTrackingConfiguration.Builder> targetTrackingConfiguration) A target tracking scaling policy.
PutScalingPolicyRequest.Builder	targetTrackingConfiguration(TargetTrackingConfiguration targetTrackingConfiguration) A target tracking scaling policy.

Methods inherited from interface software.amazon.awssdk.services.autoscaling.model.AutoScalingRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

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

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. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling. If the policy type is null, the value is treated as SimpleScaling.

Parameters:

policyType - The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling. 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)

Specifies whether the ScalingAdjustment parameter is an absolute number or a percentage of the current capacity. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

Valid only if the policy type is StepScaling or SimpleScaling. For more information, see Scaling Adjustment Types in the Amazon EC2 Auto Scaling User Guide.

Parameters:

adjustmentType - Specifies whether the ScalingAdjustment parameter is an absolute number or a percentage of the current capacity. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

Valid only if the policy type is StepScaling or SimpleScaling. For more information, see Scaling Adjustment Types in the Amazon EC2 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.

This property replaces the MinAdjustmentStep property. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.

Valid only if the policy type is SimpleScaling or StepScaling.

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.

This property replaces the MinAdjustmentStep property. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.

Valid only if the policy type is SimpleScaling or StepScaling.

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 a simple scaling policy scales the Auto Scaling group in response to an alarm breach. The adjustment is based on the value that you specified in the AdjustmentType parameter (either an absolute number or a percentage). A positive value adds to the current capacity and a negative value subtracts from the current capacity. For exact capacity, you must specify a positive value.

Conditional: If you specify SimpleScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)

Parameters:

scalingAdjustment - The amount by which a simple scaling policy scales the Auto Scaling group in response to an alarm breach. The adjustment is based on the value that you specified in the AdjustmentType parameter (either an absolute number or a percentage). A positive value adds to the current capacity and a negative value subtracts from the current capacity. For exact capacity, you must specify a positive value.

Conditional: If you specify SimpleScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)

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 before any further dynamic scaling activities can start. If this parameter is not specified, the default cooldown period for the group applies.

Valid only if the policy type is SimpleScaling. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

Parameters:

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

Valid only if the policy type is SimpleScaling. For more information, see Scaling Cooldowns in the Amazon EC2 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. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.

Valid only if the policy type is StepScaling.

Parameters:

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

Valid only if the policy type is StepScaling.

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.

Conditional: If you specify StepScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)

Parameters:

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

Conditional: If you specify StepScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)

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.

Conditional: If you specify StepScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)

Parameters:

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

Conditional: If you specify StepScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)

Returns:

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

stepAdjustments

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

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

Conditional: If you specify StepScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)

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)

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.

Valid only if the policy type is StepScaling or TargetTrackingScaling.

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.

Valid only if the policy type is StepScaling or TargetTrackingScaling.

Returns:

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

targetTrackingConfiguration

PutScalingPolicyRequest.Builder targetTrackingConfiguration(TargetTrackingConfiguration targetTrackingConfiguration)

A target tracking scaling policy. Includes support for predefined or customized metrics.

For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.

Conditional: If you specify TargetTrackingScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)

Parameters:

targetTrackingConfiguration - A target tracking scaling policy. Includes support for predefined or customized metrics.

For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.

Conditional: If you specify TargetTrackingScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)

Returns:

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

targetTrackingConfiguration

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

A target tracking scaling policy. Includes support for predefined or customized metrics.

For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.

Conditional: If you specify TargetTrackingScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)

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)

overrideConfiguration

PutScalingPolicyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

PutScalingPolicyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder