register-task-with-maintenance-windows 命令的參數選項 - AWS Systems Manager

AWS Systems ManagerChange Manager 不再開放給新客戶。現有客戶可以繼續正常使用該服務。如需詳細資訊，請參閱AWS Systems ManagerChange Manager可用性變更。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

register-task-with-maintenance-windows 命令的參數選項

register-task-with-maintenance-window 命令會提供多種選項，可供您根據需求來設定任務。有些是必要的，有些是選用的，有些僅適用於單一維護時段任務類型。

本主題提供部分這些選項的相關資訊，以協助您使用此教學區段中的範本。如需其他命令選項的相關資訊，請參閱《AWS CLI 命令參考》中的 register-task-with-maintenance-window。

命令選項：--task-arn

選項 --task-arn 可用來指定執行任務的資源。您指定的值取決於註冊的任務類型，如下表所述。

維護時段任務的 TaskArn 格式
維護時段任務類型 TaskArn 值

RUN_COMMAND 與 AUTOMATION

TaskArn 是 SSM 文件名稱或 Amazon Resource Name (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 選項可用來指定四種任務類型特有的參數。下表描述四種任務類型支援的參數。

注意

如需在 --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}}"
        }
    }