View a markdown version of this page

Uso de documentos de Automatización de Systems Manager - AWS Kit de herramientas para VS Code

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Uso de documentos de Automatización de Systems Manager

AWS Systems Manager le brinda visibilidad y control de su infraestructura en AWS. Systems Manager proporciona una interfaz de usuario unificada para que pueda ver los datos operativos de varios AWS servicios y automatizar las tareas operativas en todos sus AWS recursos.

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 implementación y mantenimiento comunes como, por ejemplo, crear o actualizar una imagen de máquina de Amazon (AMI). En este tema se describe cómo crear, editar, publicar y eliminar documentos de automatización con AWS Toolkit for Visual Studio Code.

Hipótesis y requisitos previos

Antes de comenzar, asegúrese de que:

Permisos de IAM para documentos de Systems Manager Automation

En el kit de herramientas para VS Code, debe tener un perfil de credenciales que contenga los permisos de AWS Identity and Access Management (IAM) necesarios para crear, editar, publicar y eliminar documentos de Automatización de Systems Manager. En el siguiente documento de política se definen los permisos de IAM necesarios que se pueden utilizar en una política maestra:

JSON
{ "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. Para obtener información sobre cómo configurar su perfil de credenciales, consulte AWS Credenciales de IAM.

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

Puede crear un nuevo documento de Automatización en formato JSON o YAML utilizando Visual Studio Code. Cuando crea un documento de Automatización nuevo, se presenta en un archivo sin título. Puedes darle un nombre a tu archivo y guardarlo en VS Code; sin embargo, el nombre del archivo no estará visible para ti AWS.

Para crear un documento de Automatización nuevo
  1. Abra VS Code.

  2. En el menú Ver, seleccione Paleta de comandos para abrir la paleta de comandos.

  3. En la paleta de comandos, escriba Kit de herramientas de AWS : crear un nuevo documento de Systems Manager local.

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

  5. Elija JSON o YAML.

    Se crea un nuevo documento de Automatización.

nota

El nuevo documento de Automatización en VS Code no aparece automáticamente en AWS. Debe publicarlo en AWS antes de poder ejecutarlo.

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

Utilice el AWS Explorador para buscar los documentos existentes de Systems Manager Automation. Al abrir un documento de Automatización existente, aparece un archivo sin título en VS Code.

Para abrir el documento de Automatización
  1. Abra VS Code.

  2. En la barra de navegación de la izquierda, seleccione AWS para abrir el Explorador de AWS .

  3. En el AWS Explorador, para Systems Manager, seleccione el icono de descarga del documento que desea abrir y, a continuación, seleccione la versión del documento. El archivo se abrirá en el formato de esa versión. De lo contrario, seleccione Descargar como JSON o Descargar como YAML.

nota

Aunque se guarde localmente un documento de Automatización como un archivo en VS Code, no implica que aparezca en AWS. Debe publicarse en él AWS antes de ejecutarlo.

Edición de un documento de Automatización de Systems Manager

Si es propietario de algún documento de automatización, aparecerá en la categoría Mi propiedad de los documentos de Systems Manager del AWS Explorador. Puede ser propietario de los documentos de automatización que ya existan y de los documentos nuevos o actualizados en AWS los que haya publicado anteriormente AWS desde VS Code.

Cuando abre un documento de Automatización para editarlo en VS Code, puede hacer más con él que en la Consola de administración de AWS. Por ejemplo:

  • Hay una validación de esquemas tanto en formato JSON como YAML.

  • Hay fragmentos disponibles en el editor de documentos para que pueda crear cualquiera de los diferentes tipos de paso de automatización.

  • La característica de autocompletar se admite en varias opciones de JSON y YAML.

Uso de versiones

Los documentos de Automatización de Systems Manager utilizan versiones para la administración de cambios. Puede elegir la versión predeterminada para un documento de Automatización en VS Code.

Para establecer una versión predeterminada
  • En el AWS Explorador, navegue hasta el documento en el que desea establecer la versión predeterminada, abra el menú contextual (con el botón derecho) del documento y seleccione Establecer la versión predeterminada.

    nota

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

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

Después de editar su documento de automatización en VS Code, puede publicarlo en AWS.

Para publicar el documento de Automatización
  1. Abra el documento de Automatización que quiere publicar siguiendo el procedimiento descrito en Apertura de un documento de automatización de Systems Manager existente.

  2. Haga los cambios que quiera que se publiquen. Para obtener más información, consulte Edición de un documento de Automatización de Systems Manager.

  3. En la parte superior derecha del archivo abierto, seleccione el icono de carga.

  4. En el cuadro de diálogo del flujo de trabajo de publicación, elija la AWS región en la que desea publicar el documento de automatización.

  5. Si va a publicar un documento nuevo, elija Creación rápida. De lo contrario, elija Actualización rápida para actualizar un documento de automatización existente en esa AWS región.

  6. Introduzca el nombre del documento de Automatización.

Cuando publicas una actualización en un documento de automatización existente en AWS, se agrega una nueva versión al documento.

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

Puede eliminar documentos de Automatización en VS Code. 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 ejecutado, no se eliminan los recursos de AWS que se crearon o modificaron cuando se inició.

Para eliminar el documento de Automatización
  1. Abra VS Code.

  2. En la barra de navegación de la izquierda, seleccione AWS para abrir el Explorador de AWS .

  3. En el AWS Explorador, en Systems Manager, abra el menú contextual (haga clic con el botón derecho) del documento que desea eliminar y seleccione Eliminar documento.

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

Una vez publicado el documento de automatización AWS, puede ejecutarlo para realizar tareas en su nombre en su AWS cuenta. Para ejecutar tu documento de automatización, utilizas las Consola de administración de AWS API de Systems Manager AWS CLI, la o la Herramientas de AWS para 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 quieres usar uno de los AWS SDK con las API de Systems Manager para ejecutar tu documento de automatización, consulta las referencias de los AWS SDK.

nota

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