1.204.0

interface MetricStatProperty

LanguageType name
.NETAmazon.CDK.AWS.CloudWatch.CfnAnomalyDetector.MetricStatProperty
Javasoftware.amazon.awscdk.services.cloudwatch.CfnAnomalyDetector.MetricStatProperty
Pythonaws_cdk.aws_cloudwatch.CfnAnomalyDetector.MetricStatProperty
TypeScript @aws-cdk/aws-cloudwatch » CfnAnomalyDetector » MetricStatProperty

This structure defines the metric to be returned, along with the statistics, period, and units.

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';
const metricStatProperty: cloudwatch.CfnAnomalyDetector.MetricStatProperty = {
  metric: {
    metricName: 'metricName',
    namespace: 'namespace',

    // the properties below are optional
    dimensions: [{
      name: 'name',
      value: 'value',
    }],
  },
  period: 123,
  stat: 'stat',

  // the properties below are optional
  unit: 'unit',
};

Properties

NameTypeDescription
metricIResolvable | MetricPropertyThe metric to return, including the metric name, namespace, and dimensions.
periodnumberThe granularity, in seconds, of the returned data points.
statstringThe statistic to return.
unit?stringWhen you are using a Put operation, this defines what unit you want to use when storing the metric.

metric

Type: IResolvable | MetricProperty

The metric to return, including the metric name, namespace, and dimensions.

period

Type: number

The granularity, in seconds, of the returned data points.

For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

  • Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
  • Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
  • Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

stat

Type: string

The statistic to return.

It can include any CloudWatch statistic or extended statistic.

unit?

Type: string (optional)

When you are using a Put operation, this defines what unit you want to use when storing the metric.

In a Get operation, if you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

← PreviousNext →