software.amazon.awscdk.services.applicationautoscaling

Class CfnScalingPolicy.StepScalingPolicyConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.applicationautoscaling.CfnScalingPolicy.StepScalingPolicyConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnScalingPolicy.StepScalingPolicyConfigurationProperty>

Enclosing interface:

CfnScalingPolicy.StepScalingPolicyConfigurationProperty

@Stability(value=Stable)
public static final class CfnScalingPolicy.StepScalingPolicyConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnScalingPolicy.StepScalingPolicyConfigurationProperty>

A builder for CfnScalingPolicy.StepScalingPolicyConfigurationProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnScalingPolicy.StepScalingPolicyConfigurationProperty.Builder	adjustmentType(String adjustmentType) Sets the value of CfnScalingPolicy.StepScalingPolicyConfigurationProperty.getAdjustmentType()
CfnScalingPolicy.StepScalingPolicyConfigurationProperty	build() Builds the configured instance.
CfnScalingPolicy.StepScalingPolicyConfigurationProperty.Builder	cooldown(Number cooldown) Sets the value of CfnScalingPolicy.StepScalingPolicyConfigurationProperty.getCooldown()
CfnScalingPolicy.StepScalingPolicyConfigurationProperty.Builder	metricAggregationType(String metricAggregationType) Sets the value of CfnScalingPolicy.StepScalingPolicyConfigurationProperty.getMetricAggregationType()
CfnScalingPolicy.StepScalingPolicyConfigurationProperty.Builder	minAdjustmentMagnitude(Number minAdjustmentMagnitude) Sets the value of CfnScalingPolicy.StepScalingPolicyConfigurationProperty.getMinAdjustmentMagnitude()
CfnScalingPolicy.StepScalingPolicyConfigurationProperty.Builder	stepAdjustments(IResolvable stepAdjustments) Sets the value of CfnScalingPolicy.StepScalingPolicyConfigurationProperty.getStepAdjustments()
CfnScalingPolicy.StepScalingPolicyConfigurationProperty.Builder	stepAdjustments(List<? extends Object> stepAdjustments) Sets the value of CfnScalingPolicy.StepScalingPolicyConfigurationProperty.getStepAdjustments()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

adjustmentType

@Stability(value=Stable)
public CfnScalingPolicy.StepScalingPolicyConfigurationProperty.Builder adjustmentType(String adjustmentType)

Sets the value of CfnScalingPolicy.StepScalingPolicyConfigurationProperty.getAdjustmentType()

Parameters:

adjustmentType - Specifies whether the `ScalingAdjustment` value in the `StepAdjustment` property is an absolute number or a percentage of the current capacity.

Returns:

this

cooldown

@Stability(value=Stable)
public CfnScalingPolicy.StepScalingPolicyConfigurationProperty.Builder cooldown(Number cooldown)

Sets the value of CfnScalingPolicy.StepScalingPolicyConfigurationProperty.getCooldown()

Parameters:

cooldown - The amount of time, in seconds, to wait for a previous scaling activity to take effect. With scale-out policies, the intention is to continuously (but not excessively) scale out. After Application Auto Scaling successfully scales out using a step scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends. While the cooldown period is in effect, capacity added by the initiating scale-out activity is calculated as part of the desired capacity for the next scale-out activity. For example, when an alarm triggers a step scaling policy to increase the capacity by 2, the scaling activity completes successfully, and a cooldown period starts. If the alarm triggers again during the cooldown period but at a more aggressive step adjustment of 3, the previous increase of 2 is considered part of the current capacity. Therefore, only 1 is added to the capacity.

With scale-in policies, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the cooldown period after a scale-in activity, Application Auto Scaling scales out the target immediately. In this case, the cooldown period for the scale-in activity stops and doesn't complete.

Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:

• AppStream 2.0 fleets
• Aurora DB clusters
• ECS services
• EMR clusters
• Neptune clusters
• SageMaker endpoint variants
• Spot Fleets
• Custom resources

For all other scalable targets, the default value is 0:

• Amazon Comprehend document classification and entity recognizer endpoints
• DynamoDB tables and global secondary indexes
• Amazon Keyspaces tables
• Lambda provisioned concurrency
• Amazon MSK broker storage

Returns:

this

metricAggregationType

@Stability(value=Stable)
public CfnScalingPolicy.StepScalingPolicyConfigurationProperty.Builder metricAggregationType(String metricAggregationType)

Sets the value of CfnScalingPolicy.StepScalingPolicyConfigurationProperty.getMetricAggregationType()

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 .

Returns:

this

minAdjustmentMagnitude

@Stability(value=Stable)
public CfnScalingPolicy.StepScalingPolicyConfigurationProperty.Builder minAdjustmentMagnitude(Number minAdjustmentMagnitude)

Sets the value of CfnScalingPolicy.StepScalingPolicyConfigurationProperty.getMinAdjustmentMagnitude()

Parameters:

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 a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks.

Returns:

this

stepAdjustments

@Stability(value=Stable)
public CfnScalingPolicy.StepScalingPolicyConfigurationProperty.Builder stepAdjustments(IResolvable stepAdjustments)

Sets the value of CfnScalingPolicy.StepScalingPolicyConfigurationProperty.getStepAdjustments()

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:

this

stepAdjustments

@Stability(value=Stable)
public CfnScalingPolicy.StepScalingPolicyConfigurationProperty.Builder stepAdjustments(List<? extends Object> stepAdjustments)

Sets the value of CfnScalingPolicy.StepScalingPolicyConfigurationProperty.getStepAdjustments()

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:

this

build

@Stability(value=Stable)
public CfnScalingPolicy.StepScalingPolicyConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnScalingPolicy.StepScalingPolicyConfigurationProperty>

Returns:

a new instance of CfnScalingPolicy.StepScalingPolicyConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided