Configurar a integração entre notificações e o AWS Chatbot

O AWS Chatbot é um serviço da AWS que permite que equipes de desenvolvimento de software e DevOps usem salas de bate-papo do Amazon Chime, canais do Slack e canais do Microsoft Teams para monitorar e responder a eventos operacionais na Nuvem AWS. É possível configurar a integração entre destinos de regras de notificação e o AWS Chatbot para que as notificações sobre eventos apareçam na sala do Amazon Chime, no canal do Slack ou no canal do Microsoft Teams que você escolher. Para ter mais informações, consulte a Documentação do AWS Chatbot.

Antes de configurar a integração com o AWS Chatbot, é necessário configurar uma regra de notificação e um destino de regra. Para obter mais informações, consulte Configuração e Criar uma regra de notificação. Também é necessário configurar um canal do Slack, um canal do Microsoft Teams ou uma sala de bate-papo do Amazon Chime no AWS Chatbot. Para obter mais informações, consulte a documentação desses serviços.

Configurar um cliente do AWS Chatbot para um canal do Slack

É possível criar regras de notificação que usam um cliente do AWS Chatbot como destino. Se criar um cliente para um canal Slack, você poderá usar esse cliente diretamente como destino no fluxo de trabalho para criar uma regra de notificação. Esta é a maneira mais fácil de configurar as notificações que são exibidas nos canais Slack.

Como criar um cliente do AWS Chatbot com o Slack para usar como destino

1. Siga as instruções em Configurar o AWS Chatbot com o Slack no Guia do administrador do AWS Chatbot. Ao fazê-lo, considere as seguintes opções para uma integração ideal com notificações:

   • Ao criar uma função do IAM, considere escolher um nome de função que facilite a identificação da finalidade dessa função (por exemplo, AWSCodeStarNotifications-Chatbot-Slack-Role). Isso pode ajudar a identificar a finalidade da função no futuro.

   • Em SNS topics (Tópicos do SNS), não é necessário escolher um tópico ou uma região da AWS. Ao selecionar o cliente do AWS Chatbot como destino, um tópico do Amazon SNS com todas as permissões necessárias será criado e configurado para o cliente do AWS Chatbot como parte do processo de criação da regra de notificação.

2. Conclua o processo de criação do cliente. Esse cliente estará disponível para ser escolhido como destino durante a criação de regras de notificação. Para obter mais informações, consulte Criar uma regra de notificação.

   nota

   Não remova o tópico do Amazon SNS do cliente do AWS Chatbot depois de ele ter sido configurado para você. Isso impedirá que notificações sejam enviadas para o Slack.

Configurar um cliente do AWS Chatbot para um canal do Microsoft Teams

É possível criar regras de notificação que usam um cliente do AWS Chatbot como destino. Se criar um cliente para um canal do Microsoft Teams, você poderá usar esse cliente diretamente como destino no fluxo de trabalho para criar uma regra de notificação. Essa é a maneira mais fácil de configurar as notificações que são exibidas nos canais do Microsoft Teams.

Como criar um cliente do AWS Chatbot com o Microsoft Teams para usar como destino

1. Siga as instruções em Configurar o AWS Chatbot com o Microsoft Teams no Guia do administrador do AWS Chatbot. Ao fazê-lo, considere as seguintes opções para uma integração ideal com notificações:

   • Ao criar uma função do IAM, considere escolher um nome de função que facilite a identificação da finalidade dessa função (por exemplo, AWSCodeStarNotifications-Chatbot-Microsoft-Teams-Role). Isso pode ajudar a identificar a finalidade da função no futuro.

   • Em SNS topics (Tópicos do SNS), não é necessário escolher um tópico ou uma região da AWS. Ao selecionar o cliente do AWS Chatbot como destino, um tópico do Amazon SNS com todas as permissões necessárias será criado e configurado para o cliente do AWS Chatbot como parte do processo de criação da regra de notificação.

2. Conclua o processo de criação do cliente. Esse cliente estará disponível para ser escolhido como destino durante a criação de regras de notificação. Para obter mais informações, consulte Criar uma regra de notificação.

   nota

   Não remova o tópico do Amazon SNS do cliente do AWS Chatbot depois de ele ter sido configurado para você. Isso impedirá que notificações sejam enviadas para o Microsoft Teams.

Configurar clientes para o Slack ou o Amazon Chime manualmente

É possível optar por criar a integração entre as notificações e o Slack ou o Amazon Chime diretamente. Este é o único método disponível para configurar notificações para salas de chat do Amazon Chime. Ao configurar essa integração manualmente, você cria um cliente do AWS Chatbot que usa um tópico do Amazon SNS configurado anteriormente como o destino de uma regra de notificação.

Como integrar notificações manualmente com o AWS Chatbot e o Slack

1. Abra o console do AWS Developer Tools em https://console.aws.amazon.com/codesuite/settings/notifications.

2. Selecione Settings (Configurações) e Notification rules (Regras de notificação).

3. Em Notification rule targets (Destinos de regra de notificação), localize e copie o destino.

   nota

   Você pode configurar mais de uma regra de notificação para usar o mesmo tópico do Amazon SNS como seu destino. Isso pode ajudá-lo a consolidar o sistema de mensagens, mas também pode ter consequências não intencionais se a lista de assinaturas for específica para uma regra de notificação ou um recurso.

4. Abra o console do AWS Chatbot em https://console.aws.amazon.com/chatbot/.

5. Escolha Configure new client (Configurar novo cliente) e selecione Slack.

6. Selecione Configurar.

7. Faça login no seu espaço de workspace do Slack.

8. Quando for solicitado que você confirme as opções, selecione Allow (Permitir).

9. Escolha Configure new channel (Configurar novo canal).

10. Em Configuration details (Detalhes da configuração), em Configuration name (Nome da configuração), insira um nome para o cliente. Esse é o nome que será exibido na lista de destinos disponíveis para o tipo de destino AWS Chatbot (Slack) quando você criar regras de notificação.

11. Em Configure Slack Channel (Configurar canal do Slack), em Channel type (Tipo de canal), selecione Public (Público) ou Private (Privado), dependendo do tipo de canal ao qual você deseja fazer a integração.

    • Em Public channel (Canal público), escolha o nome do canal do Slack na lista.

    • Em Private channel ID (ID do canal privado), insira o código do canal ou URL.

12. Em IAM permissions (Permissões do IAM), em Role (Função), escolha Create an IAM role using a template (Criar uma função do IAM usando um modelo). Em Policy templates (Modelos de política), escolha Notification permissions (Permissões de notificação). Em Role name (Nome da função), insira um nome para essa função (por exemplo, AWSCodeStarNotifications-Chatbot-Slack-Role). Em Policy templates (Modelos de política), escolha Notification permissions (Permissões de notificação).

13. Em SNS topics (Tópicos do SNS), em SNS Region (Região do SNS), selecione a Região da AWS na qual criou o destino da regra de notificação. Em SNS topics (Tópicos do SNS), escolha o nome do tópico do Amazon SNS que você configurou como o destino da regra de notificação.

    nota

    Esta etapa não é necessária se você criar uma regra de notificação usando este cliente como destino.

14. Selecione Configurar.

    nota

    Se você configurou a integração com um canal privado, é necessário convidar o AWS Chatbot para o canal para poder ver as notificações nesse canal. Para ter mais informações, consulte a Documentação do AWS Chatbot.

15. (Opcional) Para testar a integração, faça uma alteração no recurso que corresponde a um tipo de evento de uma regra de notificação que foi configurada para usar o tópico do Amazon SNS como destino. Por exemplo, caso tenha uma regra de notificação configurada para enviar notificações quando comentários forem inseridos em uma solicitação pull, comente em uma solicitação pull e observe o canal do Slack para ver quando a notificação aparece.

Como integrar notificações com o AWS Chatbot e o Amazon Chime

1. Abra o console do AWS Developer Tools em https://console.aws.amazon.com/codesuite/settings/notifications.

2. Selecione Settings (Configurações) e Notification rules (Regras de notificação).

3. Em Notification rule targets (Destinos de regra de notificação), localize e copie o destino.

   nota

   Você pode configurar mais de uma regra de notificação para usar o mesmo tópico do Amazon SNS como seu destino. Isso pode ajudá-lo a consolidar o sistema de mensagens, mas também pode ter consequências não intencionais se a lista de assinaturas for específica para uma regra de notificação ou um recurso.

4. No Amazon Chime, abra a sala de chat que deseja configurar para a integração.

5. Escolha o ícone de engrenagem no canto superior direito e escolha Manage webhooks (Gerenciar webhooks).

6. Na caixa de diálogo Manage webhooks (Gerenciar webhooks), escolha New (Novo), insira um nome para o webhook e selecione Create (Criar).

7. Verifique se o webhook é exibido e escolha Copy webhook URL (Copiar URL do webhook).

8. Abra o console do AWS Chatbot em https://console.aws.amazon.com/chatbot/.

9. Escolha Configure new client (Configurar novo cliente) e escolha Amazon Chime.

10. Em Configuration details (Detalhes da configuração), em Configuration name (Nome da configuração), insira um nome para o cliente.

11. Em Webhook URL (URL do webhook), cole o URL. Em Webhook description (Descrição do webhook), forneça uma descrição opcional.

12. Em IAM permissions (Permissões do IAM), em Role (Função), escolha Create an IAM role using a template (Criar uma função do IAM usando um modelo). Em Policy templates (Modelos de política), escolha Notification permissions (Permissões de notificação). Em Role name (Nome da função), insira um nome para essa função (por exemplo, AWSCodeStarNotifications-Chatbot-Chime-Role).

13. Em SNS topics (Tópicos do SNS), em SNS Region (Região do SNS), selecione a Região da AWS na qual criou o destino da regra de notificação. Em SNS topics (Tópicos do SNS), escolha o nome do tópico do Amazon SNS que você configurou como o destino da regra de notificação.

14. Selecione Configurar.

15. (Opcional) Para testar a integração, faça uma alteração no recurso que corresponde a um tipo de evento de uma regra de notificação que foi configurada para usar o tópico do Amazon SNS como destino. Por exemplo, caso tenha uma regra de notificação configurada para enviar notificações quando comentários forem inseridos em uma solicitação pull, comente em uma solicitação pull e observe a sala de chat do Amazon Chime para ver quando a notificação aparece.