"register-task-with-maintenance-window" コマンドのパラメーターオプション - AWS Systems Manager

AWS Systems Manager Change Manager は新規顧客に公開されなくなりました。既存のお客様は、通常どおりサービスを引き続き使用できます。詳細については、「AWS Systems Manager Change Manager の可用性の変更」を参照してください。

"register-task-with-maintenance-window" コマンドのパラメーターオプション

register-task-with-maintenance-window コマンドには、必要に応じてタスクを設定するためのいくつかのオプションがあります。それらは、必須のオプション、任意のオプション、1 つのメンテナンスウィンドウタスクタイプにのみ適用されるオプションです。

このトピックでは、このチュートリアルのセクションでサンプルを使用するのに役立つ、これらのオプションのいくつかについて情報を提供します。すべてのコマンドオプションについては、AWS CLI コマンドリファレンスの「register-task-with-maintenance-window」を参照してください。

コマンドオプション: --task-arn

--task-arn オプションでは、タスクが実行するリソースを指定するために使用します。以下の表に示しているように、指定する値は登録するタスクのタイプによって異なります。

メンテナンスウィンドウタスクの TaskArn 形式
メンテナンスウィンドウタスクのタイプ TaskArn 値

RUN_COMMAND および AUTOMATION

TaskArn は SSM ドキュメント名または Amazon リソースネーム (ARN) です。以下に例を示します。

AWS-RunBatchShellScript

-または-

arn:aws:ssm:region:111122223333:document/My-Document.

LAMBDA

TaskArn は関数名または ARN です。以下に例を示します。

SSMMy-Lambda-Function

-または-

arn:aws:lambda:region:111122223333:function:SSMMyLambdaFunction.

重要

Maintenance Windows の IAM ポリシーでは、Lambda 関数名 (またはエイリアス) の前にプレフィックス SSM を付ける必要があります。このタイプのタスクを登録する前に、AWS Lambda で SSM を含めるようにその名前を更新します。例えば、Lambda 関数名が MyLambdaFunction の場合は、SSMMyLambdaFunction に変更します。

STEP_FUNCTIONS

TaskArn はステートマシン ARN です。以下に例を示します。

arn:aws:states:us-east-2:111122223333:stateMachine:SSMMyStateMachine.

重要

メンテナンスウィンドウの IAM ポリシーでは、Step Functions ステートマシン名の前に SSM を付ける必要があります。このタイプのタスクを登録する前に、AWS Step Functions を含むように SSM の名前を更新する必要があります。たとえば、ステートマシン名が MyStateMachine の場合は、SSMMyStateMachine に変更します。
コマンドオプション: --service-role-arn

メンテナンスウィンドウタスクを実行するときに AWS Systems Manager が引き受けるロール。

詳細については、Maintenance Windows を設定するを参照してください。

コマンドオプション: --task-invocation-parameters

--task-invocation-parameters オプションを使用して、4 つのタスクタイプのそれぞれに固有のパラメータを指定します。以下の表では、4 つのタスクタイプそれぞれでサポートされているパラメータを示しています。

注記

--task-invocation-parameters コンテンツでの {{TARGET_ID}} などの疑似パラメータの使用については、「メンテナンスウィンドウのタスクを登録する際の疑似パラメータの使用」を参照してください。

メンテナンスウィンドウタスク用のタスク呼び出しパラメータのオプション

メンテナンスウィンドウタスクのタイプ 使用できるパラメータ 例

RUN_COMMAND

Comment

DocumentHash

DocumentHashType

NotificationConfig

OutputS3BucketName

OutPutS3KeyPrefix

Parameters

ServiceRoleArn

TimeoutSeconds

 
"TaskInvocationParameters": {
        "RunCommand": {
            "Comment": "My Run Command task comment",
            "DocumentHash": "6554ed3d--truncated--5EXAMPLE",
            "DocumentHashType": "Sha256",
            "NotificationConfig": {
                "NotificationArn": "arn:aws:sns:region:123456789012:my-sns-topic-name",
                "NotificationEvents": [
                    "FAILURE"
                ],
                "NotificationType": "Invocation"
            },
            "OutputS3BucketName": "amzn-s3-demo-bucket",
            "OutputS3KeyPrefix": "S3-PREFIX",
            "Parameters": {
                "commands": [
                    "Get-ChildItem$env: temp-Recurse|Remove-Item-Recurse-force"
                ]
            },
            "ServiceRoleArn": "arn:aws:iam::123456789012:role/MyMaintenanceWindowServiceRole",
            "TimeoutSeconds": 3600
        }
    }

AUTOMATION

DocumentVersion

Parameters

 
"TaskInvocationParameters": {
        "Automation": {
            "DocumentVersion": "3",
            "Parameters": {
                "instanceid": [
                    "{{TARGET_ID}}"
                ]
            }
        }
    }

LAMBDA

ClientContext

Payload

Qualifier

 
"TaskInvocationParameters": {
        "Lambda": {
            "ClientContext": "ew0KICAi--truncated--0KIEXAMPLE",
            "Payload": "{ \"targetId\": \"{{TARGET_ID}}\", \"targetType\": \"{{TARGET_TYPE}}\" }",
            "Qualifier": "$LATEST"
        }
    }

STEP_FUNCTIONS

Input

Name

 
"TaskInvocationParameters": {
        "StepFunctions": {
            "Input": "{ \"targetId\": \"{{TARGET_ID}}\" }",
            "Name": "{{INVOCATION_ID}}"
        }
    }