Uso de documentos de automatización de Systems Manager - AWS Cloud9
Hipótesis y requisitos previosPermisos de IAM para documentos de Systems Manager AutomationCreación de un nuevo documento de automatización de Systems ManagerPublicación de un documento de automatización de Systems ManagerEdición de un documento de automatización de Systems Manager existenteUso de versionesEliminación de un documento de automatización de Systems ManagerEjecución de un documento de automatización de Systems Manager

AWS Cloud9 ya no está disponible para los nuevos clientes. Los clientes existentes de AWS Cloud9 pueden seguir utilizando el servicio con normalidad. Más información

Uso de documentos de automatización de Systems Manager

Con AWS Systems Manager, tiene visibilidad y control de su infraestructura de AWS. Systems Manager proporciona una interfaz de usuario unificada que puede usar para ver los datos operativos de varios servicios de Servicios de AWS y automatizar tareas operativas en todos sus recursos de AWS.

Un documento de Systems Manager define las acciones que Systems Manager lleva a cabo en las instancias administradas. Un documento de automatización es un tipo de documento de Systems Manager que usa para llevar a cabo tareas de mantenimiento e implementación comunes. Esto incluye crear o actualizar una Imagen de máquina de Amazon (AMI). En este tema se destaca cómo crear, editar, publicar y eliminar documentos de automatización con AWS Toolkit.

Temas

Hipótesis y requisitos previos

Antes de empezar, asegúrese de que se cumplan las siguientes condiciones:

Permisos de IAM para documentos de Systems Manager Automation

Para crear, editar, publicar y eliminar documentos de automatización de Systems Manager, debe tener un perfil de credenciales que contenga los permisos de AWS Identity and Access Management (IAM) necesarios. En el siguiente documento de política se definen los permisos de IAM necesarios que se pueden utilizar en una política de entidad principal.

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "ssm:ListDocuments",
                "ssm:ListDocumentVersions",
                "ssm:DescribeDocument",
                "ssm:GetDocument",
                "ssm:CreateDocument",
                "ssm:UpdateDocument",
                "ssm:UpdateDocumentDefaultVersion",
                "ssm:DeleteDocument"
            ],
            "Resource": "*"
        }
    ]
}

Para obtener más información sobre cómo crear una política de IAM, consulte Creación de políticas de IAM en la Guía del usuario de IAM.

Creación de un nuevo documento de automatización de Systems Manager

Puede crear un documento de automatización en JSON o YAML con AWS Toolkit. Cuando crea un documento de automatización, se presenta en un archivo sin título. Puede asignar un nombre al archivo y guardarlo. Sin embargo, el archivo no se cargará en AWS hasta que lo publique.

Para crear un documento de automatización nuevo

  1. Elija el icono de búsqueda del panel de navegación de la izquierda o presione Ctrl + P para abrir el panel de búsqueda.

  2. En el panel de búsqueda, comience a ingresar el término “systems manager” y elija el comando AWS: Create a new Systems Manager Document Locally (AWS: crear un nuevo documento de Systems Manager local) cuando se muestre.

  3. Elija una de las plantillas iniciales para un ejemplo de "Hello World".

  4. Elija JSON o YAML como formato del documento.

    El editor muestra el nuevo documento de automatización.

nota

Cuando crea por primera vez un documento de automatización local, no aparece automáticamente en AWS. Para poder ejecutarlo, debe publicarlo en AWS.

Publicación de un documento de automatización de Systems Manager

Después de crear o editar el documento de automatización en AWS Toolkit, puede publicarlo en AWS.

Para publicar el documento de automatización

  1. Abra el documento de automatización que quiere publicar con el procedimiento que se describe en Edición de un documento de automatización de Systems Manager existente.

  2. Elija el icono de búsqueda del panel de navegación de la izquierda o presione Ctrl + P para abrir el panel de búsqueda.

  3. En el panel de búsqueda, comience a ingresar el término “systems manager” y elija el comando AWS: Publish a new Systems Manager Document (AWS: publicar un nuevo documento de Systems Manager) cuando se muestre.

  4. En Step 1 of 3 (Paso 1 de 3), elija la Región de AWS en la que quiere publicar el documento.

  5. En Step 2 of 3 (Paso 2 de 3), elija Quick Create (Creación rápida) para crear un documento de automatización. O elija Quick Update (Actualización rápida) para actualizar un documento de automatización existente en esa región.

    nota

    Solo puede actualizar los documentos de automatización de su propiedad. Si elige Quick Update (Actualización rápida) y no tiene ningún documento en esa región, un mensaje le avisa de que tiene que publicar un documento antes de actualizarlo.

  6. En Step 3 of 3 (Paso 3 de 3), en función de lo que haya elegido en el paso anterior, ingrese el nombre de un nuevo documento de automatización o seleccione un documento existente que quiera actualizar.

    nota

    Al publicar una actualización de un documento de automatización existente en AWS, se agrega una nueva versión al documento. Si un documento tiene varias versiones, puede establecer una como predeterminada.

Edición de un documento de automatización de Systems Manager existente

Usa AWS Explorer para buscar documentos de automatización de Systems Manager existentes. Al abrir un documento existente, aparece un archivo sin título en un editor de AWS Cloud9. Hay tres tipos de documento de automatización que descarga:

  • Owned by Amazon (Propiedad de Amazon): documentos de SSM configurados previamente que se pueden utilizar al especificar parámetros en tiempo de ejecución.

  • Owned by me (De mi propiedad): documentos que he creado y publicado en AWS.

  • Shared with me (Compartido conmigo): documentos que los propietarios han compartido, en función de su ID de Cuenta de AWS.

Los únicos tipos de documentos que puede actualizar en AWS son los Owned by me (De mi propiedad). También puede descargar los documentos de automatización compartidos o propiedad de Amazon y editarlos en AWS Cloud9. Sin embargo, al publicar en AWS, debe usar la opción de crear un documento nuevo o actualizar un documento existente de su propiedad. No puede crear nuevas versiones de documentos que tengan otro propietario o sean propiedad de Amazon.

Para obtener más información, consulte Crear documentos de AWS Systems Manager en la Guía del usuario de AWS Systems Manager.

  1. En AWS Explorer, en Systems Manager, elija la categoría de documento de SSM que quiere descargar: Owned by Amazon (Propiedad de Amazon), Owned by me (De mi propiedad) o Shared with me (Compartido conmigo).

  2. Para un documento específico, abra el menú contextual (haga clic con el botón derecho) y elija Download as YAML (Descargar como YAML) o Download as JSON (Descargar como JSON).

    El documento SSM con formato se muestra en una nueva pestaña del editor.

Después de finalizar la edición, puede usar el comando AWS: Publish a new Systems Manager Document (Publicar un nuevo documento de Systems Manager) para crear un nuevo documento en la nube de AWS o actualizar un documento existente de su propiedad.

Uso de versiones

Los documentos de automatización de Systems Manager utilizan versiones para la administración de cambios. Con AWS Toolkit, puede establecer la versión predeterminada del documento, que es la versión que se usa al ejecutar el documento.

Para establecer una versión predeterminada

  • En AWS Explorer, vaya al documento en el que quiere establecer la versión predeterminada, abra el menú contextual (haga clic con el botón derecho) del documento y elija Set default version (Establecer versión predeterminada).

    nota

    Si el documento elegido solo tiene una versión, no podrá cambiar el valor predeterminado.

Eliminación de un documento de automatización de Systems Manager

Puede eliminar los documentos de automatización de su propiedad en AWS Toolkit. Al eliminar un documento de automatización, se elimina el documento y todas sus versiones.

importante

  • La eliminación es una acción destructiva que no se puede deshacer.

  • Al eliminar un documento de automatización que ya se ha iniciado, no se eliminan los recursos de AWS que se crearon o modificaron cuando se ejecutó.

  • La eliminación solo se permite si el documento es de su propiedad.

Para eliminar el documento de automatización

  1. En el panel de AWS Explorer, en Systems Manager, expanda Owned by Me (De mi propiedad) para mostrar sus documentos.

  2. Abra el menú contextual (haga clic con el botón derecho) del documento que quiera eliminar y elija Delete document (Eliminar documento).

  3. En el cuadro de diálogo de advertencia que se muestra, elija Delete (Eliminar) para confirmarlo.

Ejecución de un documento de automatización de Systems Manager

Después de publicar el documento de automatización en AWS, puede ejecutarlo para llevar a cabo tareas en su nombre en su Cuenta de AWS. Para ejecutar el documento de automatización, utilice la AWS Management Console, las API de Systems Manager, la AWS CLI o AWS Tools for PowerShell. Para obtener instrucciones sobre cómo ejecutar un documento de automatización, consulte Ejecución de una automatización sencilla en la Guía del usuario de AWS Systems Manager.

Como alternativa, si quiere usar uno de los AWS SDK con las API de Systems Manager para ejecutar el documento de automatización, consulte las referencias de AWS SDK.

importante

La ejecución de un documento de automatización puede crear nuevos recursos en AWS y puede incurrir en costos de facturación. Le recomendamos encarecidamente que comprenda lo que creará su documento de automatización en su cuenta antes de ejecutarlo.