Package software.amazon.awscdk.services.autoscaling

Class MetricTargetTrackingProps.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.MetricTargetTrackingProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<MetricTargetTrackingProps>

Enclosing interface:

MetricTargetTrackingProps

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

A builder for MetricTargetTrackingProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MetricTargetTrackingProps	build()	Builds the configured instance.
MetricTargetTrackingProps.Builder	cooldown(Duration cooldown)	Sets the value of BaseTargetTrackingProps.getCooldown()
MetricTargetTrackingProps.Builder	disableScaleIn(Boolean disableScaleIn)	Sets the value of BaseTargetTrackingProps.getDisableScaleIn()
MetricTargetTrackingProps.Builder	estimatedInstanceWarmup(Duration estimatedInstanceWarmup)	Sets the value of BaseTargetTrackingProps.getEstimatedInstanceWarmup()
MetricTargetTrackingProps.Builder	metric(IMetric metric)	Sets the value of MetricTargetTrackingProps.getMetric()
MetricTargetTrackingProps.Builder	targetValue(Number targetValue)	Sets the value of MetricTargetTrackingProps.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

metric

@Stability(Stable)
public MetricTargetTrackingProps.Builder metric(IMetric metric)

Sets the value of MetricTargetTrackingProps.getMetric()

Parameters:

metric - Metric to track. This parameter is required. The metric must represent a utilization, so that if it's higher than the target value, your ASG should scale out, and if it's lower it should scale in.

Returns:

this

targetValue

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

Sets the value of MetricTargetTrackingProps.getTargetValue()

Parameters:

targetValue - Value to keep the metric around. This parameter is required.

Returns:

this

cooldown

@Stability(Stable)
public MetricTargetTrackingProps.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 MetricTargetTrackingProps.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 MetricTargetTrackingProps.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 MetricTargetTrackingProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of MetricTargetTrackingProps

Throws:

NullPointerException - if any required attribute was not provided