Criar uma regra de notificação - Console do Developer Tools

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

É possível usar o console do Developer Tools ou o AWS CLI para criar regras de notificação. É possível criar um tópico do Amazon SNS para usar como destino para uma regra de notificação como parte da criação da regra. Se desejar usar um cliente do AWS Chatbot como destino, será necessário criar esse cliente antes de criar a regra. Para obter mais informações, consulte Configurar um cliente do AWS Chatbot para um canal do Slack.

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

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

  2. Use a barra de navegação para navegar até o recurso.

    • Para o CodeBuild, escolha Build (Compilar), Build projects (Projetos de compilação) e escolha um projeto de compilação.

    • Para o CodeCommit, escolha Source (Origem), Repositories (Repositórios) e escolha um repositório.

    • Para o CodeDeploy, escolha Applications (Aplicações) e escolha uma aplicação.

    • Para o CodePipeline, escolha Pipeline, Pipelines e escolha um pipeline.

  3. Na página do recurso, escolha Notify (Notificar) e Create notification rule (Criar regra de notificação). Você também pode acessar a página Settings (Configurações) do recurso, acessar Notifications (Notificações) ou Notification rules (Regras de notificação) 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 Full (Completo) se desejar incluir as informações fornecidas ao Amazon EventBridge e as informações que possam ser fornecidas pelo serviço de recursos ou pelo gerenciador de notificações.

    Para obter mais informações, consulte Noções básicas do conteúdo e da segurança das 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 saber os tipos de evento para um recurso, consulte o seguinte:

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

    • Se você já tiver configurado um recurso para usar com notificações, em Escolher tipo de destino, selecione AWS Chatbot (Slack), AWS Chatbot (Microsoft Teams) ou Tópico do SNS. Em Escolher destino, selecione o nome do cliente (para um cliente Slack ou do Microsoft Teams configurado no AWS Chatbot) 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.

    • Não é possível criar um cliente do AWS Chatbot como parte da criação de uma regra de notificação. Se você escolher AWS Chatbot (Slack) ou AWS Chatbot (Microsoft Teams), será exibido um botão que permitirá configurar um cliente no AWS Chatbot. Ao selecionar essa opção, você abrirá o console do AWS Chatbot. Para obter mais informações, consulte Configurar um cliente do AWS Chatbot para um canal do Slack.

    • 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 para notificações e Noções básicas do conteúdo e da segurança das notificações.

  8. Escolha Submit (Enviar) e revise a regra de notificação.

    nota

    Os usuários devem se inscrever e confirmar assinaturas do tópico do Amazon SNS que você especificou como destino da regra antes de receberem notificações. Para obter mais informações, consulte Para inscrever usuários em um tópico do Amazon SNS usado para notificações.

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 repositório chamado MyDemoRepo em uma conta da AWS com o ID 123456789012. As notificações com o tipo de detalhe completo são enviadas para um tópico do Amazon SNS chamado MyNotificationTopic quando ramificações e tags são criadas.

    {
    "Name": "MyNotificationRule",
    "EventTypeIds": [
        "codecommit-repository-branches-and-tags-created"
    ],
    "Resource": "arn:aws:codecommit:us-east-1:123456789012:MyDemoRepo",
    "Targets": [
        {
            "TargetType": "SNS",
            "TargetAddress": "arn:aws:sns:us-east-1:123456789012: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 houver êxito, 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"
}

Como listar tipos de evento para regras de notificação (AWS CLI)

  1. Em um terminal ou prompt de comando, execute o comando list-event-types. É possível usar a opção --filters para limitar a resposta a um tipo de recurso específico ou a outro atributo. Por exemplo, o comando a seguir retorna uma lista de tipos de evento para aplicações do CodeDeploy.

    aws codestar-notifications list-event-types --filters Name=SERVICE_NAME,Value=CodeDeploy

  2. O comando gerará uma saída semelhante à seguinte:

    {
    "EventTypes": [
        {
            "EventTypeId": "codedeploy-application-deployment-succeeded",
            "ServiceName": "CodeDeploy",
            "EventTypeName": "Deployment: Succeeded",
            "ResourceType": "Application"
        },
        {
            "EventTypeId": "codedeploy-application-deployment-failed",
            "ServiceName": "CodeDeploy",
            "EventTypeName": "Deployment: Failed",
            "ResourceType": "Application"
        },
        {
            "EventTypeId": "codedeploy-application-deployment-started",
            "ServiceName": "CodeDeploy",
            "EventTypeName": "Deployment: Started",
            "ResourceType": "Application"
        }
    ]
}

Como adicionar uma tag a uma regra de notificação (AWS CLI)

  1. Em um terminal ou prompt de comando, execute o comando tag-resource. Por exemplo, use o comando a seguir para adicionar um par de chave/valor de tag que tenha o nome Team e o valor Li_Juan.

    aws codestar-notifications tag-resource --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE --tags Team=Li_Juan

  2. O comando gerará uma saída semelhante à seguinte:

    {
    "Tags": {
        "Team": "Li_Juan"
    }
}