Package software.amazon.awscdk.services.cloudwatch

Interface MetricOptions

All Superinterfaces:

CommonMetricOptions, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

OperationsMetricOptions, SystemErrorsForOperationsMetricOptions

All Known Implementing Classes:

MetricOptions.Jsii$Proxy, OperationsMetricOptions.Jsii$Proxy, SystemErrorsForOperationsMetricOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:05.886Z")
@Stability(Stable)
public interface MetricOptions
extends software.amazon.jsii.JsiiSerializable, CommonMetricOptions

Properties of a metric that can be changed.

Example:

 Channel channel;
 Stack stack;
 channel.metricDroppedFrames(Pipeline.PIPELINE_0).createAlarm(stack, "DroppedFrames", CreateAlarmOptions.builder()
         .threshold(1)
         .evaluationPeriods(2)
         .build());
 channel.metricSvqTime(Pipeline.PIPELINE_0).createAlarm(stack, "SvqTime", CreateAlarmOptions.builder()
         .threshold(0)
         .evaluationPeriods(1)
         .build());
 // Custom metric by name with sum statistic
 channel.metric("Output4xxErrors", Pipeline.PIPELINE_0, MetricOptions.builder().statistic("sum").build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Static Methods

Modifier and Type	Method	Description
static MetricOptions.Builder	builder()

Methods inherited from interface software.amazon.awscdk.services.cloudwatch.CommonMetricOptions

getAccount, getColor, getDimensionsMap, getId, getLabel, getPeriod, getRegion, getStackAccount, getStackRegion, getStatistic, getUnit, getVisible

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

builder

@Stability(Stable)
static MetricOptions.Builder builder()

Returns:

a MetricOptions.Builder of MetricOptions