Criar uma regra de notificação - AWS CodePipeline

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á.

Criar uma regra de notificação

Você pode usar regras de notificação para notificar os usuários sobre alterações importantes, como quando um pipeline inicia a execução. As regras de notificação especificam os eventos e o tópico do Amazon SNS utilizado para enviar notificações. Para obter mais informações, consulte O que são notificações?

Você pode usar o console ou a AWS CLI para criar regras de notificação para o AWS CodePipeline.

Como criar uma regra de notificação (console)

  1. Faça login no Console de gerenciamento da AWS e abra o console do CodePipeline em https://console.aws.amazon.com/codepipeline/.

  2. Escolha Pipelines e selecione um pipeline onde você deseja adicionar notificações.

  3. Na página do pipeline, escolha Notify (Notificar) e Create notification rule (Criar regra de notificação). Você também pode ir para a página Settings (Configurações) do pipeline e escolher Create notification rule (Criar regra de notificação).

  4. Em Notification name (Nome da notificação), insira um nome para a regra.

  5. Em Detail type (Tipo de detalhe), escolha Basic (Básico) se desejar que apenas as informações fornecidas ao Amazon EventBridge sejam incluídas na notificação. Escolha Completo se você deseja incluir as informações fornecidas ao Amazon EventBridge e as informações que podem ser fornecidas pelo CodePipeline ou pelo gerenciador de notificações.

    Para obter mais informações, consulte Noções básicas sobre o conteúdo e a segurança de notificações.

  6. Em Events that trigger notifications (Eventos que acionam notificações), selecione os eventos para os quais você deseja enviar notificações. Para obter mais informações, consulte Eventos para regras de notificação em pipelines.

  7. Em Targets (Destinos), siga um destes procedimentos:

    • Se você já tiver configurado um recurso a ser usado com notificações, em Escolher tipo de destino, escolha Amazon Q Developer em aplicações de chat (Slack) ou Tópico do SNS. Em Escolher destino, escolha o nome do cliente (para um cliente do Slack configurado no Amazon Q Developer em aplicações de chat) ou o nome do recurso da Amazon (ARN) do tópico do Amazon SNS (para tópicos do Amazon SNS já configurados com a política necessária para notificações).

    • Se você não configurou um recurso para usar com notificações, escolha Create target (Criar destino) e selecione SNS topic (Tópico do SNS). Forneça um nome para o tópico após codestar-notifications- e escolha Create (Criar).

    nota

    • Ao criar o tópico do Amazon SNS como parte da criação da regra de notificação, a política que permite ao recurso publicar eventos no tópico é aplicada para você. O uso de um tópico criado para regras de notificação ajuda a garantir que você inscreva somente os usuários para os quais deseja enviar notificações sobre esse recurso.

    • Você não pode criar um Amazon Q Developer no cliente de aplicações de chat como parte da criação de uma regra de notificação. Se escolher o Amazon Q Developer em aplicações de chat (Slack), você verá um botão direcionando para configurar um cliente no Amazon Q Developer em aplicações de chat. A escolha dessa opção abre o Amazon Q Developer no console de aplicações de chat. Para obter mais informações, consulte Configurar integrações entre notificações e o Amazon Q Developer em aplicações de chat.

    • Se quiser usar um tópico do Amazon SNS existente como destino, você deverá adicionar a política necessária para o AWS CodeStar Notifications, além de quaisquer outras políticas que possam existir para esse tópico. Para obter mais informações, consulte Configurar tópicos do Amazon SNS existentes para notificações e Noções básicas sobre conteúdos de notificações e segurança.

  8. Para concluir a criação da regra, escolha Submit (Enviar).

  9. Você precisa inscrever os usuários no tópico do Amazon SNS para a regra antes que eles possam receber notificações. Para obter mais informações, consulte Inscrever usuários em tópicos do Amazon SNS que são destinos. Você também pode configurar a integração entre as notificações e o Amazon Q Developer em aplicações de chat a fim de enviar notificações para salas de chat do Amazon Chime ou canais do Slack. Para obter mais informações, consulte Configurar integrações entre notificações e o Amazon Q Developer em aplicações de chat.

Criar uma regra de notificação (AWS CLI)

  1. Em um terminal ou prompt de comando, execute o comando create-notification rule para gerar o esqueleto JSON:

    aws codestar-notifications create-notification-rule --generate-cli-skeleton > rule.json

    É possível nomear o arquivo como você quiser. Neste exemplo, o arquivo é chamado rule.json.

  2. Abra o arquivo JSON em um editor de texto simples e edite-o para incluir o recurso, os tipos de evento e o destino que você deseja para a regra. O exemplo a seguir mostra uma regra de notificação chamada MyNotificationRule para um pipeline chamado MyDemoPipeline em uma conta da AWS com o ID 123456789012. As notificações são enviadas com o tipo de detalhe completo para um tópico do Amazon SNS chamado codestar-notifications-MyNotificationTopic quando as execuções do pipeline são iniciadas:

    {
    "Name": "MyNotificationRule",
    "EventTypeIds": [
        "codepipeline-pipeline-pipeline-execution-started"
    ],
    "Resource": "arn:aws:codebuild:us-east-2:123456789012:MyDemoPipeline",
    "Targets": [
        {
            "TargetType": "SNS",
            "TargetAddress": "arn:aws:sns:us-east-2:123456789012:codestar-notifications-MyNotificationTopic"
        }
    ],
    "Status": "ENABLED",
    "DetailType": "FULL"
}

    Salve o arquivo.

  3. Usando o arquivo que você acabou de editar, no terminal ou na linha de comando, execute o comando create-notification-rule novamente para criar a regra de notificação:

    aws codestar-notifications create-notification-rule --cli-input-json  file://rule.json

  4. Se for bem-sucedido, o comando retornará o ARN da regra de notificação, semelhante ao seguinte:

    {
    "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
}