public static interface PutScalingPolicyRequest.Builder extends AutoScalingRequest.Builder, CopyableBuilder<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>
Modifier and Type | Method and 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 |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
PutScalingPolicyRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
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(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 policy.
|
PutScalingPolicyRequest.Builder |
targetTrackingConfiguration(TargetTrackingConfiguration targetTrackingConfiguration)
A target tracking policy.
|
build
overrideConfiguration
copy
applyMutation, build
PutScalingPolicyRequest.Builder autoScalingGroupName(String autoScalingGroupName)
The name or ARN of the group.
autoScalingGroupName
- The name or ARN of the group.PutScalingPolicyRequest.Builder policyName(String policyName)
The name of the policy.
policyName
- The name of the policy.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
.
policyType
- The policy type. The valid values are SimpleScaling
, StepScaling
, and
TargetTrackingScaling
. If the policy type is null, the value is treated as
SimpleScaling
.PutScalingPolicyRequest.Builder adjustmentType(String adjustmentType)
The adjustment type. The valid values are ChangeInCapacity
, ExactCapacity
, and
PercentChangeInCapacity
.
This parameter is supported if the policy type is SimpleScaling
or StepScaling
.
For more information, see Dynamic Scaling in the Auto Scaling User Guide.
adjustmentType
- The adjustment type. The valid values are ChangeInCapacity
, ExactCapacity
,
and PercentChangeInCapacity
.
This parameter is supported if the policy type is SimpleScaling
or
StepScaling
.
For more information, see Dynamic Scaling in the Auto Scaling User Guide.
PutScalingPolicyRequest.Builder minAdjustmentStep(Integer minAdjustmentStep)
Available for backward compatibility. Use MinAdjustmentMagnitude
instead.
minAdjustmentStep
- Available for backward compatibility. Use MinAdjustmentMagnitude
instead.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 parameter is supported if the policy type is SimpleScaling
or StepScaling
.
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 parameter is supported if the policy type is SimpleScaling
or
StepScaling
.
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.
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.
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 supported if the policy type is SimpleScaling
.
For more information, see Auto Scaling Cooldowns in the Auto Scaling User Guide.
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 supported if the policy type is SimpleScaling
.
For more information, see Auto Scaling Cooldowns in the Auto Scaling User Guide.
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
.
This parameter is supported if the policy type is StepScaling
.
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
.
This parameter is supported if the policy type is StepScaling
.
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.
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.
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.
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.
PutScalingPolicyRequest.Builder stepAdjustments(Consumer<StepAdjustment.Builder>... 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.
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)
.stepAdjustments
- a consumer that will call methods on List.Builder
#stepAdjustments(List)
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 supported if the policy type is StepScaling
or
TargetTrackingScaling
.
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 supported if the policy type is StepScaling
or
TargetTrackingScaling
.
PutScalingPolicyRequest.Builder targetTrackingConfiguration(TargetTrackingConfiguration targetTrackingConfiguration)
A target tracking policy.
This parameter is required if the policy type is TargetTrackingScaling
and not supported
otherwise.
targetTrackingConfiguration
- A target tracking policy.
This parameter is required if the policy type is TargetTrackingScaling
and not supported
otherwise.
default PutScalingPolicyRequest.Builder targetTrackingConfiguration(Consumer<TargetTrackingConfiguration.Builder> targetTrackingConfiguration)
A target tracking policy.
This parameter is required if the policy type is TargetTrackingScaling
and not supported
otherwise.
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)
.targetTrackingConfiguration
- a consumer that will call methods on TargetTrackingConfiguration.Builder
targetTrackingConfiguration(TargetTrackingConfiguration)
PutScalingPolicyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.PutScalingPolicyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.