View a markdown version of this page

Parameter Store イベントに基づいた通知の設定またはアクションのトリガー - AWS Systems Manager

Parameter Store イベントに基づいた通知の設定またはアクションのトリガー

Amazon EventBridge および Amazon Simple Notification Service (Amazon SNS) を使用して、AWS Systems Manager のパラメータに変更があった旨の通知を受け取ることができます。イベントは、ベストエフォートベースで出力されます。例えば、次のことを行うルールを作成できます。

  • パラメータまたはパラメータラベルのバージョンが作成、更新、または削除されたときに通知が届きます。

  • パラメータの有効期限切れ、期限切れ間近、または指定された期間中に変更されていないなど、パラメータポリシーに関する変更またはステータスについての通知が届きます。

    注記

    パラメータポリシーは、高度なパラメータ階層を使用するパラメータに利用できます。料金が適用されます。詳細については、「Parameter Store でのパラメータポリシーの割り当て」および「Parameter Store でのパラメータ階層の選択」を参照してください。

  • 特定のパラメータイベントのターゲットに対して他のアクションを開始します。たとえば、有効期限が切れたか、削除された場合に、そのパラメータを自動的に再作成する AWS Lambda 関数を実行することができます。承認された AMI ID を保存するパラメータが更新されたときに Lambda 関数を呼び出すための通知を設定できます。Lambda 関数では、起動テンプレートの更新や、新しい AMI ID を使用するデプロイワークフローの開始が可能です。

EventBridge は、Run Command コマンドの実行と Automation の実行、およびその他多くの AWS のサービスでのアクションもサポートしています。Run Command と Automation はどちらも AWS Systems Manager のツールです。詳細については、「Amazon EventBridge ユーザーガイド」を参照してください。

開始する前に

作成したルールのターゲットアクションを指定するために必要なリソースを作成します。例えば、作成したルールが通知の送信用である場合は、まず Amazon SNS トピックを作成します。詳細については、「Amazon Simple Notification Service デベロッパーガイド」の「Amazon SNS の使用開始」を参照してください。

パラメータおよびパラメータポリシー用の EventBridge ルールを設定する

このトピックは、次のセクションで構成されています。

  • AWS アカウント の 1 つ以上のパラメータに発生したイベントに基づき、ターゲットを呼び出す EventBridge ルールを作成する方法。

  • AWS アカウント の 1 つ以上のパラメータポリシーに発生したイベントに基づき、ターゲットを呼び出す EventBridge ルールを作成する方法。詳細パラメータを作成する際、パラメータの失効日、パラメータの有効期限の失効前に通知を受信するタイミング、パラメータが変更されていないことを示す通知を送信するまでの時間を指定します。次の手順を使用して、これらのイベントの通知を設定します。詳細については、「Parameter Store でのパラメータポリシーの割り当て」および「Parameter Store でのパラメータ階層の選択」を参照してください。

Systems Manager パラメータまたはパラメータポリシー用に EventBridge を設定するには
  1. Amazon EventBridge コンソール のhttps://console.aws.amazon.com/events/ を開いてください。

  2. [イベントパターンを含む EventBridge ルール] を選択し、[ルールを作成] を選択します。

  3. [アドバンストビルダー] が未選択の場合は選択します。

  4. ルールの名前と説明を入力します。次に、[次へ] を選択します。

    ルールには同じリージョン内および同じイベントバス上の別のルールと同じ名前を付けることはできません。

  5. [イベントバス] で、このルールに関連付けるイベントバスを選択します。このルールをユーザー自身の AWS アカウント の一致するイベントで開始する場合は、[Default] (デフォルト) 選択します。アカウントの AWS のサービスで発生したイベントは、常にアカウントのデフォルトのイベントバスに移動します。

  6. [Rule type] (ルールタイプ) で、デフォルトの [Rule with an event pattern] (イベントパターンを持つルール) を選択したままにします。

  7. [次へ] を選択します。

  8. [イベントソース] で、デフォルトの [AWS イベントまたは EventBridge パートナーイベント] を選択したままにします。[Sample event] (サンプルイベント) セクションはスキップできます。

  9. [Event pattern] (イベントパターン) の場合は次のいずれかを実行します。

    • [Custom pattern (JSON editor)] (カスタムパターン (JSON エディター)) を選択します。

    • [Event pattern] (イベントパターン) で、パラメータまたはパラメータポリシーのどちらのルールを作成するかに応じて、次のいずれかの内容をボックスに貼り付けます。

      Parameter
      { "source": [ "aws.ssm" ], "detail-type": [ "Parameter Store Change" ], "detail": { "name": [ "parameter-1-name", "/parameter-2-name/level-2", "/parameter-3-name/level-2/level-3" ], "operation": [ "Create", "Update", "Delete", "LabelParameterVersion" ] } }
      Parameter policy
      { "source": [ "aws.ssm" ], "detail-type": [ "Parameter Store Policy Action" ], "detail": { "parameter-name": [ "parameter-1-name", "/parameter-2-name/level-2", "/parameter-3-name/level-2/level-3" ], "policy-type": [ "Expiration", "ExpirationNotification", "NoChangeNotification" ] } }
    • 次の例に示されているように、アクションを行うパラメータやオペレーションの内容を変更します。

      Parameter

      この例では、Oncall/Project/Teamlead という名前のいずれかのパラメータが更新されると、アクションが実行されます。

      { "source": [ "aws.ssm" ], "detail-type": [ "Parameter Store Change" ], "detail": { "name": [ "/Oncall", "/Project/Teamlead" ], "operation": [ "Update" ] } }
      Parameter policy

      この例では、OncallDuties という名前のパラメータが失効し、削除されると、アクションが実行されます。

      { "source": [ "aws.ssm" ], "detail-type": [ "Parameter Store Policy Action" ], "detail": { "parameter-name": [ "/OncallDuties" ], "policy-type": [ "Expiration" ] } }
  10. [次へ] を選択します。

  11. [Target 1] (ターゲット 1) で、ターゲットタイプとサポートされているリソースを選択します。例えば、[AWS サービス] を選択してから [SNS トピック] を選択した場合は、[トピック] に対して選択を行います。[CodePipeline] を選択した場合は、[Pipeline ARN] (パイプライン ARN) にパイプライン ARN を入力します。必要に応じて、追加の設定値を指定します。

    ヒント

    ルールに追加のターゲットが必要な場合は、[Add another target] (別のターゲットを追加) を選択します。

  12. [次へ] を選択します。

  13. (オプション) ルールに 1 つ以上のタグを入力します。詳細については、Amazon EventBridge ユーザーガイドAmazon EventBridge のタグを参照してください。

  14. [次へ] を選択します。

  15. ルールの作成を選択してください。