メンテナンスウィンドウのタスクを登録する際の疑似パラメータの使用

AWS Systems Manager のツールである Maintenance Windows でタスクを登録する際、4 つのタスクタイプのそれぞれに固有のパラメータを指定します。(CLI コマンドでは、これらは --task-invocation-parameters オプションを使用して指定されます)。

{{RESOURCE_ID}}、{{TARGET_TYPE}}、{{WINDOW_TARGET_ID}} などの擬似パラメータ構文を使用して、特定の値を参照することもできます。メンテナンスウィンドウタスクが実行されると、擬似パラメータプレースホルダーの代わりに正しい値を渡します。使用できる擬似パラメータすべてのリストについては、このトピックの後半の「サポートされる擬似パラメータ」を参照してください。

擬似パラメータの例

AWS Lambda タスクのペイロードが、ID でインスタンスを参照する必要があるとします。

INSTANCE または RESOURCE_GROUP メンテナンスウィンドウターゲットを使用しているかどうかに関係なく、これは {{RESOURCE_ID}} 擬似パラメータを使用することで実現できます。例:

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

Lambda タスクが、Amazon Elastic Compute Cloud (Amazon EC2) インスタンスに加えて、サポートされている別のターゲットタイプ (Amazon DynamoDB テーブルなど) に対して実行することを意図している場合は、同じ構文を使用でき、{{RESOURCE_ID}} はテーブルの名前のみを生成します。ただし、テーブルの完全な ARN が必要な場合は、次の例に示すように {{TARGET_ID}} を使用します。

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

ターゲットインスタンスやその他のリソースタイプに対しても、同じ構文を使用できます。複数のリソースタイプがリソースグループに追加されている場合、タスクは適切な各リソースに対して実行されます。

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

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

Amazon Elastic Block Store (Amazon EBS) ボリュームのスナップショットをコピーする Automation タスクを実行するには、AWS-CopySnapshot SSM ドキュメントを TaskArn 値として指定し、{{RESOURCE_ID}} 擬似パラメータを使用します。

"TaskArn": "AWS-CopySnapshot",
    "TaskType": "AUTOMATION"
    "TaskInvocationParameters": {
        "Automation": {
            "DocumentVersion": "1",
            "Parameters": {
                "SourceRegion": "us-east-2",
                "targetType":"RESOURCE_GROUP",
                "SnapshotId": [
                    "{{RESOURCE_ID}}"
                ]
            }
        }
    }

サポートされる擬似パラメータ

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