Package software.amazon.awscdk.services.cloudwatch

Interface CfnAlarm.MetricStatProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAlarm.MetricStatProperty.Jsii$Proxy

Enclosing class:

CfnAlarm

@Stability(Stable)
public static interface CfnAlarm.MetricStatProperty
extends software.amazon.jsii.JsiiSerializable

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

MetricStat is a property of the MetricDataQuery property type.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudwatch.*;
 MetricStatProperty metricStatProperty = MetricStatProperty.builder()
         .metric(MetricProperty.builder()
                 .dimensions(List.of(DimensionProperty.builder()
                         .name("name")
                         .value("value")
                         .build()))
                 .metricName("metricName")
                 .namespace("namespace")
                 .build())
         .period(123)
         .stat("stat")
         // the properties below are optional
         .unit("unit")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAlarm.MetricStatProperty.Builder	A builder for CfnAlarm.MetricStatProperty
static final class	CfnAlarm.MetricStatProperty.Jsii$Proxy	An implementation for CfnAlarm.MetricStatProperty

Method Summary

Modifier and Type	Method	Description
static CfnAlarm.MetricStatProperty.Builder	builder()
Object	getMetric()	The metric to return, including the metric name, namespace, and dimensions.
Number	getPeriod()	The granularity, in seconds, of the returned data points.
String	getStat()	The statistic to return.
default String	getUnit()	The unit to use for the returned data points.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMetric

@Stability(Stable)
@NotNull
Object getMetric()

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

getPeriod

@Stability(Stable)
@NotNull
Number getPeriod()

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).

getStat

@Stability(Stable)
@NotNull
String getStat()

The statistic to return.

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 .

getUnit

@Stability(Stable)
@Nullable
default String getUnit()

The unit to use for the returned data points.

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.

builder

@Stability(Stable)
static CfnAlarm.MetricStatProperty.Builder builder()

Returns:

a CfnAlarm.MetricStatProperty.Builder of CfnAlarm.MetricStatProperty