Como trabalhar com documentos de automação do Systems Manager - AWS Cloud9
Suposições e pré-requisitosPermissões do IAM para documentos de automação do Systems ManagerCriar um novo documento de automação do Systems ManagerComo publicar um documento de automação do Systems ManagerEditar um documento de automação do Systems Manager já existenteComo trabalhar com versõesComo excluir um documento de automação do Systems ManagerComo executar um documento de automação do Systems Manager

O AWS Cloud9 não está mais disponível para novos clientes. Os clientes atuais do AWS Cloud9 podem continuar usando o serviço normalmente. Saiba mais

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

Com o AWS Systems Manager, você tem visibilidade e controle da infraestrutura na AWS. O Systems Manager oferece uma interface de usuário unificada para que você possa usar dados operacionais de diversos Serviços da AWS e automatizar tarefas operacionais em seus recursos da AWS.

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 imagem de máquina da Amazon (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

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

Permissões do IAM para documentos de automação do Systems Manager

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 do AWS Identity and Access Management (IAM). O documento de política a seguir define as permissões do IAM necessárias que podem ser usadas em uma política de entidade 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 política do IAM, consulte Criação de políticas do IAM no Guia do usuário do IAM.

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 só será carregado para a AWS quando for publicado.

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. Você deve publicá-lo na AWS para que possa executá-lo.

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

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

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 Step 1 of 3 (Etapa 1 de 3), selecione a Região da AWS na qual 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 na 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 do Systems Manager já existentes. Ao abrir um documento existente, ele aparece como um arquivo sem título em um editor do AWS Cloud9. Você pode baixar três tipos de documento de automação:

  • Owned by Amazon (De propriedade da Amazon): documentos SSM pré-configurados que podem ser usados especificando parâmetros no tempo de execução.

  • Owned by me (De minha propriedade): documentos que eu criei e publiquei na AWS.

  • Shared with me (Compartilhado comigo): documentos que os proprietários compartilharam com você, com base em seu ID da Conta da AWS.

O único tipo de documento que você pode atualizar na AWS são aqueles do tipo 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, quando você publica na AWS, é necessário criar um 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, selecione a categoria de documento SSM que deseja baixar: Owned by Amazon (De propriedade da Amazon), Owned by me (De minha propriedade) ou Shared with me (Compartilhado comigo).

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

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

Depois de concluir a edição, você pode usar o comando AWS: Publicar um novo documento do Systems Manager para criar um documento na Nuvem AWS ou atualizar um documento existente do qual você é o proprietário.

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 quando você executa o documento.

Para definir uma versão padrão

  • No AWS Explorer, procure o documento para o qual deseja definir a versão padrão, abra o menu de contexto (clique com o botão direito do mouse) do documento e selecione Set default version (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 de sua propriedade 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 (De minha propriedade) 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 na AWS, será possível executá-lo para realizar tarefas em seu nome em sua Conta da AWS. Para executar o documento de automação, você usa o AWS Management Console, as APIs do Systems Manager, a AWS CLI ou o AWS Tools for PowerShell. 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 quiser usar um dos AWS SDKs com as APIs do Systems Manager para executar o documento de automação, consulte Referências do AWS SDK.

Importante

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