1.204.0

interface CommonMetricOptions

LanguageType name
.NETAmazon.CDK.AWS.CloudWatch.CommonMetricOptions
Javasoftware.amazon.awscdk.services.cloudwatch.CommonMetricOptions
Pythonaws_cdk.aws_cloudwatch.CommonMetricOptions
TypeScript (source)@aws-cdk/aws-cloudwatch » CommonMetricOptions

Options shared by most methods accepting metric options.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cloudwatch from '@aws-cdk/aws-cloudwatch';
import * as cdk from '@aws-cdk/core';

declare const dimensions: any;
const commonMetricOptions: cloudwatch.CommonMetricOptions = {
  account: 'account',
  color: 'color',
  dimensions: {
    dimensionsKey: dimensions,
  },
  dimensionsMap: {
    dimensionsMapKey: 'dimensionsMap',
  },
  label: 'label',
  period: cdk.Duration.minutes(30),
  region: 'region',
  statistic: 'statistic',
  unit: cloudwatch.Unit.SECONDS,
};

Properties

NameTypeDescription
account?stringAccount which this metric comes from.
color?stringThe 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.
dimensions?⚠️{ [string]: any }Dimensions of the metric.
dimensionsMap?{ [string]: string }Dimensions of the metric.
label?stringLabel for this metric when added to a Graph in a Dashboard.
period?DurationThe period over which the specified statistic is applied.
region?stringRegion which this metric comes from.
statistic?stringWhat function to use for aggregating.
unit?UnitUnit used to filter the metric stream.

account?

Type: string (optional, default: Deployment account.)

Account which this metric comes from.

color?

Type: string (optional, default: 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.

dimensions?⚠️

⚠️ Deprecated: Use 'dimensionsMap' instead.

Type: { [string]: any } (optional, default: No dimensions.)

Dimensions of the metric.

dimensionsMap?

Type: { [string]: string } (optional, default: No dimensions.)

Dimensions of the metric.

label?

Type: string (optional, default: No label)

Label for this metric when added to a Graph in a Dashboard.

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.

period?

Type: Duration (optional, default: Duration.minutes(5))

The period over which the specified statistic is applied.

region?

Type: string (optional, default: Deployment region.)

Region which this metric comes from.

statistic?

Type: string (optional, default: Average)

What function to use for aggregating.

Can be one of the following:

  • "Minimum" | "min"
  • "Maximum" | "max"
  • "Average" | "avg"
  • "Sum" | "sum"
  • "SampleCount | "n"
  • "pNN.NN"

unit?

Type: Unit (optional, default: All metric datums in the given metric stream)

Unit used to filter the metric stream.

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.

← PreviousNext →