AWS CDK Reference

Appearance

v2.273.0

MetricProps Struct ​

Properties for a metric.

Source
aws-cloudwatch/lib/metric.ts

Example ​

ts
// Create a metric
const metric = new cloudwatch.Metric({
  namespace: 'AWS/EC2',
  metricName: 'CPUUtilization',
  statistic: 'Average',
  period: Duration.hours(1), // Alarm will use the metric's period
});

// Create an anomaly detection alarm
const alarm = new cloudwatch.AnomalyDetectionAlarm(this, 'AnomalyAlarm', {
  metric: metric,
  evaluationPeriods: 1,

  // Number of standard deviations for the band (default: 2)
  stdDevs: 2,
  // Alarm outside on either side of the band, or just below or above it (default: outside)
  comparisonOperator: cloudwatch.ComparisonOperator.LESS_THAN_LOWER_OR_GREATER_THAN_UPPER_THRESHOLD,
  alarmDescription: 'Alarm when metric is outside the expected band',
});

Properties ​

accountstringaccountstraccountStringAccountstringAccount*string= Deployment account.#
Account which this metric comes from.
colorstringcolorstrcolorStringColorstringColor*string= Automatic color#
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.
dimensionsMap{ [key: string]: string }dimensions_maptyping.Mapping[str, str]dimensionsMapMap<String, String>DimensionsMapIDictionary<string, string>DimensionsMap*map[string]*string= No dimensions.#
Dimensions of the metric.
idstringidstridStringIdstringId*string= No ID#
Unique identifier for this metric when used in dashboard widgets.

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= No label#
Label for this metric when added to a Graph in a Dashboard.
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.

metricNamestringmetric_namestrmetricNameStringMetricNamestringMetricName*stringrequired#
Name of the metric.
namespacestringnamespacestrnamespaceStringNamespacestringNamespace*stringrequired#
Namespace of the metric.
periodDurationperiodDurationperiodDurationPeriodDurationPeriodDuration= Duration.minutes(5)#
The period over which the specified statistic is applied.
regionstringregionstrregionStringRegionstringRegion*string= Deployment region.#
Region which this metric comes from.
stackAccountstringstack_accountstrstackAccountStringStackAccountstringStackAccount*string= Deployment account.#
Account of the stack this metric is attached to.
stackRegionstringstack_regionstrstackRegionStringStackRegionstringStackRegion*string= Deployment region.#
Region of the stack this metric is attached to.
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= All metric datums in the given m…#
Unit used to filter the metric stream.
notes · default

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.

Default: All metric datums in the given metric stream

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.

Used as props by ​