View a markdown version of this page

CloudWatch アラームの設定 - AWS クラウド開発キット (AWS CDK) v2
既存のメトリクスの使用独自のメトリクスの作成アラームの作成

これは AWS CDK v2 デベロッパーガイドです。旧版の CDK v1 は 2022 年 6 月 1 日にメンテナンスを開始し、2023 年 6 月 1 日にサポートを終了しました。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

CloudWatch アラームの設定

aws-cloudwatch パッケージを使用して、CloudWatch メトリクスに Amazon CloudWatch アラームをセットアップします。事前定義されたメトリクスを使用するか、独自のメトリクスを作成できます。

既存のメトリクスの使用

多くの AWS コンストラクトライブラリモジュールでは、メトリクスを持つオブジェクトのインスタンスで便利なメソッドにメトリクス名を渡すことにより、既存のメトリクスにアラームを設定できます。例えば、Amazon SQS キューを指定すると、キューの metric() メソッドから ApproximateNumberOfMessagesVisible のメトリクスを取得できます。

例
TypeScript
const metric = queue.metric("ApproximateNumberOfMessagesVisible");
JavaScript
const metric = queue.metric("ApproximateNumberOfMessagesVisible");
Python
metric = queue.metric("ApproximateNumberOfMessagesVisible")
Java
Metric metric = queue.metric("ApproximateNumberOfMessagesVisible");
C#
var metric = queue.Metric("ApproximateNumberOfMessagesVisible");

独自のメトリクスの作成

次のように独自のメトリクス作成します。ここでは、名前空間値は Amazon SQS キューには AWS/SQS のようなものである必要があります。メトリクスの名前およびディメンションを指定する必要もあります。

例
TypeScript
const metric = new cloudwatch.Metric({
  namespace: 'MyNamespace',
  metricName: 'MyMetric',
  dimensionsMap: { MyDimension: 'MyDimensionValue' }
});
JavaScript
const metric = new cloudwatch.Metric({
  namespace: 'MyNamespace',
  metricName: 'MyMetric',
  dimensionsMap: { MyDimension: 'MyDimensionValue' }
});
Python
metric = cloudwatch.Metric(
    namespace="MyNamespace",
    metric_name="MyMetric",
    dimensionsMap=dict(MyDimension="MyDimensionValue")
)
Java
Metric metric = Metric.Builder.create()
        .namespace("MyNamespace")
        .metricName("MyMetric")
        .dimensionsMap(java.util.Map.of(    // Java 9 or later
            "MyDimension", "MyDimensionValue"))
        .build();
C#
var metric = new Metric(this, "Metric", new MetricProps
{
    Namespace = "MyNamespace",
    MetricName = "MyMetric",
    Dimensions = new Dictionary<string, object>
    {
        { "MyDimension", "MyDimensionValue" }
    }
});

アラームの作成

既存のメトリクスまたは定義したメトリクスのいずれかがあると、アラームを作成できます。この例では、過去 3 つの評価期間のうち 2 つに 100 を超えるメトリクスがあるときにアラームが生成されます。comparisonOperator プロパティを使用し、アラームに「未満」などの比較を使用できます。「以上」は AWS CDK のデフォルトであるため、指定する必要はありません。

例
TypeScript
const alarm = new cloudwatch.Alarm(this, 'Alarm', {
  metric: metric,
  threshold: 100,
  evaluationPeriods: 3,
  datapointsToAlarm: 2,
});
JavaScript
const alarm = new cloudwatch.Alarm(this, 'Alarm', {
  metric: metric,
  threshold: 100,
  evaluationPeriods: 3,
  datapointsToAlarm: 2
});
Python
alarm = cloudwatch.Alarm(self, "Alarm",
    metric=metric,
    threshold=100,
    evaluation_periods=3,
    datapoints_to_alarm=2
)
Java
import software.amazon.awscdk.services.cloudwatch.Alarm;
import software.amazon.awscdk.services.cloudwatch.Metric;

Alarm alarm = Alarm.Builder.create(this, "Alarm")
        .metric(metric)
        .threshold(100)
        .evaluationPeriods(3)
        .datapointsToAlarm(2).build();
C#
var alarm = new Alarm(this, "Alarm", new AlarmProps
{
    Metric = metric,
    Threshold = 100,
    EvaluationPeriods = 3,
    DatapointsToAlarm = 2
});

アラームを作成する代替方法はメトリクスの createAlarm() メソッドを使用することであり、基本的に Alarm コンストラクターと同じプロパティを使用します。メトリクスは既知のため、渡す必要はありません。

例
TypeScript
metric.createAlarm(this, 'Alarm', {
  threshold: 100,
  evaluationPeriods: 3,
  datapointsToAlarm: 2,
});
JavaScript
metric.createAlarm(this, 'Alarm', {
  threshold: 100,
  evaluationPeriods: 3,
  datapointsToAlarm: 2,
});
Python
metric.create_alarm(self, "Alarm",
    threshold=100,
    evaluation_periods=3,
    datapoints_to_alarm=2
)
Java
metric.createAlarm(this, "Alarm", new CreateAlarmOptions.Builder()
        .threshold(100)
        .evaluationPeriods(3)
        .datapointsToAlarm(2)
        .build());
C#
metric.CreateAlarm(this, "Alarm", new CreateAlarmOptions
{
    Threshold = 100,
    EvaluationPeriods = 3,
    DatapointsToAlarm = 2
});