Como trabalhar com documentos de automação do Systems Manager

Com AWS Systems Manager, você tem visibilidade e controle de sua infraestrutura ativados AWS. O Systems Manager fornece uma interface de usuário unificada que você pode usar para visualizar dados operacionais de vários AWS services e automatizar tarefas operacionais em seus AWS recursos.

Um documento do Systems Manager define as ações que o Systems Manager realiza nas suas instâncias gerenciadas. Um documento de automação é um tipo de documento do Systems Manager que é usado para realizar tarefas comuns de manutenção e implantação. Isso inclui criar ou atualizar uma Amazon Machine Image (AMI). Este tópico descreve como criar, editar, publicar e excluir documentos de automação com o AWS Toolkit.

Tópicos

• Suposições e pré-requisitos
• IAMpermissões para documentos do Systems Manager Automation
• Criar um novo documento de automação do Systems Manager
• Como publicar um documento de automação do Systems Manager
• Editar um documento de automação do Systems Manager já existente
• Como trabalhar com versões
• Como excluir um documento de automação do Systems Manager
• Como executar um documento de automação do Systems Manager
• Como solucionar problemas de documentos de automação do Systems Manager no AWS Toolkit

Suposições e pré-requisitos

Antes de começar, as seguintes condições devem ser atendidas:

• Você esteja familiarizado com o Systems Manager. Para obter mais informações, consulte o Guia do usuário do AWS Systems Manager .

• Você esteja familiarizado com os casos de uso de automação do Systems Manager. Para obter mais informações, consulte Automação do AWS Systems Manager no Guia do usuário do usuário do AWS Systems Manager .

IAMpermissões para documentos do Systems Manager Automation

Para criar, editar, publicar e excluir documentos de automação do Systems Manager, você deve ter um perfil de credenciais que contenha as permissões necessárias AWS Identity and Access Management (IAM). O documento de política a seguir define as IAM permissões necessárias que podem ser usadas em uma política 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 obter informações sobre como atualizar uma IAM política, consulte Criação de IAM políticas no Guia IAM do usuário.

Criar um novo documento de automação do Systems Manager

É possível criar um documento de automação em JSON ou YAML usando o AWS Toolkit. Quando você cria um documento de automação, ele é apresentado em um arquivo sem título. Você pode fornecer um nome ao seu arquivo e salvá-lo. No entanto, o arquivo não é carregado AWS até que você o publique.

Para criar um novo documento de automação

1. Selecione o ícone de pesquisa no painel de navegação esquerdo ou pressione Ctrl+P para abrir o painel Search (Pesquisar).

2. No painel Pesquisar, comece a inserir o termo “systems manager” e selecione o comando AWS: Criar um documento do Systems Manager localmente quando ele for exibido.

3. Selecione um dos modelos iniciais para um exemplo de “Hello World”.

4. Escolha JSON ou YAML como formato do documento.

   O editor exibe seu novo documento de automação.

nota

Ao criar um documento de automação local pela primeira vez, ele não aparece automaticamente na AWS. Antes de executá-lo, você deve publicá-lo em AWS.

Como publicar um documento de automação do Systems Manager

Depois de criar ou editar seu documento de automação no AWS Toolkit, você pode publicá-lo AWS no.

Para publicar seu documento de automação

1. Abra o documento de automação que você deseja publicar utilizando o procedimento descrito em Editar um documento de automação do Systems Manager já existente.

2. Selecione o ícone de pesquisa no painel de navegação esquerdo ou pressione Ctrl+P para abrir o painel Search (Pesquisar).

3. No painel Pesquisar, comece a inserir o termo “systems manager” e selecione o comando AWS: Publicar um novo documento do Systems Manager quando ele for exibido.

4. Para a Etapa 1 de 3, escolha Região da AWS onde você deseja publicar o documento.

5. Para a Etapa 2 de 3, selecione Quick Create (Criação rápida) para criar um documento de automação. Ou selecione Quick Update (Atualização rápida) para atualizar um documento de automação existente na respectiva região.

   nota

   Você pode atualizar apenas documentos de automação de sua propriedade. Se selecionar Quick Update (Atualização rápida) e não possuir nenhum documento nessa região, uma mensagem informa que é necessário publicar o documento antes de atualizá-lo.

6. Para a Etapa 3 de 3, dependendo da sua escolha na etapa anterior, insira o nome de um novo documento de automação ou selecione um documento existente para atualizar.

   nota

   Quando você publica uma atualização em um documento de automação existente no AWS, uma nova versão é adicionada ao documento. Se um documento tiver várias versões, será possível definir o padrão.

Editar um documento de automação do Systems Manager já existente

Você usa o AWS Explorer para encontrar documentos de automação existentes do Systems Manager. Quando você abre um documento existente, ele aparece como um arquivo sem título em um AWS Cloud9 editor. Você pode baixar três tipos de documento de automação:

• Propriedade da Amazon: SSM documentos pré-configurados que podem ser usados especificando parâmetros em tempo de execução.

• De minha propriedade: Documentos que eu criei e publiquei AWS.

• Compartilhado comigo: documentos que os proprietários compartilharam com você, com base na sua Conta da AWS identificação.

Os únicos tipos de documentos que você pode atualizar AWS são aqueles que são de minha propriedade. Você também pode baixar documentos de automação que são compartilhados ou de propriedade da Amazon e editá-los no AWS Cloud9. No entanto, ao publicar em AWS, você deve criar um novo documento ou atualizar um documento existente de sua propriedade. Você não pode criar novas versões de documentos que tenham outro proprietário ou que sejam de propriedade da Amazon.

Para mais informações, consulte Documentos do AWS Systems Manager no Guia do usuário do AWS Systems Manager .

1. No AWS Explorer, para Systems Manager, escolha a categoria do SSM documento que você deseja baixar: Propriedade da Amazon, Propriedade minha ou Compartilhado comigo.

2. Para um documento específico, abra o menu de contexto (clique com o botão direito do mouse) e escolha Baixar como YAML ou Baixar como JSON.

   O SSM documento formatado é exibido em uma nova guia do editor.

Depois de terminar a edição, você pode usar o comando AWS: Publish a new Systems Manager Document para criar um novo documento na AWS nuvem ou atualizar um documento existente de sua propriedade.

Como trabalhar com versões

Os documentos de automação do Systems Manager usam versões para gerenciamento de alterações. Com o AWS Toolkit, você pode definir a versão padrão do documento, que é a versão usada ao executar o documento.

Para definir uma versão padrão

• No AWS Explorer, navegue até o documento no qual você deseja definir a versão padrão, abra o menu de contexto (clique com o botão direito do mouse) do documento e escolha Definir versão padrão.

  nota

  Se o documento escolhido tiver apenas uma versão, não será possível alterar o padrão.

Como excluir um documento de automação do Systems Manager

Você pode excluir os documentos de automação que você possui no AWS Toolkit. A exclusão de um documento de automação exclui o documento e todas as versões do documento.

Importante

• A exclusão é uma ação destrutiva que não pode ser desfeita.

• A exclusão de um documento de automação que já foi iniciado não exclui os recursos da AWS que foram criados ou modificados quando ele foi executado.

• Só é permitido realizar a exclusão se o documento for de sua propriedade.

Para excluir seu documento de automação

1. No painel AWS Explorer, para Systems Manager, expanda Owned by Me para listar seus documentos.

2. Abra o menu de contexto (clique com o botão direito do mouse) do documento que você deseja excluir e selecione Delete document (Excluir documento).

3. Na caixa de diálogo exibida com um aviso, selecione Delete (Excluir) para confirmar.

Como executar um documento de automação do Systems Manager

Depois que seu documento de automação for publicado no AWS, você poderá executá-lo para realizar tarefas em seu nome no seu Conta da AWS. Para executar seu documento de automação, você usa o AWS Management Console, o Systems Manager APIs AWS CLI, o ou AWS Tools for PowerShell o. Para obter instruções sobre como executar um documento de automação, consulte Executar uma automação simples no Guia do usuário do AWS Systems Manager .

Como alternativa, se você quiser usar um dos AWS SDKs com o Systems Manager APIs para executar seu documento de automação, consulte as AWS SDKreferências.

Importante

A execução de um documento de automação pode criar novos recursos AWS e incorrer em custos de cobrança. Recomendamos enfaticamente que você entenda o que seu documento de automação criará em sua conta antes de executá-lo.