AWS::CloudWatch::Alarm MetricDataQuery - AWS CloudFormation
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS::CloudWatch::Alarm MetricDataQuery

MetricDataQuery 属性类型指定要返回的指标数据,以及该调用是仅为一个指标检索一组批量数据,还是对指标数据执行数学表达式。

使用的任何表达式都必须返回一个时间序列。有关更多信息,请参阅 Amazon CloudWatch 用户指南 中的指标数学语法和函数

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

{ "Expression" : String, "Id" : String, "Label" : String, "MetricStat" : MetricStat, "Period" : Integer, "ReturnData" : Boolean }

YAML

Expression: String Id: String Label: String MetricStat: MetricStat Period: Integer ReturnData: Boolean

属性

Expression

要对返回的数据执行的数学表达式(如果该对象执行数学表达式)。此表达式可以使用其他指标的 Id 来引用这些指标,也可以使用其他表达式的 Id 来使用这些表达式的结果。有关指标数学表达式的更多信息,请参阅 Amazon CloudWatch 用户指南 中的指标数学语法和函数

在每个 MetricDataQuery 对象中,您必须指定 ExpressionMetricStat,但不能同时指定两者。

必需:否

类型:字符串

最低1

最高1024

Update requires: No interruption

Id

用于将该对象绑定到响应中的结果的短名称。该名称必须在单个 GetMetricData 调用中是唯一的。如果对该组数据执行数学表达式,此名称表示该数据,并且可以作为数学表达式中的变量。有效的字符是字母、数字和下划线。第一个字符必须是小写字母。

必需:是

类型:字符串

最低1

最高255

Update requires: No interruption

Label

该指标或表达式的用户可读标签。如果这是一个表达式,这是特别有用的,以便您知道该值表示的内容。如果指标或表达式显示在 CloudWatch 控制面板小部件中,则会显示标签。如果忽略 Label,则 CloudWatch 会生成默认值。

必需:否

类型:字符串

Update requires: No interruption

MetricStat

要返回的指标以及统计数据、时段和单位。只有在该对象检索指标而不对返回的数据执行数学表达式时,才会使用该参数。

在一个 MetricDataQuery 对象中,您必须指定 ExpressionMetricStat,但不能同时指定两者。

必需:否

类型MetricStat

Update requires: No interruption

Period

返回的数据点的粒度(以秒为单位)。对于具有常规精度的指标,期间可以短到一分钟(60 秒),并且必须为 60 的倍数。对于以小于一分钟的间隔收集的高精度指标,期间可以是 1、5、10、30、60 或 60 的任意倍数。高精度指标是包含 StorageResolution of 1 secondPutMetricData 操作存储的指标。

必需:否

类型:整数

最低1

Update requires: No interruption

ReturnData

此选项指示是否返回该指标的时间戳和原始数据值。

基于指标数学表达式创建警报时,只为警报所基于的一个数学表达式的此值指定 True。您必须为警报中使用的所有其他指标和表达式的 ReturnData 指定 False

此字段为必填。

必需:否

类型:布尔值

Update requires: No interruption