AWS CloudFormation
ユーザーガイド (API バージョン 2010-05-15)

AWS::CloudWatch::Alarm

AWS::CloudWatch::Alarm タイプは、アラームを指定し、指定されたメトリクスまたはメトリクス計算式に関連付けます。

オペレーションがアラームを作成したときに、アラームの状態は即時に INSUFFICIENT_DATA に設定されます。その後アラームが評価され、その状態が適切に設定されます。新しい状態に関連付けられている任意のアクションはそれから実行されます。

既存のアラームを更新すると、その状態は変更されないままですが、更新によりアラームの前の設定は完全に上書きされます。

構文

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: - 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

プロパティ

ActionsEnabled

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

必須: いいえ

タイプ: ブール値

Update requires: No interruption

AlarmActions

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

必須: いいえ

タイプ: 文字列のリスト

最大: 5

Update requires: No interruption

AlarmDescription

アラームの説明。

必須: いいえ

タイプ: 文字列

最小: 0

最大: 1024

Update requires: No interruption

AlarmName

アラームの名前。名前を指定しない場合、AWS CloudFormation は一意の物理 ID を生成し、その ID をアラーム名として使用します。

重要

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

必須: いいえ

タイプ: 文字列

最小: 1

最大: 255

Update requires: Replacement

ComparisonOperator

指定した statistic および threshold の値を比較するときに使用する算術演算。指定した statistic の値が 1 番目のオペランドとして使用されます。

GreaterThanThresholdGreaterThanOrEqualToThresholdLessThanThresholdLessThanOrEqualToThreshold のいずれかの値を指定できます。

必須: はい

タイプ: 文字列

許可された値: GreaterThanOrEqualToThreshold | GreaterThanThreshold | LessThanOrEqualToThreshold | LessThanThreshold

Update requires: No interruption

DatapointsToAlarm

アラームをトリガーするために超過する必要のあるデータポイントの数。これは、「N 個中 M 個」のアラームを設定している場合にのみ使用されます。この場合、この値は M です。詳細については、Amazon CloudWatch ユーザーガイドの「アラームを評価する」を参照してください。

必須: いいえ

タイプ: 整数

最小: 1

Update requires: No interruption

Dimensions

アラームに関連付けられているメトリクスのディメンション。数式に基づくアラームの場合は、Dimensions を指定できません。代わりに Metrics を使用します。

必須: いいえ

タイプ: Dimension のリスト

最大: 10

Update requires: No interruption

EvaluateLowSampleCountPercentile

パーセンタイルに基づくアラームでのみ使用されます。ignore の場合、統計的に有意となるにはデータポイントが少なすぎる期間中には、アラームの状態は変わりません。evaluate の場合、またはこのパラメータを使用しなかった場合、アラームは常に評価され、使用可能なデータポイント数に関係なく状態が変わる可能性があります。

必須: いいえ

タイプ: 文字列

最小: 1

最大: 255

Update requires: No interruption

EvaluationPeriods

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

必須: はい

タイプ: 整数

最小: 1

Update requires: No interruption

ExtendedStatistic

アラームに関連付けられているメトリクスのパーセンタイル統計。p0.0~p100 の値を指定します。

数式に基づくアラームの場合は、ExtendedStatistic を指定できません。代わりに Metrics を使用します。

必須: いいえ

タイプ: 文字列

パターン: p(\d{1,2}(\.\d{0,2})?|100)

Update requires: No interruption

InsufficientDataActions

このアラームが他の状態から INSUFFICIENT_DATA 状態に遷移するときに実行されるアクションのリスト。各アクションは Amazon リソースネーム (ARN) として指定されます。

必須: いいえ

タイプ: 文字列のリスト

最大: 5

Update requires: No interruption

MetricName

アラームに関連付けられているメトリクスの名前。これは、メトリクスに基づくアラームの場合に必須です。数式に基づくアラームの場合は、代わりに Metrics を使用し、MetricName を指定することはできません。

必須: いいえ

タイプ: 文字列

最小: 1

最大: 255

Update requires: No interruption

Metrics

メトリクス計算式の結果に基づいてアラームを作成できるようにする配列。配列内の各項目は、メトリクスを取得するか、数式を実行します。

Metrics パラメータを指定する場合は、MetricNameDimensionsPeriodNamespaceStatistic、または ExtendedStatistic を指定することはできません。

必須: いいえ

タイプ: MetricDataQuery のリスト

Update requires: No interruption

Namespace

アラームに関連付けられているメトリクスの名前空間。これは、メトリクスに基づくアラームの場合に必須です。数式に基づくアラームの場合、Namespace を指定することはできず、代わりに Metrics を使用します。

必須: いいえ

タイプ: 文字列

最小: 1

最大: 255

パターン: [^:].*

Update requires: No interruption

OKActions

このアラームが他の状態から OK 状態に遷移するときに実行されるアクションのリスト。各アクションは Amazon リソースネーム (ARN) として指定されます。

必須: いいえ

タイプ: 文字列のリスト

最大: 5

Update requires: No interruption

Period

統計を適用する時間 (秒)。これは、メトリクスに基づくアラームの場合に必須です。数式に基づくアラームの場合、Period を指定することはできず、代わりに Metrics を使用します。

必須: いいえ

タイプ: 整数

最小: 1

Update requires: No interruption

Statistic

アラームに関連付けられているメトリクスの統計 (パーセンタイル以外)。パーセンタイル統計の場合は、ExtendedStatistic を使用します。

数式に基づくアラームの場合は、Statistic を指定できません。代わりに Metrics を使用します。

必須: いいえ

タイプ: 文字列

許可された値: Average | Maximum | Minimum | SampleCount | Sum

Update requires: No interruption

Threshold

指定された統計と比較する値。

必須: はい

タイプ: 倍精度

Update requires: No interruption

TreatMissingData

このアラームが不足しているデータポイントを処理する方法を設定します。有効な値は、breachingnotBreachingignore、および missing です。詳細については、Amazon CloudWatch ユーザーガイドの「CloudWatch アラームが欠落データを処理する方法の設定」を参照してください。

このパラメータを省略すると、デフォルト動作である missing が使用されます。

必須: いいえ

タイプ: 文字列

最小: 1

最大: 255

Update requires: No interruption

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 です。

必須: いいえ

タイプ: 文字列

許可された値: Bits | Bits/Second | Bytes | Bytes/Second | Count | Count/Second | Gigabits | Gigabits/Second | Gigabytes | Gigabytes/Second | Kilobits | Kilobits/Second | Kilobytes | Kilobytes/Second | Megabits | Megabits/Second | Megabytes | Megabytes/Second | Microseconds | Milliseconds | None | Percent | Seconds | Terabits | Terabits/Second | Terabytes | Terabytes/Second

Update requires: No interruption

戻り値

Ref

アラーム名 (TestAlarm など) を このリソースの論理 ID を組み込みの Ref 関数に渡すと、Ref が返ります。。

For more information about using the Ref function, see Ref.

Fn::GetAtt

Fn::GetAtt 組み込み関数は、このタイプの指定された属性の値を返します。以下には、利用可能な属性とサンプル戻り値のリストが示されます。

Fn::GetAtt 組み込み関数の使用方法の詳細については、「Fn::GetAtt」を参照してください。

Arn

CloudWatch アラームの ARN (arn:aws:cloudwatch:us-west-2:123456789012:alarm:myCloudWatchAlarm-CPUAlarm-UXMMZK36R55Z など)。

以下の資料も参照してください。