Uso de un periodo de mantenimiento para enviar un comando que devuelve notificaciones de estado

Los siguientes procedimientos muestran cómo registrar una tarea de Run Command con su periodo de mantenimiento mediante la consola de AWS Systems Manager o la AWS Command Line Interface (AWS CLI). Run Command es una herramienta de AWS Systems Manager. Los procedimientos también describen cómo configurar la tarea de Run Command para devolver notificaciones de estado.

Antes de empezar

Si no ha creado un periodo de mantenimiento ni destinos registrados, consulte Crear y administrar periodos de mantenimiento mediante la consola para ver los pasos que indican cómo crear un periodo de mantenimiento y cómo registrar destinos.

Para recibir notificaciones del servicio de Amazon Simple Notification Service (Amazon SNS), adjunte una política de iam:PassRole al rol de servicio del Maintenance Windows especificado en la tarea registrada. Si no ha agregado permisos de iam:PassRole a su rol de servicio de Maintenance Windows, consulte Tarea 5: asociar la política iam:PassRole al rol de periodo de mantenimiento.

Registro de una tarea de Run Command a un periodo de mantenimiento que devuelve notificaciones (consola)

Utilice el siguiente procedimiento para registrar una tarea de Run Command configurada para devolver notificaciones de estado a su periodo de mantenimiento a través de la consola de Systems Manager.

Para registrar una tarea de Run Command con el periodo de mantenimiento que devuelve notificaciones (consola)

1. Abra la consola de AWS Systems Manager en https://console.aws.amazon.com/systems-manager/.

2. En el panel de navegación, elija Maintenance Windows.

3. Seleccione el periodo de mantenimiento en el cual desea registrar una tarea de Run Command configurada para enviar notificaciones de Amazon Simple Notification Service (Amazon SNS).

4. Elija Actions (Acciones) y, a continuación, elija Register Run Command task (Registrar tarea de Run Command).

5. (Opcional) En el campo Name (Nombre), ingrese el nombre de la tarea.

6. (Opcional) Introduzca una descripción en el campo Description (Descripción).

7. En Command document (Documento de comando), elija un documento de comando.

8. En Task priority (Prioridad de tarea), especifique una prioridad para esta tarea. Cero (0) es la prioridad más alta. Las tareas de un periodo de mantenimiento se programan por orden de prioridad. Las tareas que tienen la misma prioridad se programan en paralelo.

9. En la sección Targets (Destinos), seleccione un grupo de destino registrado o destinos no registrados.

10. En Rate control (Control de velocidad):

    • En Concurrency (Simultaneidad), especifique un número o un porcentaje de los nodos administrados en los que desea ejecutar el comando al mismo tiempo.

      nota

      Si seleccionó los destinos mediante la especificación de etiquetas aplicadas a nodos administrados o de grupos de recursos de AWS y no está seguro de cuántos nodos administrados tienen destino, limite el número de destinos que puede ejecutar el documento al mismo tiempo. Para ello, especifique un porcentaje.

    • En Error threshold (Umbral de errores), especifique cuándo desea parar la ejecución del comando en los demás nodos administrados después de que haya fallado en un número o un porcentaje de los nodos. Por ejemplo, si especifica tres errores, Systems Manager dejará de enviar el comando cuando se reciba el cuarto error. Los nodos administrados que estén procesando el comando todavía pueden enviar errores.

11. En el área IAM service role (Rol de servicio de IAM), elija el rol de servicio de Maintenance Windows que tiene permisos de iam:PassRole al rol de SNS.

    nota

    Agregue permisos de iam:PassRole al rol Maintenance Windows para permitir que Systems Manager pase el rol de SNS a Amazon SNS. Si no ha agregado iam:PassRole permisos, consulte Tarea 5 en el tema Monitoreo de los cambios de estado de Systems Manager mediante las notificaciones de Amazon SNS.

12. (Opcional) En Output options (Opciones de salida), para guardar la salida del comando en un archivo, seleccione el cuadro Enable writing output to S3 (Permitir la escritura de salida en S3). Ingrese los nombres del bucket y del prefijo (carpeta) en los cuadros.

    nota

    Los permisos de S3 que conceden la capacidad de escribir datos en un bucket de S3 son los del perfil de instancias asignado al nodo administrado, no los del usuario de IAM que realiza esta tarea. Para obtener más información, consulte Configuración de permisos de instancia requeridos para Systems Manager o Creación de un rol de servicio de IAM para un entorno híbrido. Además, si el bucket de S3 especificado se encuentra en una Cuenta de AWS diferente, verifique que el perfil de instancias o el rol de servicio de IAM asociado al nodo administrado tenga los permisos necesarios para escribir en ese bucket.

13. En la sección SNS notifications (Notificaciones de SNS), realice lo siguiente:

    • Elija Enable SNS Notifications (Habilitar notificaciones de SNS).

    • En IAM role (Rol de IAM), elija el Nombre de recurso de Amazon (ARN) del rol de IAM de Amazon SNS que ha creado en la tarea 3 en Monitoreo de los cambios de estado de Systems Manager mediante las notificaciones de Amazon SNS para iniciar Amazon SNS.

    • En SNS topic (Tema de SNS), ingrese el ARN del tema de Amazon SNS que se va a utilizar.

    • En Event type (Tipo de evento), elija los eventos para los que desea recibir notificaciones.

    • En el campo Notification type (Tipo de notificaciones), elija recibir notificaciones para cada copia de un comando enviado a varios nodos (invocaciones) o el resumen de comandos.

14. En la sección Parameters (Parámetros), ingrese los parámetros requeridos en función del documento de Command que elija.

15. Elija Register run command task (Registrar tarea de Run Command).

16. Después de que se ejecute su periodo de mantenimiento la próxima vez, busque en su casilla de email un mensaje de Amazon SNS y ábralo. Amazon SNS puede tardar unos minutos en enviar el mensaje por email.

Registro de una tarea de Run Command a un periodo de mantenimiento que devuelve notificaciones (CLI)

Utilice el siguiente procedimiento para registrar una tarea de Run Command configurada para devolver notificaciones de estado a su periodo de mantenimiento a través de la AWS CLI.

Para registrar una tarea de Run Command con el periodo de mantenimiento que devuelve notificaciones (CLI)

nota

Para administrar mejor las opciones para las tareas, este procedimiento utiliza la opción de comando --cli-input-json con valores opcionales almacenados en un archivo JSON.

1. En el equipo local, cree un archivo con el nombre RunCommandTask.json.

2. Pegue los siguientes contenidos en el archivo :

   {
       "Name": "Name",
       "Description": "Description",
       "WindowId": "mw-0c50858d01EXAMPLE",
       "ServiceRoleArn": "arn:aws:iam::account-id:role/MaintenanceWindowIAMRole",
       "MaxConcurrency": "1",
       "MaxErrors": "1",
       "Priority": 3,
       "Targets": [
           {
               "Key": "WindowTargetIds",
               "Values": [
                   "e32eecb2-646c-4f4b-8ed1-205fbEXAMPLE"
               ]
           }
       ],
       "TaskType": "RUN_COMMAND",
       "TaskArn": "CommandDocumentName",
       "TaskInvocationParameters": {
           "RunCommand": {
               "Comment": "Comment",
               "TimeoutSeconds": 3600,
               "NotificationConfig": {
                   "NotificationArn": "arn:aws:sns:region:account-id:SNSTopicName",
                   "NotificationEvents": [
                       "All"
                   ],
                   "NotificationType": "Command"
               },
               "ServiceRoleArn": "arn:aws:iam::account-id:role/SNSIAMRole"
           }
       }
   }

3. Reemplace los valores de ejemplo con información acerca de sus propios recursos.

   También puede restaurar opciones omitidas en este ejemplo si desea utilizarlas. Por ejemplo, puede guardar el resultado del comando en un bucket de S3.

   Para obtener más información, consulte register-task-with-maintenance-window en la Referencia de los comandos de AWS CLI.

4. Guarde el archivo.

5. En el directorio en su equipo local donde ha guardado el archivo, ejecute el siguiente comando.

   aws ssm register-task-with-maintenance-window --cli-input-json file://RunCommandTask.json

   importante

   Asegúrese de incluir file:// antes del nombre de archivo. Es obligatorio en este comando.

   En caso de éxito, este comando devuelve información similar a la siguiente.

   {
       "WindowTaskId": "j2l8d5b5c-mw66-tk4d-r3g9-1d4d1EXAMPLE"
   }
                       

6. Después de que se ejecute su periodo de mantenimiento la próxima vez, busque en su casilla de email un mensaje de Amazon SNS y ábralo. Amazon SNS puede tardar unos minutos en enviar el mensaje por email.

Para obtener más información acerca del registro de tareas para un periodo de mantenimiento mediante la línea de comandos, consulte Registrar tareas con el periodo de mantenimiento.