Como criar o aplicativo AWS Support em recursos do Slack com o AWS CloudFormation - AWS Support

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Como criar o aplicativo AWS Support em recursos do Slack com o AWS CloudFormation

O aplicativo AWS Support no Slack está integrado ao AWS CloudFormation, um serviço que ajuda você a modelar e configurar seus recursos da AWS para que possa gastar menos tempo criando e gerenciando seus recursos e infraestrutura. Você cria um modelo que descreve todos os recursos da AWS desejados (como seu AccountAlias e SlackChannelConfiguration), e o AWS CloudFormation provisiona e configura esses recursos para você.

Ao usar o AWS CloudFormation, você poderá reutilizar seu modelo para configurar seus recursos do aplicativo AWS Support de forma repetida e consistente. Descreva seus recursos uma vez e depois provisione os mesmos recursos repetidamente em várias regiões e Contas da AWS.

Aplicativo AWS Support e modelos do AWS CloudFormation

Para provisionar e configurar recursos para o AWS Support App e serviços relacionados, é necessário entender os modelos do AWS CloudFormation. Os modelos são arquivos de texto formatados em JSON ou YAML. Esses modelos descrevem os recursos que você deseja provisionar nas suas pilhas do AWS CloudFormation. Se você não estiver familiarizado com JSON ou YAML, poderá usar o AWS CloudFormation Designer para ajudá-lo a começar a usar os modelos do AWS CloudFormation. Para obter mais informações, consulte O que é o Designer? (O que é o AWS CloudFormation Designer) no Manual do usuário do AWS CloudFormation.

O aplicativo AWS Support ajuda na criação de seu AccountAlias e SlackChannelConfiguration no AWS CloudFormation. Para obter mais informações, incluindo exemplos de modelos JSON e YAML para os recursos AccountAlias e SlackChannelConfiguration, consulte AWS Support App resource type reference no Guia do usuário do AWS CloudFormation.

Criar recursos de configuração do Slack para a organização

Você pode usar modelos do CloudFormation para criar os recursos necessários para o AWS Support App. Se você for a conta de gerenciamento de sua organização, você poderá usar os modelos para criar esses recursos para suas contas-membro no AWS Organizations.

Por exemplo, é possível usar um modelo para criar a mesma configuração de espaço de trabalho do Slack para todas as contas na organização, mas depois usar modelos separados para criar diferentes configurações de canais do Slack para Contas da AWS específicas ou unidades organizacionais (UOs). Você também pode usar um modelo para criar uma configuração de espaço de trabalho do Slack para que as contas-membro possam configurar os canais do Slack que desejam para suas Contas da AWS.

É possível escolher se deseja usar os modelos do CloudFormation ou não. Caso não use modelos do CloudFormation, você poderá concluir as seguintes etapas manuais em vez disso:

  • Crie os recursos do AWS Support App no AWS Support Center Console.

  • Crie um caso de suporte no AWS Support para autorizar várias contas a usar o AWS Support App.

  • Chame a operação da API RegisterSlackWorkspaceForOrganization para registrar um espaço de trabalho do Slack para sua conta. A pilha do CloudFormation chama essa operação de API para você.

Siga estes procedimentos para carregar o modelo do CloudFormation para sua organização. Você pode usar os modelos de exemplo da página de referência dos tipos de recursos do AWS Support App.

Os modelos dizem ao CloudFormation para criar os seguintes recursos:

Atualizar seus modelos do CloudFormation para o Slack

Para começar, use os modelos a seguir para criar sua pilha. É necessário substituir os modelos por valores válidos para seu espaço de trabalho e canal do Slack.

nota

Não recomendamos usar o modelo para criar um recurso AccountAlias para sua organização. O recurso AccountAlias identifica de forma exclusiva uma Conta da AWS no AWS Support App. Suas contas-membro podem inserir um nome de conta no console da central de suporte. Para obter mais informações, consulte Autorizar um espaço de trabalho do Slack.

Atualize seus modelos do CloudFormation para o Slack
  1. Se você for a conta de gerenciamento de uma organização, você deverá autorizar manualmente um espaço de trabalho do Slack para sua conta antes que suas contas-membro possam usar o CloudFormation para criar os recursos. Caso ainda não tenha feito isso, consulte Autorizar um espaço de trabalho do Slack.

  2. Na página de referência de tipos de recursos do AWS Support App, copie o modelo JSON ou YAML para o recurso que você deseja.

  3. Em um editor de texto, cole o modelo em um novo arquivo.

  4. No modelo, especifique os parâmetros desejados. No mínimo, substitua os valores destes campos:

    • TeamId por seu ID de espaço de trabalho do Slack

    • ChannelId pelo ID do canal Slack

    • ChannelName por um nome para identificar a configuração do canal do Slack

    dica

    Para encontrar o espaço de trabalho e os IDs do canal, abra seu canal do Slack em um navegador. No URL, seu ID do espaço de trabalho é o primeiro identificador e o ID do canal é o segundo. Por exemplo, em https://app.slack.com/client/T012ABCDEFG/C01234A5BCD, T012ABCDEFG é o ID do espaço de trabalho e C01234A5BCD é o ID do canal.

  5. Salve o arquivo como JSON ou YAML.

Criar uma pilha para a conta de gerenciamento

Em seguida, é necessário criar uma pilha para a conta de gerenciamento na organização. Essa etapa chama a operação de API RegisterSlackWorkspaceForOrganization para você e autoriza o espaço de trabalho com o Slack.

nota

Recomendamos carregar o modelo de configuração do espaço de trabalho do Slack que você atualizou no procedimento anterior para a conta de gerenciamento. Não é necessário carregar o modelo de configuração do canal do Slack, a menos que também esteja configurando a conta de gerenciamento para usar o AWS Support App.

Crie uma pilha para a conta de gerenciamento
  1. Faça login no AWS Management Console ao usar a conta de gerenciamento de sua organização.

  2. Abra o console do AWS CloudFormation em https://console.aws.amazon.com/cloudformation.

  3. Se você ainda não tiver feito isso, em Region selector (Seletor de regiões), escolha uma das seguintes Regiões da AWS:

    • Europa (Frankfurt)

    • Europa (Irlanda)

    • Europa (Londres)

    • Leste dos EUA (N. da Virgínia)

    • Leste dos EUA (Ohio)

    • Oeste dos EUA (Oregon)

    • Ásia-Pacífico (Singapura)

    • Ásia-Pacífico (Tóquio)

    • Canadá (Central)

  4. Siga o procedimento abaixo para criar uma pilha. Para obter mais informações, consulte Criar uma pilha no console do AWS CloudFormation.

    Depois de criar a pilha do CloudFormation com sucesso, você pode usar o mesmo modelo para criar um conjunto de pilhas para sua organização.

Criar um conjunto de pilhas para a organização

Em seguida, use o mesmo modelo para a configuração do espaço de trabalho do Slack para criar um conjunto de pilhas com permissões service-managed. É possível usar conjuntos de pilhas para criar a pilha para toda a organização ou especificar as UOs desejadas. Para obter mais informações, consulte Criar um conjunto de pilhas.

Esse procedimento também chama a operação de API RegisterSlackWorkspaceForOrganization para você. Essa operação de API autoriza o espaço de trabalho com o Slack para as contas-membro.

Para criar um conjunto de pilhas para a organização
  1. Faça login no AWS Management Console ao usar a conta de gerenciamento de sua organização.

  2. Abra o console do AWS CloudFormation em https://console.aws.amazon.com/cloudformation.

  3. Caso ainda não tenha feito isso, em Region selector (Seletor de regiões), escolha a mesma Região da AWS usada no procedimento anterior.

  4. No painel de navegação, escolha StackSets.

  5. Escolha Create StackSet (Criar StackSet).

  6. Na página Choose a template (Escolha um modelo), mantenha as opções padrão para as seguintes opções:

    • Em Permissions (Permissões), mantenha Service-managed permissions (Permissões gerenciadas pelo serviço).

    • Em Prerequisite - Prepare template (Pré-requisito: preparar modelo), mantenha Template is ready (O modelo está pronto).

  7. Em Specify template (Especificar modelo), selecione Upload a template file (Carregar um arquivo de modelo) e depois Choose file (Escolher arquivo).

  8. Escolha seu arquivo e escolha Next (Próximo).

  9. Na página Specify StackSet (Especificar StackSet), digite o nome da pilha, como support-app-slack-workspace, insira uma descrição e escolha Next (Próximo).

  10. Na página Configure StackSet options (Configurar opções do StackSet), mantenha os padrões e selecione Next (Próximo).

  11. Na página Set deployment options (Definir opções de implantação), em Add stacks to stack set (Adicionar pilhas ao conjunto de pilhas), mantenha a opção padrão Deploy new stacks (Implantar novas pilhas).

  12. Para Deployment targets (Metas de implantação), escolha se deseja criar a pilha para toda a organização ou UOs específicas. Se escolher uma UO, insira o ID da UO.

  13. Em Specify regions (Especificar regiões), insira somente uma das seguintes Regiões da AWS:

    • Europa (Frankfurt)

    • Europa (Irlanda)

    • Europa (Londres)

    • Leste dos EUA (N. da Virgínia)

    • Leste dos EUA (Ohio)

    • Oeste dos EUA (Oregon)

    • Ásia-Pacífico (Singapura)

    • Ásia-Pacífico (Tóquio)

    • Canadá (Central)

    Observações:
    • Para otimizar seu fluxo de trabalho, recomendamos usar a mesma Região da AWS escolhida na Etapa 3.

    • Escolher mais de uma Região da AWS pode causar conflitos na criação de sua pilha.

  14. Em Deployment options (Opções de implantação), em Failure tolerance - optional (Tolerância a falhas - opcional), insira o número de contas em que as pilhas podem falhar antes que o CloudFormation interrompa a operação. Recomendamos inserir o número de contas que deseja adicionar, menos uma. Por exemplo, se sua UO especificada tiver dez contas-membro, insira 9. Isso significa que, mesmo que a operação do CloudFormation falhe nove vezes, pelo menos uma conta será bem-sucedida.

  15. Escolha Next (Próximo).

  16. Na página Review (Revisar), reveja suas opções e escolha Submit (Enviar). É possível verificar o status de sua pilha na guia Stack instances (Instâncias da pilha).

  17. (Opcional) Repita esse procedimento para carregar um modelo para a configuração de um canal do Slack. O modelo de exemplo também cria o perfil do IAM e anexa uma política gerenciada pela AWS. Essa função tem as permissões necessárias para acessar outros serviços por você. Para obter mais informações, consulte Como gerenciar o acesso ao aplicativo AWS Support.

    Se você não criar um conjunto de pilhas para criar a configuração do canal do Slack, suas contas-membro poderão configurar manualmente o canal do Slack. Para obter mais informações, consulte Como configurar um canal do Slack.

Depois que o CloudFormation cria as pilhas, cada conta-membro pode acessar o console da Central de suporte e encontrar seus espaços de trabalho e canais do Slack configurados. Elas podem então usar o AWS Support App para sua Conta da AWS. Consulte Como criar casos de suporte em um canal do Slack.

dica

Caso precise carregar um novo modelo, recomendamos usar a mesma Região da AWS especificada anteriormente.

Saiba mais sobre o CloudFormation

Para saber mais sobre o CloudFormation, consulte os seguintes recursos:

Criar recursos do AWS Support App ao usar o Terraform

Também é possível usar o Terraform para criar os recursos do AWS Support App para sua Conta da AWS. O Terraform é uma ferramenta de infraestrutura como código que pode ser usada para suas aplicações em nuvem. Você pode usar o Terraform para criar recursos do AWS Support App em vez de implantar uma pilha do CloudFormation em uma conta.

Depois de instalar o Terraform, é possível especificar os recursos do AWS Support App que deseja. O Terraform chama a operação de API RegisterSlackWorkspaceForOrganization para registrar um espaço de trabalho do Slack para você e cria seus recursos. Em seguida, você pode fazer login no console da Central de suporte e encontrar seus espaços de trabalho e canais do Slack configurados.

Observações
  • Se você for a conta de gerenciamento de uma organização, é necessário autorizar manualmente um espaço de trabalho do Slack para sua conta antes que suas contas-membro possam usar o Terraform para criar os recursos. Caso ainda não tenha feito isso, consulte Autorizar um espaço de trabalho do Slack.

  • Ao contrário dos conjuntos de pilhas do CloudFormation, não é possível usar o Terraform para criar os recursos do AWS Support App para uma UO de sua organização.

  • Você também encontra o histórico de eventos dessas atualizações no Terraform no AWS CloudTrail. O eventSource desses eventos será cloudcontrolapi.amazonaws.com e supportapp.amazonaws.com. Para obter mais informações, consulte Como fazer registro em log no aplicativo AWS Support nas chamadas de API do Slack com o AWS CloudTrail.

Saiba mais

Para saber mais sobre o Terraform, consulte os tópicos a seguir: