software.amazon.awscdk.services.ecs

Interface TrackCustomMetricProps

All Superinterfaces:

BaseTargetTrackingProps

All Known Implementing Classes:

TrackCustomMetricProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:10.767Z")
public interface TrackCustomMetricProps
extends BaseTargetTrackingProps

The properties for enabling target tracking scaling based on a custom CloudWatch 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.services.cloudwatch.*;
 import software.amazon.awscdk.services.ecs.*;
 import software.amazon.awscdk.core.*;
 Metric metric;
 TrackCustomMetricProps trackCustomMetricProps = TrackCustomMetricProps.builder()
         .metric(metric)
         .targetValue(123)
         // the properties below are optional
         .disableScaleIn(false)
         .policyName("policyName")
         .scaleInCooldown(Duration.minutes(30))
         .scaleOutCooldown(Duration.minutes(30))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static TrackCustomMetricProps.Builder	builder()
IMetric	getMetric() The custom CloudWatch metric to track.
java.lang.Number	getTargetValue() The target value for the custom CloudWatch metric.

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

getDisableScaleIn, getPolicyName, getScaleInCooldown, getScaleOutCooldown

Method Detail

getMetric

IMetric getMetric()

The custom CloudWatch metric to track.

The metric must represent utilization; that is, you will always get the following behavior:

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

getTargetValue

java.lang.Number getTargetValue()

The target value for the custom CloudWatch metric.

builder

static TrackCustomMetricProps.Builder builder()

Specified by:

builder in interface BaseTargetTrackingProps

Returns:

a TrackCustomMetricProps.Builder of TrackCustomMetricProps