AWS CloudFormation
用户指南 (API 版本 2010-05-15)

AWS::CloudWatch::Alarm

AWS::CloudWatch::Alarm 类型创建 CloudWatch 警报。

此类型支持更新。有关更新该资源的更多信息,请参阅 PutMetricAlarm。有关更新堆栈的详细信息,请参阅 AWS CloudFormation 堆栈更新

语法

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

JSON

{ "Type" : "AWS::CloudWatch::Alarm", "Properties" : { "ActionsEnabled" : Boolean, "AlarmActions" : [ String, ... ], "AlarmDescription" : String, "AlarmName" : String, "ComparisonOperator" : String, "DatapointsToAlarm" : Integer, "Dimensions" : [ Dimension, ... ], "EvaluateLowSampleCountPercentile" : String, "EvaluationPeriods" : Integer, "ExtendedStatistic" : String, "InsufficientDataActions" : [ String, ... ], "MetricName" : String, "Metrics" : [ MetricDataQuery, ... ] "Namespace" : String, "OKActions" : [ String, ... ], "Period" : Integer, "Statistic" : String, "Threshold" : Double, "TreatMissingData" : String, "Unit" : String } }

YAML

Type: AWS::CloudWatch::Alarm Properties: ActionsEnabled: Boolean AlarmActions: - 字符串 AlarmDescription: String AlarmName: String ComparisonOperator: String DatapointsToAlarm: Integer Dimensions: - Dimension EvaluateLowSampleCountPercentile: String EvaluationPeriods: Integer ExtendedStatistic: String InsufficientDataActions: - 字符串 MetricName: String Metrics: - MetricDataQuery Namespace: String OKActions: - 字符串 Period: Integer Statistic: String Threshold: Double TreatMissingData: String Unit: String

属性

ActionsEnabled

指示在对 CloudWatch 警报的状态进行更改期间是否应执行操作。

Required: No

Type: Boolean

更新要求无需中断

AlarmActions

当此警报从任何其他状态转换为 ALARM 状态时,要执行的操作列表。将每个操作指定为一个 Amazon 资源名称 (ARN)。有关创建警报以及可指定的操作的更多信息,请参阅 Amazon CloudWatch API Reference 中的 PutMetricAlarm 以及 Amazon CloudWatch 用户指南 中的创建 Amazon CloudWatch 警报

注意

对于 Auto Scaling 扩展策略,您只能指定一个策略。如果关联多个策略,Amazon CloudWatch 仅执行第一个扩展策略。

Required: No

Type: List of String values

更新要求无需中断

AlarmDescription

警报的描述。

Required: No

Type: String

更新要求无需中断

AlarmName

警报的名称。如果不指定名称,则 AWS CloudFormation 会生成一个唯一物理 ID 并将该 ID 用作警报名称。有关更多信息,请参阅 名称类型

重要

如果指定一个名称,您将无法执行需要替换此资源的更新。您可以执行不需要或者只需要部分中断的更新。如果必须替换资源,请指定新名称。

Required: No

Type: String

更新要求替换

ComparisonOperator

在比较指定的 StatisticThreshold 时使用的算术运算。AWS CloudFormation 将 Statistic 值作为第一个操作数。

可以指定以下值:GreaterThanOrEqualToThresholdGreaterThanThresholdLessThanThresholdLessThanOrEqualToThreshold

Required: Yes

Type: String

更新要求无需中断

DatapointsToAlarm

在触发警报时必须达到的违例数据点数。只有在设置“N 个数据点中的 M 个数据点”警报时,才会使用该属性。在这种情况下,该值为 M。有关更多信息,请参阅 Amazon CloudWatch 用户指南 中的评估警报

Required: No

Type: Integer

更新要求无需中断

Dimensions

警报指标的维度。

Required: No

类型指标维度列表

更新要求无需中断

EvaluateLowSampleCountPercentile

仅用于基于百分位的警报。指定在数据点过少而不具备统计显著性时是否对数据进行评估并视情况更改警报状态。

Required: No

Type: String

更新要求无需中断

EvaluationPeriods

时间段数,在此期间将数据与指定的阈值进行比较。

Required: Yes

Type: Integer

更新要求无需中断

ExtendedStatistic

指标的百分位数统计。指定介于 p0.0 到 p100 之间的值。

Required: Conditional.必须指定 ExtendedStatisticStatistic 属性。

Type: String

更新要求无需中断

InsufficientDataActions

当该警报转换为 INSUFFICIENT_DATA 状态时要执行的操作列表。将每个操作指定为一个 Amazon 资源编号 (ARN)。目前,支持的唯一操作是发布到 Amazon SNS 主题或发布到 Auto Scaling 策略。

Required: No

Type: List of String values

更新要求无需中断

MetricName

与警报关联的指标的名称。有关可指定的指标的更多信息,请参阅 Amazon CloudWatch 用户指南 中的 Amazon CloudWatch 命名空间、维度和指标参考

Required: No

Type: String

更新要求无需中断

Metrics

指定要返回的指标数据。

Required: No

Type: MetricDataQuery 属性类型列表

更新要求无需中断

Namespace

与警报关联的指标的命名空间。

Required: No

Type: String

更新要求无需中断

OKActions

当该警报转换为 OK 状态时要执行的操作列表。将每个操作指定为一个 Amazon 资源编号 (ARN)。目前,支持的唯一操作是发布到 SNS 主题或发布到 Auto Scaling 策略。

Required: No

Type: List of String values

更新要求无需中断

Period

应用指定统计数据的时间。以 60 的倍数指定时间 (秒)。

Required: No

Type: Integer

更新要求无需中断

Statistic

要应用至警报相关指标的统计数据。

您可以指定以下值:SampleCountAverageSumMinimumMaximum

Required: Conditional.必须指定 ExtendedStatisticStatistic 属性。

Type: String

更新要求无需中断

Threshold

指定统计数据的比较值。

Required: Yes

Type: Double

更新要求无需中断

TreatMissingData

设置该警报应如何处理缺失数据点。如果忽略 TreatMissingData,则使用 missing 的默认行为。有关更多信息,请参阅 Amazon CloudWatch API Reference 中的 PutMetricAlarm 以及 Amazon CloudWatch 用户指南 中的配置 CloudWatch 警报如何处理缺少的数据

有效值breachingnotBreachingignoremissing

Required: No

Type: String

更新要求无需中断

Unit

与警报关联的指标的单位。

您可以指定以下值: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 或 None。

Required: No

Type: String

更新要求无需中断

返回值

Ref

在将 AWS::CloudWatch::Alarm 类型指定为 Ref 函数的参数时,AWS CloudFormation 将返回 AlarmName 值。

有关使用 Ref 功能的更多信息,请参阅参考

Fn::GetAtt

Fn::GetAtt 返回一个此类型指定属性的值。以下为可用属性和示例返回值。

Arn

CloudWatch 警报的 Amazon 资源名称 (ARN),如 arn:aws:cloudwatch:us-east-2:123456789012:alarm:myCloudWatchAlarm-CPUAlarm-UXMMZK36R55Z

有关使用 Fn::GetAtt 的更多信息,请参见 Fn::GetAtt

示例

有关示例,请参阅 Amazon CloudWatch 模板代码段

本页内容: