software.amazon.awscdk.services.autoscaling

Interface MetricTargetTrackingProps

All Superinterfaces:

BaseTargetTrackingProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

MetricTargetTrackingProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.814Z")
 @Stability(value=Stable)
public interface MetricTargetTrackingProps
extends software.amazon.jsii.JsiiSerializable, BaseTargetTrackingProps

Properties for enabling tracking of an arbitrary metric.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.autoscaling.*;
 import software.amazon.awscdk.services.cloudwatch.*;
 Metric metric;
 MetricTargetTrackingProps metricTargetTrackingProps = MetricTargetTrackingProps.builder()
         .metric(metric)
         .targetValue(123)
         // the properties below are optional
         .cooldown(Duration.minutes(30))
         .disableScaleIn(false)
         .estimatedInstanceWarmup(Duration.minutes(30))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MetricTargetTrackingProps.Builder A builder for MetricTargetTrackingProps
static class	MetricTargetTrackingProps.Jsii$Proxy An implementation for MetricTargetTrackingProps

Method Summary

Modifier and Type	Method and Description
static MetricTargetTrackingProps.Builder	builder()
IMetric	getMetric() Metric to track.
Number	getTargetValue() Value to keep the metric around.

Methods inherited from interface software.amazon.awscdk.services.autoscaling.BaseTargetTrackingProps

getCooldown, getDisableScaleIn, getEstimatedInstanceWarmup

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMetric

@Stability(value=Stable)
 @NotNull
IMetric getMetric()

Metric to track.

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.

getTargetValue

@Stability(value=Stable)
 @NotNull
Number getTargetValue()

Value to keep the metric around.

builder

@Stability(value=Stable)
static MetricTargetTrackingProps.Builder builder()

Specified by:

builder in interface BaseTargetTrackingProps

Returns:

a MetricTargetTrackingProps.Builder of MetricTargetTrackingProps