Criar uma regra de notificação - AWS CodeDeploy

Criar uma regra de notificação

É possível usar regras de notificação para notificar os usuários quando houver alterações nos aplicativos de implantação, como êxitos e falhas de implantação. As regras de notificação especificam os eventos e o tópico do Amazon SNS que é usado 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 CodeDeploy.

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

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

  2. Escolha Application (Aplicativo) e selecione um aplicativo em que você deseja adicionar notificações.

  3. Na página do aplicativo, escolha Notify (Notificar) e Create notification rule (Criar regra de notificação). Também é possível acessar a página Settings (Configurações) do aplicativo 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 Completa se desejar incluir as informações fornecidas ao Amazon EventBridge e as informações que possam ser fornecidas pelo CodeDeploy 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.

    Categoria Eventos

    Implantação

    Falha

    Bem-sucedida

    Started

  7. Em Targets (Destinos), escolha Create SNS topic (Criar tópico do SNS).

    nota

    Quando você cria o tópico, a política que autoriza o CodeDeploy a publicar eventos no tópico é aplicada para você. Usar um tópico criado especificamente para notificações do CodeDeploy também ajuda a garantir que você adicione somente os usuários à lista de assinaturas desse tópico que você quer que vejam as notificações sobre esse aplicativo de implantação.

    Após o prefixo codestar-notifications-, insira um nome para o tópico e escolha Submit (Enviar).

    nota

    Se desejar usar um tópico do Amazon SNS existente em vez de criar um novo, em Targets (Destinos), escolha o ARN. Certifique-se de que o tópico tenha a política de acesso apropriada e que a lista de assinantes contenha somente os usuários que têm permissão para ver informações sobre o aplicativo de implantação. 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. Também é possível configurar a integração entre as notificações e o Amazon Q Developer em aplicações de chat para enviar notificações para salas de chat do Amazon Chime ou canais do Slack. Para acessar mais informações, consulte Configure integration between notifications and Amazon Q Developer in chat applications.

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 do Amazon SNS que você deseja para a regra. O exemplo a seguir mostra uma regra de notificação chamada MyNotificationRule para um aplicativo chamado MyDeploymentApplication em uma conta do AWS com o ID 123456789012. As notificações serão enviadas com o tipo de detalhe completo para um tópico do Amazon SNS chamado codestar-notifications-MyNotificationTopic quando as implantações tiverem êxito:

    {
    "Name": "MyNotificationRule",
    "EventTypeIds": [
        "codedeploy-application-deployment-succeeded"
    ],
    "Resource": "arn:aws:codebuild:us-east-2:123456789012:MyDeploymentApplication",
    "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"
}