

• O AWS Systems Manager CloudWatch Dashboard não estará mais disponível a partir de 30 de abril de 2026. Os clientes podem continuar usando o console do Amazon CloudWatch para visualizar, criar e gerenciar os painéis do Amazon CloudWatch exatamente como fazem hoje. Para obter mais informações, consulte a [documentação do Amazon CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Dashboards.html). 

# Tutorial: criar um runbook usando a experiência de design visual
<a name="visual-designer-tutorial"></a>

Neste tutorial, você aprenderá o básico de como trabalhar com a experiência de design visual fornecida pelo Systems Manager Automation. Na experiência de design visual, é possível criar um runbook que usa várias ações. Você usará o recurso de arrastar e soltar para organizar as ações na tela. Você também pesquisará, selecionará e configurará essas ações. Em seguida, você poderá visualizar o código YAML gerado automaticamente para o fluxo de trabalho do seu runbook, sair da experiência de design visual, executar o runbook e revisar os detalhes da execução.

Este tutorial também mostra como atualizar o runbook e visualizar a nova versão. No final do tutorial, você executa uma etapa de limpeza e exclui seu runbook.

Após concluir este tutorial, você saberá como usar a experiência de design visual para criar um runbook. Você também aprenderá a atualizar, executar e excluir seu runbook.

**nota**  
Antes de começar este tutorial, certifique-se de concluir a [Configurar a automação](automation-setup.md).

**Topics**
+ [Etapa 1: navegue até a experiência de design visual](#navigate-console)
+ [Etapa 2: criar um fluxo de trabalho](#create-workflow)
+ [Etapa 3: analisar o código gerado automaticamente](#view-generated-code)
+ [Etapa 4: executar seu novo runbook](#use-tutorial-runbook)
+ [Etapa 5: limpar](#cleanup-tutorial-runbook)

## Etapa 1: navegue até a experiência de design visual
<a name="navigate-console"></a>

1. Faça login no [console do Systems Manager Automation](https://console.aws.amazon.com/systems-manager/automation/home?region=us-east-1#/).

1. Escolha **Criar runbook de automação**.

## Etapa 2: criar um fluxo de trabalho
<a name="create-workflow"></a>

Na experiência de design visual, um fluxo de trabalho é uma representação gráfica do seu runbook na tela. É possível usar a experiência de design visual para definir, configurar e examinar as ações individuais do seu runbook.

**Para criar um fluxo de trabalho**

1. Ao lado do botão **Design** e **Código**, selecione o ícone de lápis e insira um nome para o seu runbook. Para este tutorial, insira **VisualDesignExperienceTutorial**.  
![\[Experiência de design visual: dê um nome ao seu runbook\]](http://docs.aws.amazon.com/pt_br/systems-manager/latest/userguide/images/visual_designer_tutorial_name.png)

1. Na seção **Atributos do documento** do painel **Formulário**, expanda a lista suspensa **Parâmetros de entrada** e selecione **Adicionar um parâmetro**.

   1. No campo **Nome do parâmetro**, insira **InstanceId**.

   1. No menu suspenso **Tipo**, escolha **AWS::EC2::Instance**.

   1. Selecione o botão **Obrigatório**.  
![\[Crie um parâmetro para seu runbook\]](http://docs.aws.amazon.com/pt_br/systems-manager/latest/userguide/images/visual_designer_actions_tutorial_parameter.png)

1. No navegador **APIs da AWS**, insira **DescribeInstances** na barra de pesquisa.

1. Arraste uma ação **Amazon EC2 – DescribeInstances** para a tela vazia.

1. Em **Nome da etapa**, insira um valor. Para este tutorial, use o nome **GetInstanceState**.  
![\[Escolha uma ação de API de descrição de instâncias do Amazon EC2.\]](http://docs.aws.amazon.com/pt_br/systems-manager/latest/userguide/images/visual_designer_tutorial_api_action.png)

   1. Expanda a lista suspensa **Entradas adicionais** e, no campo **Nome da entrada**, insira **InstanceIds**.

   1. Escolha a guia **Entradas**.

   1. No campo **Valor de entrada**, escolha a entrada do documento **InstanceId**. Isso faz referência ao valor do parâmetro de entrada criado por você no início do procedimento. Como a entrada **InstanceIDs** da ação `DescribeInstances` aceita valores `StringList`, é necessário colocar a entrada **InstanceID** entre colchetes. O YAML para o **Valor de entrada** deve corresponder ao seguinte: **['\$1\$1 InstanceId \$1\$1']**.

   1. Na guia **Saídas**, selecione **Adicionar uma saída** e insira **InstanceState** no campo **Nome**.

   1. No campo **Seletor**, insira **\$1.Reservations[0].Instances[0].State.Name**.

   1. **No menu suspenso **Tipo**, escolha String**.

1. Arraste uma ação de **Ramificação** do navegador **Ações** e solte-a abaixo da etapa **`GetInstanceState`**. 

1. Em **Nome da etapa**, insira um valor. Neste tutorial, use o nome `BranchOnInstanceState`.

   Para definir a lógica de ramificação, faça o seguinte:

   1. Escolha o estado **`Branch`** na tela. Em seguida, em **Entradas** e **Escolhas**, selecione o ícone de lápis para editar a **Regra \$11**.

   1. Escolha **Adicionar condições**.

   1. Na caixa de diálogo **Condições para a regra \$11**, escolha a saída da etapa **GetInstanceState.InstanceState** no menu suspenso **Variável**.

   1. Em **Operador**, escolha **é igual a**.

   1. Em **Valor**, escolha **String** na lista suspensa. Insira **stopped**.  
![\[Defina uma condição para uma ação de ramificação.\]](http://docs.aws.amazon.com/pt_br/systems-manager/latest/userguide/images/visual_designer_tutorial_condition.png)

   1. Selecione **Salvar condições**.

   1. Escolha **Adicionar nova regra de escolha**.

   1. Escolha **Adicionar condições** para a **Regra \$12**.

   1. Na caixa de diálogo **Condições para a regra \$12**, escolha a saída da etapa **GetInstanceState.InstanceState** no menu suspenso **Variável**.

   1. Em **Operador**, escolha **é igual a**.

   1. Em **Valor**, escolha **String** na lista suspensa. Insira **stopping**.

   1. Selecione **Salvar condições**.

   1. Escolha **Adicionar nova regra de escolha**.

   1. Para a **Regra \$13**, escolha **Adicionar condições**.

   1. Na caixa de diálogo **Condições para a regra \$13**, escolha a saída da etapa **GetInstanceState.InstanceState** no menu suspenso **Variável**.

   1. Em **Operador**, escolha **é igual a**.

   1. Em **Valor**, escolha **String** na lista suspensa. Insira **running**.

   1. Selecione **Salvar condições**.

   1. Na **Regra padrão**, escolha **Ir para o final** em **Etapa padrão**.

1. Arraste a ação **Alterar um estado de instância** para a caixa vazia **Arraste a ação aqui** sob a condição **\$1\$1GetInstanceState.InstanceState\$1\$1 == "stopped"**.

   1. Em **Nome da etapa**, insira **StartInstance**.

   1. Na guia **Entradas**, em **IDs de instância**, escolha o valor de entrada do documento **InstanceId** no menu suspenso.

   1. Para **Estado desejado**, especifique **`running`**.

1. Arraste a ação **Aguardar recurso da AWS** para a caixa vazia **Arraste a ação aqui** sob a condição **\$1\$1 GetInstanceState.InstanceState \$1\$1 == "stopping"**.

1. Em **Nome da etapa**, insira um valor. Neste tutorial, use o nome `WaitForInstanceStop`.

   1. No campo **Serviço**, escolha **Amazon EC2**.

   1. No campo **API**, escolha **DescribeInstances**.

   1. No campo **Seletor de propriedades**, insira **\$1.Reservations[0].Instances[0].State.Name**.

   1. Para o parâmetro **Valores desejados**, insira **`["stopped"]`**.

   1. Na guia **Configuração** da ação **WaitForInstanceStop**, escolha **StartInstance** no menu suspenso **Próxima etapa**.

1. Arraste a ação **Executar comando em instâncias** para a caixa vazia **Arraste a ação aqui** sob a condição **\$1\$1GetInstanceState.InstanceState\$1\$1 == "running"**.

1. Em **Nome da etapa**, insira **SayHello**.

   1. Na guia **Entradas**, insira **AWS-RunShellScript** para o parâmetro **Nome do documento**.

   1. Para **InstanceIds**, escolha o valor de entrada do documento **InstanceId** no menu suspenso.

   1. Expanda o menu suspenso **Entradas adicionais** e, no menu suspenso **Nome da entrada**, escolha **Parâmetros**.

   1. No campo **Valore de entrada**, insira **`{"commands": "echo 'Hello World'"}`**.

1. Revise o runbook concluído na tela e selecione **Criar runbook** para salvar o runbook do tutorial.  
![\[Analisar e criar o runbook.\]](http://docs.aws.amazon.com/pt_br/systems-manager/latest/userguide/images/visual_designer_tutorial_complete.png)

## Etapa 3: analisar o código gerado automaticamente
<a name="view-generated-code"></a>

Conforme você arrasta e solta ações do navegador **Ações** na tela, a experiência de design visual compõe automaticamente o conteúdo YAML ou JSON do seu runbook em tempo real. Você pode visualizar e editar esse código. Para visualizar o código gerado automaticamente, selecione **Código** na opção **Design** e **Código**.

## Etapa 4: executar seu novo runbook
<a name="use-tutorial-runbook"></a>

Após criar seu runbook, você poderá executar a automação.

**Para executar seu novo runbook de automação**

1. Abra o console AWS Systems Manager em [https://console.aws.amazon.com/systems-manager/](https://console.aws.amazon.com/systems-manager/).

1. No painel de navegação, selecione **Automation** e **Execute automation (Executar automação)**.

1. Na lista **Automation document** (Documento do Automation), escolha um runbook. Escolha uma ou mais opções no painel **Document categories** (Categorias de documentos) para filtrar documentos SSM de acordo com sua finalidade. Para visualizar um runbook que você tenha, escolha a guia **Owned by me** (De minha propriedade). Para visualizar um runbook compartilhado com sua conta, escolha a guia **Shared with me** (Compartilhado comigo). Para visualizar todos os runbooks, escolha a guia **All documents** (Todos os documentos).
**nota**  
Você pode visualizar informações sobre um runbook, selecionando o nome dele.

1. Na seção **Document details** (Detalhes do documento), verifique se **Document version** (Versão do documento) está definida como a versão que você quer executar. O sistema inclui as seguintes opções de versão: 
   + **Versão padrão no runtime**: escolha essa opção se o runbook do Automation for atualizado periodicamente e uma nova versão padrão for atribuída.
   + **Versão mais recente no runtime**: escolha essa opção se o runbook do Automation for atualizado periodicamente e se você quiser executar a versão mais recente.
   + **1 (padrão):** escolha esta opção para executar a primeira versão do documento, que é a versão padrão.

1. Escolha **Próximo**.

1. Na página **Executar runbook de automação**, escolha **Execução simples**.

1. Na seção **Input parameters (Parâmetros de entrada)**, especifique as entradas necessárias. Opcionalmente, você pode escolher uma função de serviço do IAM na lista **AutomationAssumeRole**.

1. (Opcional) Escolha um alarme do Amazon CloudWatch a fim de aplicar à sua automação para monitoramento. Para anexar um alarme do CloudWatch à sua automação, a entidade principal do IAM que inicia a automação deve ter permissão para a ação `iam:createServiceLinkedRole`. Para obter mais informações sobre alarmes do CloudWatch, consulte [Usar alarmes do Amazon CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html). A automação será interrompida se o alarme for ativado. Se você usar o AWS CloudTrail, você verá a chamada de API em sua trilha. 

1. Clique em **Executar**. 

## Etapa 5: limpar
<a name="cleanup-tutorial-runbook"></a>

**Para excluir seu runbook**

1. Abra o console AWS Systems Manager em [https://console.aws.amazon.com/systems-manager/](https://console.aws.amazon.com/systems-manager/).

1. No painel de navegação, escolha **Documents**.

1. Selecione a guia **Pertencente a mim**.

1. Localize o runbook **VisualDesignExperienceTutorial**.

1. Selecione o botão na página do cartão do documento e escolha **Excluir documento** no menu suspenso **Ações**.