software.amazon.awscdk.services.ecs

Class TrackCustomMetricProps.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.TrackCustomMetricProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<TrackCustomMetricProps>

Enclosing interface:

TrackCustomMetricProps

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

A builder for TrackCustomMetricProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
TrackCustomMetricProps	build() Builds the configured instance.
TrackCustomMetricProps.Builder	disableScaleIn(Boolean disableScaleIn) Sets the value of BaseTargetTrackingProps.getDisableScaleIn()
TrackCustomMetricProps.Builder	metric(IMetric metric) Sets the value of TrackCustomMetricProps.getMetric()
TrackCustomMetricProps.Builder	policyName(String policyName) Sets the value of BaseTargetTrackingProps.getPolicyName()
TrackCustomMetricProps.Builder	scaleInCooldown(Duration scaleInCooldown) Sets the value of BaseTargetTrackingProps.getScaleInCooldown()
TrackCustomMetricProps.Builder	scaleOutCooldown(Duration scaleOutCooldown) Sets the value of BaseTargetTrackingProps.getScaleOutCooldown()
TrackCustomMetricProps.Builder	targetValue(Number targetValue) Sets the value of TrackCustomMetricProps.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

metric

@Stability(value=Stable)
public TrackCustomMetricProps.Builder metric(IMetric metric)

Sets the value of TrackCustomMetricProps.getMetric()

Parameters:

metric - The custom CloudWatch metric to track. This parameter is required. The metric must represent utilization; that is, you will always get the following behavior:

• metric > targetValue => scale out
• metric < targetValue => scale in

Returns:

this

targetValue

@Stability(value=Stable)
public TrackCustomMetricProps.Builder targetValue(Number targetValue)

Sets the value of TrackCustomMetricProps.getTargetValue()

Parameters:

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

Returns:

this

disableScaleIn

@Stability(value=Stable)
public TrackCustomMetricProps.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 scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource.

Returns:

this

policyName

@Stability(value=Stable)
public TrackCustomMetricProps.Builder policyName(String policyName)

Sets the value of BaseTargetTrackingProps.getPolicyName()

Parameters:

policyName - A name for the scaling policy.

Returns:

this

scaleInCooldown

@Stability(value=Stable)
public TrackCustomMetricProps.Builder scaleInCooldown(Duration scaleInCooldown)

Sets the value of BaseTargetTrackingProps.getScaleInCooldown()

Parameters:

scaleInCooldown - Period after a scale in activity completes before another scale in activity can start.

Returns:

this

scaleOutCooldown

@Stability(value=Stable)
public TrackCustomMetricProps.Builder scaleOutCooldown(Duration scaleOutCooldown)

Sets the value of BaseTargetTrackingProps.getScaleOutCooldown()

Parameters:

scaleOutCooldown - Period after a scale out activity completes before another scale out activity can start.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of TrackCustomMetricProps

Throws:

NullPointerException - if any required attribute was not provided