Package software.amazon.awscdk.services.autoscaling

Class TargetTrackingScalingPolicyProps.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.TargetTrackingScalingPolicyProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<TargetTrackingScalingPolicyProps>

Enclosing interface:

TargetTrackingScalingPolicyProps

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

A builder for TargetTrackingScalingPolicyProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TargetTrackingScalingPolicyProps.Builder	autoScalingGroup(IAutoScalingGroup autoScalingGroup)	Sets the value of TargetTrackingScalingPolicyProps.getAutoScalingGroup()
TargetTrackingScalingPolicyProps	build()	Builds the configured instance.
TargetTrackingScalingPolicyProps.Builder	cooldown(Duration cooldown)	Sets the value of BaseTargetTrackingProps.getCooldown()
TargetTrackingScalingPolicyProps.Builder	customMetric(IMetric customMetric)	Sets the value of BasicTargetTrackingScalingPolicyProps.getCustomMetric()
TargetTrackingScalingPolicyProps.Builder	disableScaleIn(Boolean disableScaleIn)	Sets the value of BaseTargetTrackingProps.getDisableScaleIn()
TargetTrackingScalingPolicyProps.Builder	estimatedInstanceWarmup(Duration estimatedInstanceWarmup)	Sets the value of BaseTargetTrackingProps.getEstimatedInstanceWarmup()
TargetTrackingScalingPolicyProps.Builder	predefinedMetric(PredefinedMetric predefinedMetric)	Sets the value of BasicTargetTrackingScalingPolicyProps.getPredefinedMetric()
TargetTrackingScalingPolicyProps.Builder	resourceLabel(String resourceLabel)	Sets the value of BasicTargetTrackingScalingPolicyProps.getResourceLabel()
TargetTrackingScalingPolicyProps.Builder	targetValue(Number targetValue)	Sets the value of BasicTargetTrackingScalingPolicyProps.getTargetValue()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

autoScalingGroup

@Stability(Stable)
public TargetTrackingScalingPolicyProps.Builder autoScalingGroup(IAutoScalingGroup autoScalingGroup)

Sets the value of TargetTrackingScalingPolicyProps.getAutoScalingGroup()

Parameters:

autoScalingGroup - the value to be set. This parameter is required.

Returns:

this

targetValue

@Stability(Stable)
public TargetTrackingScalingPolicyProps.Builder targetValue(Number targetValue)

Sets the value of BasicTargetTrackingScalingPolicyProps.getTargetValue()

Parameters:

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

Returns:

this

customMetric

@Stability(Stable)
public TargetTrackingScalingPolicyProps.Builder customMetric(IMetric customMetric)

Sets the value of BasicTargetTrackingScalingPolicyProps.getCustomMetric()

Parameters:

customMetric - 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.

Returns:

this

predefinedMetric

@Stability(Stable)
public TargetTrackingScalingPolicyProps.Builder predefinedMetric(PredefinedMetric predefinedMetric)

Sets the value of BasicTargetTrackingScalingPolicyProps.getPredefinedMetric()

Parameters:

predefinedMetric - 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.

Returns:

this

resourceLabel

@Stability(Stable)
public TargetTrackingScalingPolicyProps.Builder resourceLabel(String resourceLabel)

Sets the value of BasicTargetTrackingScalingPolicyProps.getResourceLabel()

Parameters:

resourceLabel - The resource label associated with the predefined metric. Should be supplied if the predefined metric is ALBRequestCountPerTarget, and the format should be:

app/invalid input: '<'load-balancer-name>/invalid input: '<'load-balancer-id>/targetgroup/invalid input: '<'target-group-name>/invalid input: '<'target-group-id>

Returns:

this

cooldown

@Stability(Stable)
public TargetTrackingScalingPolicyProps.Builder cooldown(Duration cooldown)

Sets the value of BaseTargetTrackingProps.getCooldown()

Parameters:

cooldown - Period after a scaling completes before another scaling activity can start.

Returns:

this

disableScaleIn

@Stability(Stable)
public TargetTrackingScalingPolicyProps.Builder disableScaleIn(Boolean disableScaleIn)

Sets the value of BaseTargetTrackingProps.getDisableScaleIn()

Parameters:

disableScaleIn - 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.

Returns:

this

estimatedInstanceWarmup

@Stability(Stable)
public TargetTrackingScalingPolicyProps.Builder estimatedInstanceWarmup(Duration estimatedInstanceWarmup)

Sets the value of BaseTargetTrackingProps.getEstimatedInstanceWarmup()

Parameters:

estimatedInstanceWarmup - Estimated time until a newly launched instance can send metrics to CloudWatch.

Returns:

this

build

@Stability(Stable)
public TargetTrackingScalingPolicyProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of TargetTrackingScalingPolicyProps

Throws:

NullPointerException - if any required attribute was not provided