Interface CfnAnomalyDetector.IMetricStatProperty

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

Namespace: Amazon.CDK.AWS.CloudWatch

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnAnomalyDetector.IMetricStatProperty

Syntax (vb)

Public Interface CfnAnomalyDetector.IMetricStatProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricstat.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.CloudWatch;

             var metricStatProperty = new MetricStatProperty {
                 Metric = new MetricProperty {
                     MetricName = "metricName",
                     Namespace = "namespace",

                     // the properties below are optional
                     Dimensions = new [] { new DimensionProperty {
                         Name = "name",
                         Value = "value"
                     } }
                 },
                 Period = 123,
                 Stat = "stat",

                 // the properties below are optional
                 Unit = "unit"
             };

Synopsis

Properties

Metric	The metric to return, including the metric name, namespace, and dimensions.
Period	The granularity, in seconds, of the returned data points.
Stat	The statistic to return.
Unit	When you are using a Put operation, this defines what unit you want to use when storing the metric.

Properties

Metric

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

object Metric { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricstat.html#cfn-cloudwatch-anomalydetector-metricstat-metric

Type union: either IResolvable or CfnAnomalyDetector.IMetricProperty

Period

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

double Period { get; }

Property Value

double

Remarks

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, 20, 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:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricstat.html#cfn-cloudwatch-anomalydetector-metricstat-period

Stat

The statistic to return.

string Stat { get; }

Property Value

string

Remarks

It can include any CloudWatch statistic or extended statistic.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricstat.html#cfn-cloudwatch-anomalydetector-metricstat-stat

Unit

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

string? Unit { get; }

Property Value

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricstat.html#cfn-cloudwatch-anomalydetector-metricstat-unit