¿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}}, permiten seleccionar varios recursos sin 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. Si quiere que la ventana de mantenimiento se dirija a varias instancias o si no conoce el ID de la instancia, puede usar un pseudoparámetro.

Nota: Para el tipo de destino INSTANCE, los pseudoparámetros {{TARGET_ID}} y {{RESOURCE_ID}} solo muestran 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 obtener una lista de los pseudoparámetros disponibles, consulte Acerca de los pseudoparámetros.

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.

Resolución

Uso de la consola

Para registrar una tarea de automatización de la ventana de mantenimiento mediante pseudoparámetros dinámicos, siga estos pasos:

1. Abra la consola de Systems Manager y, a continuación, seleccione Ventanas de mantenimiento en el panel de navegación.
2. Seleccione su período de mantenimiento y, a continuación, elija Ver detalles.
3. En la pestaña Tareas, seleccione Registrar tareas, y Registrar tarea de automatización.
4. En Documento de automatización, seleccione el documento en el que desee que se ejecute la tarea.
5. Especifique sus Objetivos, Control de velocidad, y Rol de servicio de IAM.
6. Para los parámetros de entrada, introduzca un valor de pseudoparámetro (por ejemplo, {{TARGET_ID}} o {{RESOURCE_ID}}) para el parámetro que requiere un ID de recurso.
7. Elija Registrar tarea de automatización.

Uso de la AWS CLI

Nota: Si recibe errores al ejecutar los comandos de la AWS CLI, asegúrese de utilizar la versión más reciente de la AWS CLI.

El siguiente ejemplo usa la AWS CLI para registrar 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 correspondiente para cada objetivo 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

Acerca de las opciones de registro de tareas con ventanas de mantenimiento