AWS CDK Reference

Appearance

v2.274.0

MetricOptions Struct ​

Properties of a metric that can be changed.

Source
aws-cloudwatch/lib/metric.ts

Example ​

ts
declare const channel: medialive.Channel;
declare const stack: Stack;

channel.metricDroppedFrames(medialive.Pipeline.PIPELINE_0).createAlarm(stack, 'DroppedFrames', {
  threshold: 1,
  evaluationPeriods: 2,
});

channel.metricSvqTime(medialive.Pipeline.PIPELINE_0).createAlarm(stack, 'SvqTime', {
  threshold: 0,
  evaluationPeriods: 1,
});

// Custom metric by name with sum statistic
channel.metric('Output4xxErrors', medialive.Pipeline.PIPELINE_0, { statistic: 'sum' });

Properties ​

accountstringaccountstraccountStringAccountstringAccount*string#
Account which this metric comes from.

Default: Deployment account.

colorstringcolorstrcolorStringColorstringColor*string#
The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The `Color` class has a set of standard colors that can be used here.

Default: Automatic color

dimensionsMap{ [key: string]: string }dimensions_maptyping.Mapping[str, str]dimensionsMapMap<String, String>DimensionsMapIDictionary<string, string>DimensionsMap*map[string]*string#
Dimensions of the metric.

Default: No dimensions.

idstringidstridStringIdstringId*string#
Unique identifier for this metric when used in dashboard widgets.

Default: No ID

The id can be used as a variable to represent this metric in math expressions. Valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.

labelstringlabelstrlabelStringLabelstringLabel*string#
Label for this metric when added to a Graph in a Dashboard.

Default: No label

notes

You can use dynamic labels to show summary information about the entire displayed time series in the legend. For example, if you use:

[max: ${MAX}] MyMetric

As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend.

periodDurationperiodDurationperiodDurationPeriodDurationPeriodDuration= Duration.minutes(5)#
The period over which the specified statistic is applied.
regionstringregionstrregionStringRegionstringRegion*string#
Region which this metric comes from.

Default: Deployment region.

stackAccountstringstack_accountstrstackAccountStringStackAccountstringStackAccount*string#
Account of the stack this metric is attached to.

Default: Deployment account.

stackRegionstringstack_regionstrstackRegionStringStackRegionstringStackRegion*string#
Region of the stack this metric is attached to.

Default: Deployment region.

statisticstringstatisticstrstatisticStringStatisticstringStatistic*string= Average#
What function to use for aggregating.
notes

Use the aws_cloudwatch.Stats helper class to construct valid input strings.

Can be one of the following:

  • "Minimum" | "min"
  • "Maximum" | "max"
  • "Average" | "avg"
  • "Sum" | "sum"
  • "SampleCount | "n"
  • "pNN.NN"
  • "tmNN.NN" | "tm(NN.NN%:NN.NN%)"
  • "iqm"
  • "wmNN.NN" | "wm(NN.NN%:NN.NN%)"
  • "tcNN.NN" | "tc(NN.NN%:NN.NN%)"
  • "tsNN.NN" | "ts(NN.NN%:NN.NN%)"
unitUnitunitUnitunitUnitUnitUnitUnitUnit#
Unit used to filter the metric stream.

Default: All metric datums in the given metric stream

notes

Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units.

The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases.

CloudWatch does not honor this property for graphs.

visiblebooleanvisibleboolvisibleBooleanVisibleboolVisible*bool= true#
Whether this metric should be visible in dashboard graphs.

Setting this to false is useful when you want to hide raw metrics that are used in math expressions, and show only the expression results.