Interface StepScalingPolicyConfiguration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<StepScalingPolicyConfiguration.Builder,
,StepScalingPolicyConfiguration> SdkBuilder<StepScalingPolicyConfiguration.Builder,
,StepScalingPolicyConfiguration> SdkPojo
- Enclosing class:
StepScalingPolicyConfiguration
-
Method Summary
Modifier and TypeMethodDescriptionadjustmentType
(String adjustmentType) Specifies how theScalingAdjustment
value in a StepAdjustment is interpreted (for example, an absolute number or a percentage).adjustmentType
(AdjustmentType adjustmentType) Specifies how theScalingAdjustment
value in a StepAdjustment is interpreted (for example, an absolute number or a percentage).The amount of time, in seconds, to wait for a previous scaling activity to take effect.metricAggregationType
(String metricAggregationType) The aggregation type for the CloudWatch metrics.metricAggregationType
(MetricAggregationType metricAggregationType) The aggregation type for the CloudWatch metrics.minAdjustmentMagnitude
(Integer minAdjustmentMagnitude) The minimum value to scale by when the adjustment type isPercentChangeInCapacity
.stepAdjustments
(Collection<StepAdjustment> stepAdjustments) A set of adjustments that enable you to scale based on the size of the alarm breach.stepAdjustments
(Consumer<StepAdjustment.Builder>... stepAdjustments) A set of adjustments that enable you to scale based on the size of the alarm breach.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
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
adjustmentType
Specifies how the
ScalingAdjustment
value in a StepAdjustment is interpreted (for example, an absolute number or a percentage). The valid values areChangeInCapacity
,ExactCapacity
, andPercentChangeInCapacity
.AdjustmentType
is required if you are adding a new step scaling policy configuration.- Parameters:
adjustmentType
- Specifies how theScalingAdjustment
value in a StepAdjustment is interpreted (for example, an absolute number or a percentage). The valid values areChangeInCapacity
,ExactCapacity
, andPercentChangeInCapacity
.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
Specifies how the
ScalingAdjustment
value in a StepAdjustment is interpreted (for example, an absolute number or a percentage). The valid values areChangeInCapacity
,ExactCapacity
, andPercentChangeInCapacity
.AdjustmentType
is required if you are adding a new step scaling policy configuration.- Parameters:
adjustmentType
- Specifies how theScalingAdjustment
value in a StepAdjustment is interpreted (for example, an absolute number or a percentage). The valid values areChangeInCapacity
,ExactCapacity
, andPercentChangeInCapacity
.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:
-
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
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 theStepAdjustment.Builder
avoiding the need to create one manually viaStepAdjustment.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostepAdjustments(List<StepAdjustment>)
.- 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:
-
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 aMinAdjustmentMagnitude
of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified aMinAdjustmentMagnitude
of 2, Application Auto Scaling scales out the service by 2 tasks.- 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 Amazon ECS service by 25 percent and you specify aMinAdjustmentMagnitude
of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified aMinAdjustmentMagnitude
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
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
The aggregation type for the CloudWatch metrics. Valid values are
Minimum
,Maximum
, andAverage
. If the aggregation type is null, the value is treated asAverage
.- Parameters:
metricAggregationType
- The aggregation type for the CloudWatch metrics. Valid values areMinimum
,Maximum
, andAverage
. If the aggregation type is null, the value is treated asAverage
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
metricAggregationType
StepScalingPolicyConfiguration.Builder metricAggregationType(MetricAggregationType metricAggregationType) The aggregation type for the CloudWatch metrics. Valid values are
Minimum
,Maximum
, andAverage
. If the aggregation type is null, the value is treated asAverage
.- Parameters:
metricAggregationType
- The aggregation type for the CloudWatch metrics. Valid values areMinimum
,Maximum
, andAverage
. If the aggregation type is null, the value is treated asAverage
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-