MetricAlarmMetricQueryArgs

data class MetricAlarmMetricQueryArgs(val accountId: Output<String>? = null, val expression: Output<String>? = null, val id: Output<String>, val label: Output<String>? = null, val metric: Output<MetricAlarmMetricQueryMetricArgs>? = null, val period: Output<Int>? = null, val returnData: Output<Boolean>? = null) : ConvertibleToJava<MetricAlarmMetricQueryArgs>

Constructors

Link copied to clipboard
constructor(accountId: Output<String>? = null, expression: Output<String>? = null, id: Output<String>, label: Output<String>? = null, metric: Output<MetricAlarmMetricQueryMetricArgs>? = null, period: Output<Int>? = null, returnData: Output<Boolean>? = null)

Properties

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

The ID of the account where the metrics are located, if this is a cross-account alarm.

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

The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the id of the other metrics to refer to those metrics, and can also use the id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

Link copied to clipboard
val id: Output<String>

A short name used to tie this object to the results in the response. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.

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

A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents.

Link copied to clipboard

The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.

Link copied to clipboard
val period: Output<Int>? = null

Granularity in seconds of returned data points. For metrics with regular resolution, valid values are any multiple of 60. For high-resolution metrics, valid values are 1, 5, 10, 30, or any multiple of 60.

Link copied to clipboard
val returnData: Output<Boolean>? = null

Specify exactly one metric_query to be true to use that metric_query result as the alarm.

Functions

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