メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

AWS::CloudWatch::Alarm

AWS::CloudWatch::Alarm タイプは CloudWatch アラームを作成します。

このタイプは更新をサポートしています。このリソースの更新の詳細については、PutMetricAlarm を参照してください。スタックの更新の詳細については、「AWS CloudFormation スタックの更新」を参照してください。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

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

YAML

Copy
Type: "AWS::CloudWatch::Alarm" Properties: ActionsEnabled: Boolean AlarmActions: - 文字列 AlarmDescription: String AlarmName: String ComparisonOperator: String Dimensions: - Dimension EvaluateLowSampleCountPercentile: String EvaluationPeriods: Integer ExtendedStatistic: String InsufficientDataActions: - 文字列 MetricName: String Namespace: String OKActions: - 文字列 Period: Integer Statistic: String Threshold: Double TreatMissingData: String Unit: String

プロパティ

ActionsEnabled

CloudWatch アラームの状態の変更中にアクションが実行される必要があるかどうかを示します。

Required: No

Type: Boolean

更新に伴う要件: 中断はありません。

AlarmActions

このアラームが ALARM 以外の状態から ALARM 状態に遷移するときに実行されるアクションのリスト。各アクションを Amazon リソース番号 (ARN) として指定します。アラームの作成および指定可能なアクションの詳細については、『Amazon CloudWatch API リファレンス』の「PutMetricAlarm」および『Amazon CloudWatch ユーザーガイド』の「Amazon CloudWatch アラームの作成」を参照してください。

注記

Auto Scaling スケーリングポリシーに 1 つのポリシーのみを指定できます。複数のポリシーを関連付ける場合、Amazon CloudWatch は最初のスケーリングポリシーのみを実行します。

Required: No

Type: List of String values

更新に伴う要件: 中断はありません。

AlarmDescription

アラームの説明。

Required: No

Type: String

更新に伴う要件: 中断はありません。

AlarmName

アラームの名前。名前を指定しない場合、AWS CloudFormation は一意の物理 ID を生成し、その ID をアラーム名として使用します。詳細については、「Name タイプ」を参照してください。

重要

名前を指定すると、このリソースの置換が必要な更新はできません。中断が不要であるか、一定の中断が必要な更新であれば、行うことができます。リソースを置き換える必要がある場合は、新しい名前を指定します。

Required: No

Type: String

更新に伴う要件: 置換

ComparisonOperator

指定した Statistic および Threshold を比較するときに使用する算術演算。AWS CloudFormation は、1 番目のオペランドとして Statistic の値を使用します。

次の値を指定できます。GreaterThanOrEqualToThresholdGreaterThanThresholdLessThanThresholdLessThanOrEqualToThreshold

Required: Yes

Type: String

更新に伴う要件: 中断はありません。

Dimensions

アラームのメトリックスのディメンション。

Required: No

: メトリクスディメンション のリスト

更新に伴う要件: 中断はありません。

EvaluateLowSampleCountPercentile

パーセンタイルに基づくアラームでのみ使用されます。統計的に十分なデータポイントがない場合、データを評価し、アラーム状態を変更する可能性があるかどうかを指定します。

Required: No

Type: String

更新に伴う要件: 中断はありません。

EvaluationPeriods

指定した [Threshold] の値とデータを比較する時間。

Required: Yes

Type: Integer

更新に伴う要件: 中断はありません。

ExtendedStatistic

メトリックスのパーセンタイル統計。p0.0 と p100 の間の値を指定します。

Required: Conditional。ExtendedStatistic または Statistic プロパティのどちらかを指定する必要があります。

Type: String

更新に伴う要件: 中断はありません。

InsufficientDataActions

このアラームが INSUFFICIENT_DATA 状態に遷移するときに実行されるアクションのリスト。各アクションを Amazon リソース番号 (ARN) として指定します。現在サポートされているアクションは、Amazon SNS トピックまたは Auto Scaling ポリシーへの発行のみです。

Required: No

Type: List of String values

更新に伴う要件: 中断はありません。

MetricName

アラームに関連付けられているメトリクスの名前。指定できるメトリクスの詳細については、Amazon CloudWatch ユーザーガイドの「Amazon CloudWatch の名前空間、ディメンション、メトリクスのリファレンス」を参照してください。

Required: Yes

Type: String

更新に伴う要件: 中断はありません。

Namespace

アラームに関連付けられているメトリックスの名前空間。

Required: Yes

Type: String

更新に伴う要件: 中断はありません。

OKActions

このアラームが OK 状態に遷移するときに実行されるアクションのリスト。各アクションを Amazon リソース番号 (ARN) として指定します。現在サポートされているアクションは、SNS トピックまたは Auto Scaling ポリシーへの発行のみです。

Required: No

Type: List of String values

更新に伴う要件: 中断はありません。

Period

指定した統計を適用する期間。60 の倍数で、時間を秒単位で指定します。

Required: Yes

Type: Integer

更新に伴う要件: 中断はありません。

Statistic

アラームに関連付けられているメトリクスに適用する統計。

以下の値を指定できます。SampleCountAverageSumMinimum、または Maximum

Required: Conditional。ExtendedStatistic または Statistic プロパティのどちらかを指定する必要があります。

Type: String

更新に伴う要件: 中断はありません。

Threshold

指定した [Statistic] の値と比較する値。

Required: Yes

Type: Double

更新に伴う要件: 中断はありません。

TreatMissingData

このアラームが不足しているデータポイントを処理する方法を設定します。TreatMissingData が省略された場合は、missing のデフォルトの動作が使用されます。詳細については、『Amazon CloudWatch API リファレンス』の「PutMetricAlarm」および『Amazon CloudWatch ユーザーガイド』の「CloudWatch アラームが欠落データを処理する方法の設定」を参照してください。

有効な値: breaching, notBreaching, ignore, missing

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 タイプを指定すると、AWS CloudFormation は AlarmName の値を返します。

Ref 関数の使用方法の詳細については、「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 テンプレートスニペット」を参照してください。

このページの内容: