software.amazon.awscdk.services.autoscaling

Class TargetTrackingScalingPolicy.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.TargetTrackingScalingPolicy.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<TargetTrackingScalingPolicy>

Enclosing class:

TargetTrackingScalingPolicy

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

(experimental) A fluent builder for TargetTrackingScalingPolicy.

Method Summary

Modifier and Type	Method and Description
TargetTrackingScalingPolicy.Builder	autoScalingGroup(IAutoScalingGroup autoScalingGroup)
TargetTrackingScalingPolicy	build()
TargetTrackingScalingPolicy.Builder	cooldown(Duration cooldown) (experimental) Period after a scaling completes before another scaling activity can start.
static TargetTrackingScalingPolicy.Builder	create(software.constructs.Construct scope, String id)
TargetTrackingScalingPolicy.Builder	customMetric(IMetric customMetric) (experimental) A custom metric for application autoscaling.
TargetTrackingScalingPolicy.Builder	disableScaleIn(Boolean disableScaleIn) (experimental) Indicates whether scale in by the target tracking policy is disabled.
TargetTrackingScalingPolicy.Builder	estimatedInstanceWarmup(Duration estimatedInstanceWarmup) (experimental) Estimated time until a newly launched instance can send metrics to CloudWatch.
TargetTrackingScalingPolicy.Builder	predefinedMetric(PredefinedMetric predefinedMetric) (experimental) A predefined metric for application autoscaling.
TargetTrackingScalingPolicy.Builder	resourceLabel(String resourceLabel) (experimental) The resource label associated with the predefined metric.
TargetTrackingScalingPolicy.Builder	targetValue(Number targetValue) (experimental) The target value for the metric.

Methods inherited from class java.lang.Object

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

Method Detail

create

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of TargetTrackingScalingPolicy.Builder.

cooldown

@Stability(value=Experimental)
public TargetTrackingScalingPolicy.Builder cooldown(Duration cooldown)

(experimental) Period after a scaling completes before another scaling activity can start.

Default: - The default cooldown configured on the AutoScalingGroup.

Parameters:

cooldown - Period after a scaling completes before another scaling activity can start. This parameter is required.

Returns:

this

disableScaleIn

@Stability(value=Experimental)
public TargetTrackingScalingPolicy.Builder disableScaleIn(Boolean disableScaleIn)

(experimental) Indicates whether scale in by the target tracking policy is disabled.

If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the autoscaling group. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the group.

Default: false

Parameters:

disableScaleIn - Indicates whether scale in by the target tracking policy is disabled. This parameter is required.

Returns:

this

estimatedInstanceWarmup

@Stability(value=Experimental)
public TargetTrackingScalingPolicy.Builder estimatedInstanceWarmup(Duration estimatedInstanceWarmup)

(experimental) Estimated time until a newly launched instance can send metrics to CloudWatch.

Default: - Same as the cooldown.

Parameters:

estimatedInstanceWarmup - Estimated time until a newly launched instance can send metrics to CloudWatch. This parameter is required.

Returns:

this

targetValue

@Stability(value=Experimental)
public TargetTrackingScalingPolicy.Builder targetValue(Number targetValue)

(experimental) The target value for the metric.

Parameters:

targetValue - The target value for the metric. This parameter is required.

Returns:

this

customMetric

@Stability(value=Experimental)
public TargetTrackingScalingPolicy.Builder customMetric(IMetric customMetric)

(experimental) A custom metric for application autoscaling.

The metric must track utilization. Scaling out will happen if the metric is higher than the target value, scaling in will happen in the metric is lower than the target value.

Exactly one of customMetric or predefinedMetric must be specified.

Default: - No custom metric.

Parameters:

customMetric - A custom metric for application autoscaling. This parameter is required.

Returns:

this

predefinedMetric

@Stability(value=Experimental)
public TargetTrackingScalingPolicy.Builder predefinedMetric(PredefinedMetric predefinedMetric)

(experimental) A predefined metric for application autoscaling.

The metric must track utilization. Scaling out will happen if the metric is higher than the target value, scaling in will happen in the metric is lower than the target value.

Exactly one of customMetric or predefinedMetric must be specified.

Default: - No predefined metric.

Parameters:

predefinedMetric - A predefined metric for application autoscaling. This parameter is required.

Returns:

this

resourceLabel

@Stability(value=Experimental)
public TargetTrackingScalingPolicy.Builder resourceLabel(String resourceLabel)

(experimental) The resource label associated with the predefined metric.

Should be supplied if the predefined metric is ALBRequestCountPerTarget, and the format should be:

app///targetgroup//

Default: - No resource label.

Parameters:

resourceLabel - The resource label associated with the predefined metric. This parameter is required.

Returns:

this

autoScalingGroup

@Stability(value=Experimental)
public TargetTrackingScalingPolicy.Builder autoScalingGroup(IAutoScalingGroup autoScalingGroup)

Parameters:

autoScalingGroup - This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public TargetTrackingScalingPolicy build()

Specified by:

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