software.amazon.awscdk.services.autoscaling

Class TargetTrackingScalingPolicyProps.Builder

java.lang.Object

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

Enclosing interface:

TargetTrackingScalingPolicyProps

public static final class TargetTrackingScalingPolicyProps.Builder
extends java.lang.Object

A builder for TargetTrackingScalingPolicyProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and 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(java.lang.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(java.lang.String resourceLabel) Sets the value of BasicTargetTrackingScalingPolicyProps.getResourceLabel()
TargetTrackingScalingPolicyProps.Builder	targetValue(java.lang.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 Detail

Builder

public Builder()

Method Detail

autoScalingGroup

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

public TargetTrackingScalingPolicyProps.Builder targetValue(java.lang.Number targetValue)

Sets the value of BasicTargetTrackingScalingPolicyProps.getTargetValue()

Parameters:

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

Returns:

this

customMetric

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

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

public TargetTrackingScalingPolicyProps.Builder resourceLabel(java.lang.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///targetgroup//

Returns:

this

cooldown

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

public TargetTrackingScalingPolicyProps.Builder disableScaleIn(java.lang.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

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

public TargetTrackingScalingPolicyProps build()

Builds the configured instance.

Returns:

a new instance of TargetTrackingScalingPolicyProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided