AlarmMetricStatArgs

data class AlarmMetricStatArgs(val metric: Output<AlarmMetricArgs>, val period: Output<Int>, val stat: Output<String>, val unit: Output<String>? = null) : ConvertibleToJava<AlarmMetricStatArgs>

This structure defines the metric to be returned, along with the statistics, period, and units. `MetricStat` is a property of the MetricDataQuery property type.

Constructors

Link copied to clipboard
constructor(metric: Output<AlarmMetricArgs>, period: Output<Int>, stat: Output<String>, unit: Output<String>? = null)

Properties

Link copied to clipboard
val metric: Output<AlarmMetricArgs>

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

Link copied to clipboard
val period: Output<Int>

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:

Link copied to clipboard
val stat: Output<String>

The statistic to return. It can include any CW statistic or extended statistic. For a list of valid values, see the table in Statistics in the User Guide.

Link copied to clipboard
val unit: Output<String>? = null

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.

Functions

Link copied to clipboard
open override fun toJava(): AlarmMetricStatArgs