Sobre as opções de register-task-with-maintenance-windows - AWS Systems Manager

Sobre as opções de register-task-with-maintenance-windows

O comando register-task-with-maintenance-window fornece várias opções para configurar uma tarefa de acordo com as suas necessidades. Algumas são necessárias, algumas são opcionais, outras se aplicam somente a um único tipo de tarefa de janela de manutenção.

Este tópico fornece informações sobre algumas dessas opções para ajudar você a trabalhar com exemplos nesta seção do tutorial. Para obter mais informações sobre as opções de comando, consulte register-task-with-maintenance-window na Referência de comandos do AWS CLI.

Sobre a opção --task-arn

A opção --task-arn é usada para especificar o recurso no qual a tarefa é executada. O valor especificado depende do tipo de tarefa que você estiver registrando, conforme descrito na tabela a seguir.

Formatos de TaskArn para tarefas de janela de manutenção
Tipo de tarefa de janela de manutenção Valor de TaskArn

RUN_COMMAND e AUTOMATION

O TaskArn é o nome do documento SSM ou o Amazon Resource Name (ARN). Por exemplo:

AWS-RunBatchShellScript

- ou -

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

LAMBDA

TaskArn é o nome ou o ARN da função. Por exemplo:

SSMMy-Lambda-Function

- ou -

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

Importante

A política do Maintenance Windows para IAM requer a adição do prefixo SSM aos nomes das funções Lambda (ou alias) . Antes de prosseguir com o registro desse tipo de tarefa, atualize o nome no AWS Lambda para incluir SSM. Por exemplo, se o nome da função Lambda for MyLambdaFunction, altere-o para SSMMyLambdaFunction.

STEP_FUNCTIONS

TaskArn é o ARN da máquina de estado. Por exemplo:

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

Importante

A política do IAM para as janelas de manutenção requer o uso do prefixo Step Functions nos nomes das máquinas de estado com o SSM. Antes de registrar esse tipo de tarefa, é necessário atualizar o nome no AWS Step Functions a fim de incluir SSM. Por exemplo, se o nome da máquina de estado for MyStateMachine, altere para SSMMyStateMachine.
Sobre a opção --service-role-arn

A função a ser assumida pelo AWS Systems Manager ao executar a tarefa de janela de manutenção.

Para obter mais informações, consulte Configurar o Maintenance Windows.

Sobre a opção --task-invocation-parameters

A opção --task-invocation-parameters é usada para especificar os parâmetros que são exclusivos para cada um dos quatro tipos de tarefa. Os parâmetros compatíveis com cada um dos quatro tipos de tarefa estão descritos na tabela a seguir.

nota

Para obter informações sobre como usar pseudoparâmetros em conteúdo --task-invocation-parameters, como {{TARGET_ID}}, consulte Usar pseudoparâmetros ao registrar tarefas da janela de manutenção.

Opções de parâmetros de invocação de tarefas para tarefas de janela de manutenção

Tipo de tarefa de janela de manutenção Parâmetros disponíveis Exemplo

RUN_COMMAND

Comentário

DocumentHash

DocumentHashType

NotificationConfig

OutputS3BucketName

OutPutS3KeyPrefix

Parâmetros

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": "DOC-EXAMPLE-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

Parâmetros

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

LAMBDA

ClientContext

Carga útil

Qualificador

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

STEP_FUNCTIONS

Entrada

Nome

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