Class CfnAlarm.MetricStatProperty
This structure defines the metric to be returned, along with the statistics, period, and units.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.CloudWatch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnAlarm.MetricStatProperty : CfnAlarm.IMetricStatPropertySyntax (vb)
Public Class CfnAlarm.MetricStatProperty Implements CfnAlarm.IMetricStatPropertyRemarks
MetricStat is a property of the MetricDataQuery property type.
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 {
Dimensions = new [] { new DimensionProperty {
Name = "name",
Value = "value"
} },
MetricName = "metricName",
Namespace = "namespace"
},
Period = 123,
Stat = "stat",
// the properties below are optional
Unit = "unit"
};Synopsis
Constructors
| MetricStatProperty() | This structure defines the metric to be returned, along with the statistics, period, and units. |
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 | The unit to use for the returned data points. |
Constructors
MetricStatProperty()
This structure defines the metric to be returned, along with the statistics, period, and units.
public MetricStatProperty()Remarks
MetricStat is a property of the MetricDataQuery property type.
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 {
Dimensions = new [] { new DimensionProperty {
Name = "name",
Value = "value"
} },
MetricName = "metricName",
Namespace = "namespace"
},
Period = 123,
Stat = "stat",
// the properties below are optional
Unit = "unit"
};Properties
Metric
The metric to return, including the metric name, namespace, and dimensions.
public object Metric { get; set; }Property Value
Remarks
Period
The granularity, in seconds, of the returned data points.
public double Period { get; set; }Property Value
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:
Stat
The statistic to return.
public string Stat { get; set; }Property Value
Remarks
It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide .
Unit
The unit to use for the returned data points.
public string? Unit { get; set; }Property Value
Remarks
Valid values are: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.