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
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description PutScalingPolicyRequest.Builder
adjustmentType(String adjustmentType)
Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage).PutScalingPolicyRequest.Builder
autoScalingGroupName(String autoScalingGroupName)
The name of the Auto Scaling group.PutScalingPolicyRequest.Builder
cooldown(Integer cooldown)
A cooldown period, in seconds, that applies to a specific simple scaling policy.PutScalingPolicyRequest.Builder
enabled(Boolean enabled)
Indicates whether the scaling policy is enabled or disabled.PutScalingPolicyRequest.Builder
estimatedInstanceWarmup(Integer estimatedInstanceWarmup)
Not needed if the default instance warmup is defined for the group.PutScalingPolicyRequest.Builder
metricAggregationType(String metricAggregationType)
The aggregation type for the CloudWatch metrics.PutScalingPolicyRequest.Builder
minAdjustmentMagnitude(Integer minAdjustmentMagnitude)
The minimum value to scale by when the adjustment type isPercentChangeInCapacity
.PutScalingPolicyRequest.Builder
minAdjustmentStep(Integer minAdjustmentStep)
Available for backward compatibility.PutScalingPolicyRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
PutScalingPolicyRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
PutScalingPolicyRequest.Builder
policyName(String policyName)
The name of the policy.PutScalingPolicyRequest.Builder
policyType(String policyType)
One of the following policy types:default PutScalingPolicyRequest.Builder
predictiveScalingConfiguration(Consumer<PredictiveScalingConfiguration.Builder> predictiveScalingConfiguration)
A predictive scaling policy.PutScalingPolicyRequest.Builder
predictiveScalingConfiguration(PredictiveScalingConfiguration predictiveScalingConfiguration)
A predictive scaling policy.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 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.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
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)
One of the following policy types:
-
TargetTrackingScaling
-
StepScaling
-
SimpleScaling
(default) -
PredictiveScaling
- Parameters:
policyType
- One of the following policy types:-
TargetTrackingScaling
-
StepScaling
-
SimpleScaling
(default) -
PredictiveScaling
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
adjustmentType
PutScalingPolicyRequest.Builder adjustmentType(String adjustmentType)
Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are
ChangeInCapacity
,ExactCapacity
, andPercentChangeInCapacity
.Required if the policy type is
StepScaling
orSimpleScaling
. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.- Parameters:
adjustmentType
- Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values areChangeInCapacity
,ExactCapacity
, andPercentChangeInCapacity
.Required if the policy type is
StepScaling
orSimpleScaling
. 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. UseMinAdjustmentMagnitude
instead.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
minAdjustmentMagnitude
PutScalingPolicyRequest.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 Auto Scaling group by 25 percent and you specify aMinAdjustmentMagnitude
of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified aMinAdjustmentMagnitude
of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.Valid only if the policy type is
StepScaling
orSimpleScaling
. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.Some Auto Scaling groups use instance weights. In this case, set the
MinAdjustmentMagnitude
to a value that is at least as large as your largest instance weight.- Parameters:
minAdjustmentMagnitude
- The minimum value to scale by when the adjustment type isPercentChangeInCapacity
. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify aMinAdjustmentMagnitude
of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified aMinAdjustmentMagnitude
of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.Valid only if the policy type is
StepScaling
orSimpleScaling
. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.Some Auto Scaling groups use instance weights. In this case, set the
MinAdjustmentMagnitude
to a value that is at least as large as your largest instance weight.- 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. For exact capacity, you must specify a non-negative value.
Required if the policy type is
SimpleScaling
. (Not used with any other policy type.)- 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. For exact capacity, you must specify a non-negative value.Required if the policy type is
SimpleScaling
. (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)
A cooldown period, in seconds, that applies to a specific simple scaling policy. When a cooldown period is specified here, it overrides the default cooldown.
Valid only if the policy type is
SimpleScaling
. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.Default: None
- Parameters:
cooldown
- A cooldown period, in seconds, that applies to a specific simple scaling policy. When a cooldown period is specified here, it overrides the default cooldown.Valid only if the policy type is
SimpleScaling
. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.Default: None
- 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
, andAverage
. If the aggregation type is null, the value is treated asAverage
.Valid only if the policy type is
StepScaling
.- Parameters:
metricAggregationType
- The aggregation type for the CloudWatch metrics. The valid values areMinimum
,Maximum
, andAverage
. If the aggregation type is null, the value is treated asAverage
.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.
Required if the policy type is
StepScaling
. (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.Required if the policy type is
StepScaling
. (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.
Required if the policy type is
StepScaling
. (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.Required if the policy type is
StepScaling
. (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.
Required if the policy type is
This is a convenience method that creates an instance of theStepScaling
. (Not used with any other policy type.)StepAdjustment.Builder
avoiding the need to create one manually viaStepAdjustment.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 onStepAdjustment.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#stepAdjustments(java.util.Collection
)
-
estimatedInstanceWarmup
PutScalingPolicyRequest.Builder estimatedInstanceWarmup(Integer estimatedInstanceWarmup)
Not needed if the default instance warmup is defined for the group.
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This warm-up period applies to instances launched due to a specific target tracking or step scaling policy. When a warm-up period is specified here, it overrides the default instance warmup.
Valid only if the policy type is
TargetTrackingScaling
orStepScaling
.The default is to use the value for the default instance warmup defined for the group. If default instance warmup is null, then
EstimatedInstanceWarmup
falls back to the value of default cooldown.- Parameters:
estimatedInstanceWarmup
- Not needed if the default instance warmup is defined for the group.The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This warm-up period applies to instances launched due to a specific target tracking or step scaling policy. When a warm-up period is specified here, it overrides the default instance warmup.
Valid only if the policy type is
TargetTrackingScaling
orStepScaling
.The default is to use the value for the default instance warmup defined for the group. If default instance warmup is null, then
EstimatedInstanceWarmup
falls back to the value of default cooldown.- 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. Provides support for predefined or custom metrics.
The following predefined metrics are available:
-
ASGAverageCPUUtilization
-
ASGAverageNetworkIn
-
ASGAverageNetworkOut
-
ALBRequestCountPerTarget
If you specify
ALBRequestCountPerTarget
for the metric, you must specify theResourceLabel
property with thePredefinedMetricSpecification
.For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.
Required if the policy type is
TargetTrackingScaling
.- Parameters:
targetTrackingConfiguration
- A target tracking scaling policy. Provides support for predefined or custom metrics.The following predefined metrics are available:
-
ASGAverageCPUUtilization
-
ASGAverageNetworkIn
-
ASGAverageNetworkOut
-
ALBRequestCountPerTarget
If you specify
ALBRequestCountPerTarget
for the metric, you must specify theResourceLabel
property with thePredefinedMetricSpecification
.For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.
Required if the policy type is
TargetTrackingScaling
.-
- 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. Provides support for predefined or custom metrics.
The following predefined metrics are available:
-
ASGAverageCPUUtilization
-
ASGAverageNetworkIn
-
ASGAverageNetworkOut
-
ALBRequestCountPerTarget
If you specify
ALBRequestCountPerTarget
for the metric, you must specify theResourceLabel
property with thePredefinedMetricSpecification
.For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.
Required if the policy type is
This is a convenience method that creates an instance of theTargetTrackingScaling
.TargetTrackingConfiguration.Builder
avoiding the need to create one manually viaTargetTrackingConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totargetTrackingConfiguration(TargetTrackingConfiguration)
.- Parameters:
targetTrackingConfiguration
- a consumer that will call methods onTargetTrackingConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
targetTrackingConfiguration(TargetTrackingConfiguration)
-
-
enabled
PutScalingPolicyRequest.Builder enabled(Boolean enabled)
Indicates whether the scaling policy is enabled or disabled. The default is enabled. For more information, see Disabling a scaling policy for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
enabled
- Indicates whether the scaling policy is enabled or disabled. The default is enabled. For more information, see Disabling a scaling policy for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
predictiveScalingConfiguration
PutScalingPolicyRequest.Builder predictiveScalingConfiguration(PredictiveScalingConfiguration predictiveScalingConfiguration)
A predictive scaling policy. Provides support for predefined and custom metrics.
Predefined metrics include CPU utilization, network in/out, and the Application Load Balancer request count.
For more information, see PredictiveScalingConfiguration in the Amazon EC2 Auto Scaling API Reference.
Required if the policy type is
PredictiveScaling
.- Parameters:
predictiveScalingConfiguration
- A predictive scaling policy. Provides support for predefined and custom metrics.Predefined metrics include CPU utilization, network in/out, and the Application Load Balancer request count.
For more information, see PredictiveScalingConfiguration in the Amazon EC2 Auto Scaling API Reference.
Required if the policy type is
PredictiveScaling
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
predictiveScalingConfiguration
default PutScalingPolicyRequest.Builder predictiveScalingConfiguration(Consumer<PredictiveScalingConfiguration.Builder> predictiveScalingConfiguration)
A predictive scaling policy. Provides support for predefined and custom metrics.
Predefined metrics include CPU utilization, network in/out, and the Application Load Balancer request count.
For more information, see PredictiveScalingConfiguration in the Amazon EC2 Auto Scaling API Reference.
Required if the policy type is
This is a convenience method that creates an instance of thePredictiveScaling
.PredictiveScalingConfiguration.Builder
avoiding the need to create one manually viaPredictiveScalingConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topredictiveScalingConfiguration(PredictiveScalingConfiguration)
.- Parameters:
predictiveScalingConfiguration
- a consumer that will call methods onPredictiveScalingConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
predictiveScalingConfiguration(PredictiveScalingConfiguration)
-
overrideConfiguration
PutScalingPolicyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
PutScalingPolicyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-