Automation 向けのウェブフック統合の作成 - AWS Systems Manager

Automation 向けのウェブフック統合の作成

オートメーション中にウェブフックを使用してメッセージを送信するには、統合を作成します。ランブック内で aws:invokeWebhook アクションを使用すると、統合をオートメーション中に呼び出すことができます。ウェブフックをまだ作成していない場合は、「統合用のウェブフックの作成」を参照してください。aws:invokeWebhook アクションの詳細については、「aws:invokeWebhook – オートメーションのウェブフック統合を呼び出す」を参照してください。

次の手順に示すように、Systems Manager のオートメーションコンソール、または任意のコマンドラインツールを使用して、統合を作成できます。

統合の作成 (コンソール)

オートメーション用に統合を作成するには (コンソール)
  1. AWS Systems Manager コンソール (https://console.aws.amazon.com/systems-manager/) を開きます。

  2. ナビゲーションペインで [オートメーション] を選択します。

  3. [Integrations] (統合) タブを開きます。

  4. [Add integration] (統合を追加)、[Webhook] (ウェブフック) の順にクリックします。

  5. 統合に適用する、必須の値および任意のオプション値を入力します。

  6. [Add] (追加) をクリックして統合を作成します。

統合の作成 (コマンドライン)

コマンドラインツールを使用して統合を作成するためには、その統合に必須の SecureString パラメータを作成します。オートメーションは、統合に関する情報を格納するために、Parameter Store 内で予約済みの名前空間 (Systems Manager の一機能) を使用します。AWS Management Console を使用して統合を作成する場合には、ユーザーに代わりオートメーションがこのプロセスを処理します。名前空間に続いて、作成する統合のタイプ、および統合の名前を指定する必要があります。現在、オートメーションでは webhook タイプの統合がサポートされています。

webhook タイプの統合では、以下のフィールドがサポートされます。

  • 説明

  • headers

  • payload

  • URL

開始する前に

まだ AWS Command Line Interface (AWS CLI) または AWS Tools for PowerShell をインストールして設定していない場合は、インストールして設定します。詳細については、「AWS CLI の最新バージョンをインストールまたは更新します。」および「AWS Tools for PowerShell のインストール」を参照してください。

オートメーション用に統合を作成するには (コマンドライン)
  • 以下のコマンドを実行して、統合に必須な SecureString パラメータを作成します。各リソースプレースホルダーの例をユーザー自身の情報に置き換えます。/d9d01087-4a3f-49e0-b0b4-d568d7826553/ssm/integrations/webhook/ 名前空間は、Parameter Store 内で統合用として予約されています。パラメータの名前は、この名前空間と同じものを (後に統合の名前を続けて) 使用する必要があります。例: /d9d01087-4a3f-49e0-b0b4-d568d7826553/ssm/integrations/webhook/myWebhookIntegration

    Linux & macOS
    aws ssm put-parameter \ --name "/d9d01087-4a3f-49e0-b0b4-d568d7826553/ssm/integrations/webhook/myWebhookIntegration" \ --type "SecureString" \ --data-type "aws:ssm:integration" \ --value '{"description": "My first webhook integration for Automation.", "url": "myWebHookURL"}'
    Windows
    aws ssm put-parameter ^ --name "/d9d01087-4a3f-49e0-b0b4-d568d7826553/ssm/integrations/webhook/myWebhookIntegration" ^ --type "SecureString" ^ --data-type "aws:ssm:integration" ^ --value "{\"description\":\"My first webhook integration for Automation.\",\"url\":\"myWebHookURL\"}"
    PowerShell
    Write-SSMParameter ` -Name "/d9d01087-4a3f-49e0-b0b4-d568d7826553/ssm/integrations/webhook/myWebhookIntegration" ` -Type "SecureString" -DataType "aws:ssm:integration" -Value '{"description": "My first webhook integration for Automation.", "url": "myWebHookURL"}'

統合用のウェブフックの作成

プロバイダでウェブフックを作成する場合は、以下の点に注意してください。

  • プロトコルは HTTPS を使用する必要があります。

  • カスタムリクエストヘッダーをサポートする必要があります。

  • デフォルトのリクエストボディを指定できます。

  • デフォルトのリクエストボディは、aws:invokeWebhook アクションを使用して統合が呼び出された時点でオーバーライドされます