AWS Systems Manager
ユーザーガイド

疑似パラメータについて

タスクを登録するときに、--task-invocation-parameters オプションを使用して、4 つのタスクタイプのそれぞれに固有のパラメータを指定します。{{TARGET_ID}} などの疑似パラメータ構文を使用して、特定の値を参照することもできます。メンテナンスウィンドウタスクが実行されると、擬似パラメータプレースホルダーの代わりに正しい値を渡します。

Run Command タスクの場合、ターゲット (インスタンス) への接続は自動的に処理されます。他のタスクタイプ (Automation、Step Functions、Lambda) の場合は、--task-invocation-parameters オプションに {{TARGET_ID}} 疑似パラメータを含める必要があります。タスクが実行されると、実際のインスタンス ID が {{TARGET_ID}} の代わりに渡されます。

たとえば、Lambda タスクのペイロードが実行時にインスタンス ID とターゲットタイプを参照する必要があるとします。タスクがインスタンス ID i-02573cafcfEXAMPLE の 1 つのインスタンスでのみ実行される場合は、以下を使用します。

"TaskArn": "arn:aws:lambda:us-east-2:111122223333:function:SSMTestFunction", "TaskType": "LAMBDA", "TaskInvocationParameters": { "Lambda": { "Payload": "{ \"targetId\": \"i-02573cafcfEXAMPLE\", \"targetType\": \"INSTANCE\" }", "Qualifier": "$LATEST", "ClientContext": "ew0KICAi--truncated--0KIEXAMPLE" } }

ただし、カスタム "targetId" フィールドに複数のインスタンス ID を含めると、オペレーションは失敗します。したがって、複数のインスタンスでタスクを実行するには、 {{TARGET_TYPE}} 擬似パラメータを使用し {{TARGET_ID}} ます。この場合、ターゲットグループ内の各インスタンスの ID は {{TARGET_ID}} 疑似パラメータを介してタスク実行に渡され、タスクはターゲットグループ内のすべてのインスタンスで実行されます。

"TaskArn": "arn:aws:lambda:us-east-2:111122223333:function:SSMTestFunction", "TaskType": "LAMBDA", "TaskInvocationParameters": { "Lambda": { "ClientContext": "ew0KICAi--truncated--0KIEXAMPLE", "Payload": "{ \"targetId\": \"{{TARGET_ID}}\", \"targetType\": \"{{TARGET_TYPE}}\" }", "Qualifier": "$LATEST" } }

別の例として、Amazon EC2 インスタンスを停止する Automation タスクを実行するには、AWS-StopEC2Instance SSM ドキュメントを TaskArn 値として指定し、{{TARGET_ID} 疑似パラメータを使用します。

"TaskArn": "AWS-StopEC2Instance", "TaskType": "AUTOMATION" "TaskInvocationParameters": { "Automation": { "DocumentVersion": "1", "Parameters": { "instanceId": [ "{{TARGET_ID}}" ] } } }

使用可能な擬似パラメータ

以下のリストでは、--task-invocation-parameters オプションの {{PSEUDO_PARAMETER}} 構文を使用して指定できる疑似パラメータについて説明しています。

  • TARGET_ID: ターゲットの ID。ターゲットタイプがインスタンス (現在唯一サポートされているタイプ) の場合、ターゲット ID はインスタンス ID です。

  • TARGET_TYPE: ターゲットのタイプ。現在は、インスタンスのみがサポートされています。

  • WINDOW_ID: ターゲットメンテナンスウィンドウの ID。

  • WINDOW_TASK_ID: 実行されているウィンドウタスクの ID。

  • WINDOW_TARGET_ID: ターゲット (ターゲット ID) を含むウィンドウターゲットの ID。

  • WINDOW_EXECUTION_ID: 現在のウィンドウ実行の ID。

  • TASK_EXECUTION_ID: 現在のタスク実行の ID。

  • INVOCATION_ID: 現在の呼び出しの ID。