Como adiciono parâmetros ao registrar uma tarefa de Automação nas janelas de manutenção do Systems Manager?

Breve descrição

Ao registrar uma tarefa de Automação da janela de manutenção, você deve fornecer valores de parâmetros de entrada que passem para a tarefa quando a tarefa é executada. Os parâmetros de entrada necessários são os mesmos definidos no conteúdo do documento de Automação. Você pode usar valores de pseudoparâmetros nos campos de parâmetros de entrada necessários para referenciar dinamicamente os IDs de recursos direcionados pela janela de manutenção. Pseudoparâmetros, como {{RESOURCE_ID}}, permitem que você segmente vários recursos sem inserir cada ID de recurso individualmente.

Por exemplo, o documento AWS-StopEC2Instance fornecido pela Amazon exige que você insira o ID da instância como parâmetro. Se você quiser que a janela de manutenção tenha como alvo várias instâncias, ou se não souber o ID da instância, você pode usar um pseudoparâmetro.

Observação: Para o tipo de destino INSTANCE, os pseudoparâmetros {{TARGET_ID}} e {{RESOURCE_ID}} produzem somente o ID da instância. No entanto, para o tipo de destino RESOURCE_GROUP, {{TARGET_ID}} e {{RESOURCE_ID}} retornam o ID em formatos diferentes. Para obter mais informações e uma lista dos pseudoparâmetros disponíveis, consulte Sobre os pseudoparâmetros.

Você pode usar o console do Systems Manager ou a AWS Command Line Interface (AWS CLI) para registrar tarefas de Automação da janela de manutenção com pseudoparâmetros.

Resolução

Usando o console

Para registrar uma tarefa de automação da janela de manutenção usando pseudoparâmetros dinâmicos, siga estas etapas:

1. Abra o console do Systems Manager e escolha Janelas de manutenção no painel de navegação.
2. Selecione sua janela de manutenção e escolha Exibir detalhes.
3. Na guia Tarefas, escolha Registrar tarefas, Registrar tarefa de automação.
4. Em Documento de automação, selecione o documento que você deseja que a tarefa execute.
5. Especifique suas Metas, Controle de classe e função de serviço do IAM.
6. Em Parâmetros de entrada, insira um valor de pseudoparâmetro (por exemplo, {{TARGET_ID}} ou {{RESOURCE_ID}}) para o parâmetro que exige uma ID de recurso.
7. Escolha Registrar tarefa de Automação.

Usar a AWS CLI

Observação: Se você receber erros ao executar comandos da AWS CLI, verifique se está usando a versão mais recente da AWS CLI.

O exemplo a seguir usa a AWS CLI para registrar uma tarefa de automação, incluindo o parâmetro {{RESOURCE_ID}}:

aws ssm register-task-with-maintenance-window --window-id mw-1234567890EXAMPLE --targets Key=WindowTargetIds,Values=6c226ea3-463a-4533-8a2d-EXAMPLE --task-arn AWS-StopEC2Instance --task-type AUTOMATION --name MyMaintenanceWindowTask --max-concurrency 10 --max-errors 5 --task-invocation-parameters={\"Automation\":{\"Parameters\":{\"InstanceId\":[\"{{RESOURCE_ID}}\"]}}} --service-role-arn YOUR_SERVICE_ROLE_ARN

Quando a tarefa da janela de manutenção é executada, a ID de Recurso correspondente para cada alvo passa para o sistema. No exemplo anterior, o parâmetro InstanceId recebe o ID da instância correspondente para cada destino no grupo de destino.

Informações relacionadas

Pseudoparâmetros com suporte

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