¿Cómo agrego parámetros al registrar una tarea de automatización con las ventanas de mantenimiento de Systems Manager?

Descripción breve

Al registrar una tarea de automatización de la ventana de mantenimiento, debe proporcionar los valores de los parámetros de entrada que se transfieren a la tarea cuando se ejecuta la tarea. Los parámetros de entrada necesarios son los mismos que los parámetros definidos en el contenido del documento de automatización. Puede utilizar valores de pseudoparámetros en los campos de parámetros de entrada obligatorios para hacer referencia de forma dinámica a los ID de recursos a los que se destina la ventana de mantenimiento. Los pseudoparámetros, como {{RESOURCE_ID}}, le permiten dirigir varios recursos para no tener que introducir cada ID de recurso de forma individual.

Por ejemplo, el documento AWS-StopEC2Instance proporcionado por Amazon requiere que introduzca el ID de la instancia como parámetro. Use un pseudoparámetro para que la ventana de mantenimiento se dirija a varias instancias o cuando no conozca el ID de la instancia.

Nota: Para el tipo de destino INSTANCE, los pseudoparámetros {{TARGET_ID}} y {{RESOURCE_ID}} solo proporcionan el ID de instancia. Sin embargo, para el tipo de destino RESOURCE_GROUP, {{TARGET_ID}} y {{RESOURCE_ID}} devuelven el ID en diferentes formatos. Para obtener más información y una lista de los pseudoparámetros disponibles, consulte Utilización de pseudoparámetros en el registro de las tareas del periodo de mantenimiento.

Resolución

Puede utilizar la consola de Systems Manager o la interfaz de la línea de comandos de AWS (AWS CLI) para registrar las tareas de automatización de la ventana de mantenimiento con pseudoparámetros.

Uso de la consola de Systems Manager

Siga estos pasos:

1. Abra la consola de Systems Manager.
2. En el panel de navegación, elija Ventanas de mantenimiento y, a continuación, seleccione la ventana de mantenimiento.
3. En la página Tareas, elija Registrar tareas y, a continuación, elija Registrar tarea de automatización.
4. En la página Registrar tarea de automatización, introduzca la siguiente información:
   En Documento de automatización, seleccione el documento en el que desee que se ejecute la tarea.
   En Destino, especifique la información del destino.
   En Parámetros ** de entrada**, introduzca un valor de pseudoparámetro. Por ejemplo, introduzca TARGET_ID o RESOURCE_ID para el parámetro que requiere un identificador de recurso.
   En Control de tasas, especifique la información de su tasa.
   En Rol de servicio de IAM, seleccione un rol de AWS Identity and Access Management (IAM).
5. Elija Registrar tarea de automatización.

Utilización de AWS CLI

Nota: Si se muestran errores al poner en marcha comandos de AWS CLI, consulte Solución de errores de AWS CLI. Además, asegúrese de utilizar la versión más reciente de la AWS CLI.

Ejecute el comando register-task-with-maintenance-window.

El siguiente comando de ejemplo registra una tarea de automatización que incluye el 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

Cuando se ejecuta la tarea de la ventana de mantenimiento, el ID de recurso de cada destino pasa al sistema. En el ejemplo anterior, el parámetro InstanceId recibe el ID de instancia correspondiente para cada destino del grupo de destinos.

Información relacionada

Pseudoparámetros compatibles

Opciones de parámetros para el comando register-task-with-maintenance-windows