software.amazon.awscdk.services.autoscaling

Class CfnScalingPolicy.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.CfnScalingPolicy.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnScalingPolicy>

Enclosing class:

CfnScalingPolicy

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

A fluent builder for CfnScalingPolicy.

Method Summary

Modifier and Type	Method and Description
CfnScalingPolicy.Builder	adjustmentType(String adjustmentType) Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage).
CfnScalingPolicy.Builder	autoScalingGroupName(String autoScalingGroupName) The name of the Auto Scaling group.
CfnScalingPolicy	build()
CfnScalingPolicy.Builder	cooldown(String cooldown) A cooldown period, in seconds, that applies to a specific simple scaling policy.
static CfnScalingPolicy.Builder	create(software.constructs.Construct scope, String id)
CfnScalingPolicy.Builder	estimatedInstanceWarmup(Number estimatedInstanceWarmup) *Not needed if the default instance warmup is defined for the group.*.
CfnScalingPolicy.Builder	metricAggregationType(String metricAggregationType) The aggregation type for the CloudWatch metrics.
CfnScalingPolicy.Builder	minAdjustmentMagnitude(Number minAdjustmentMagnitude) The minimum value to scale by when the adjustment type is `PercentChangeInCapacity` .
CfnScalingPolicy.Builder	policyType(String policyType) One of the following policy types:.
CfnScalingPolicy.Builder	predictiveScalingConfiguration(CfnScalingPolicy.PredictiveScalingConfigurationProperty predictiveScalingConfiguration) A predictive scaling policy.
CfnScalingPolicy.Builder	predictiveScalingConfiguration(IResolvable predictiveScalingConfiguration) A predictive scaling policy.
CfnScalingPolicy.Builder	scalingAdjustment(Number scalingAdjustment) The amount by which to scale, based on the specified adjustment type.
CfnScalingPolicy.Builder	stepAdjustments(IResolvable stepAdjustments) A set of adjustments that enable you to scale based on the size of the alarm breach.
CfnScalingPolicy.Builder	stepAdjustments(List<? extends Object> stepAdjustments) A set of adjustments that enable you to scale based on the size of the alarm breach.
CfnScalingPolicy.Builder	targetTrackingConfiguration(CfnScalingPolicy.TargetTrackingConfigurationProperty targetTrackingConfiguration) A target tracking scaling policy.
CfnScalingPolicy.Builder	targetTrackingConfiguration(IResolvable targetTrackingConfiguration) A target tracking scaling policy.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static CfnScalingPolicy.Builder create(software.constructs.Construct scope,
                                                                       String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnScalingPolicy.CustomizedMetricSpecificationProperty.Builder.

autoScalingGroupName

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

The name of the Auto Scaling group.

Parameters:

autoScalingGroupName - The name of the Auto Scaling group. This parameter is required.

Returns:

this

adjustmentType

@Stability(value=Stable)
public CfnScalingPolicy.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 , and PercentChangeInCapacity .

Required 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 how the scaling adjustment is interpreted (for example, an absolute number or a percentage). This parameter is required.

Returns:

this

cooldown

@Stability(value=Stable)
public CfnScalingPolicy.Builder cooldown(String 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. This parameter is required.

Returns:

this

estimatedInstanceWarmup

@Stability(value=Stable)
public CfnScalingPolicy.Builder estimatedInstanceWarmup(Number 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 or StepScaling .

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.*. This parameter is required.

Returns:

this

metricAggregationType

@Stability(value=Stable)
public CfnScalingPolicy.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. This parameter is required.

Returns:

this

minAdjustmentMagnitude

@Stability(value=Stable)
public CfnScalingPolicy.Builder minAdjustmentMagnitude(Number 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 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 StepScaling or SimpleScaling . 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 is `PercentChangeInCapacity` . This parameter is required.

Returns:

this

policyType

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

One of the following policy types:.

• TargetTrackingScaling
• StepScaling
• SimpleScaling (default)
• PredictiveScaling

Parameters:

policyType - One of the following policy types:. This parameter is required.

Returns:

this

predictiveScalingConfiguration

@Stability(value=Stable)
public CfnScalingPolicy.Builder predictiveScalingConfiguration(CfnScalingPolicy.PredictiveScalingConfigurationProperty 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.

Required if the policy type is PredictiveScaling .

Parameters:

predictiveScalingConfiguration - A predictive scaling policy. Provides support for predefined and custom metrics. This parameter is required.

Returns:

this

predictiveScalingConfiguration

@Stability(value=Stable)
public CfnScalingPolicy.Builder predictiveScalingConfiguration(IResolvable 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.

Required if the policy type is PredictiveScaling .

Parameters:

predictiveScalingConfiguration - A predictive scaling policy. Provides support for predefined and custom metrics. This parameter is required.

Returns:

this

scalingAdjustment

@Stability(value=Stable)
public CfnScalingPolicy.Builder scalingAdjustment(Number 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 positive 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. This parameter is required.

Returns:

this

stepAdjustments

@Stability(value=Stable)
public CfnScalingPolicy.Builder stepAdjustments(IResolvable 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. This parameter is required.

Returns:

this

stepAdjustments

@Stability(value=Stable)
public CfnScalingPolicy.Builder stepAdjustments(List<? extends Object> 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. This parameter is required.

Returns:

this

targetTrackingConfiguration

@Stability(value=Stable)
public CfnScalingPolicy.Builder targetTrackingConfiguration(CfnScalingPolicy.TargetTrackingConfigurationProperty 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 the ResourceLabel property with the PredefinedMetricSpecification .

Required if the policy type is TargetTrackingScaling .

Parameters:

targetTrackingConfiguration - A target tracking scaling policy. Provides support for predefined or custom metrics. This parameter is required.

Returns:

this

targetTrackingConfiguration

@Stability(value=Stable)
public CfnScalingPolicy.Builder targetTrackingConfiguration(IResolvable 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 the ResourceLabel property with the PredefinedMetricSpecification .

Required if the policy type is TargetTrackingScaling .

Parameters:

targetTrackingConfiguration - A target tracking scaling policy. Provides support for predefined or custom metrics. This parameter is required.

Returns:

this

build

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

Specified by:

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