Criar uma regra de notificação - AWS CodeCommit

AWS CodeCommit não está mais disponível para novos clientes. Os clientes atuais do AWS CodeCommit podem continuar usando o serviço normalmente. Saiba mais

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 regras de notificação para notificar os usuários sobre alterações importantes, como quando uma solicitação pull é criada em um repositório. As regras de notificação especificam os eventos e o SNS tópico da Amazon que é usado para enviar notificações. Para obter mais informações, consulte O que são notificações?

nota

Esse atributo não está disponível na região Europa (Milão). Para saber como configurar notificações na experiência disponível nessa região, consulte Configurar notificações do repositório.

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

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

  1. Faça login no AWS Management Console e abra o CodeCommit console em https://console.aws.amazon.com/codecommit/.

  2. Selecione Repositories (Repositórios) e escolha um repositório no qual você deseja adicionar regras de notificação.

  3. Na página do repositório, selecione Notify (Notificar) e Create notification rule (Criar regra de notificação). Também é possível acessar a página Settings (Configurações) do repositório e selecionar Create notification rule (Criar regra de notificação).

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

  5. Em Tipo de detalhe, escolha Básico se quiser que somente as informações fornecidas à Amazon sejam EventBridge incluídas na notificação. Escolha Completo se quiser incluir informações fornecidas à Amazon EventBridge e informações que possam ser fornecidas pelo gerenciador de notificações CodeCommit 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 repositórios.

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

    • Se você já configurou um recurso para usar com notificações, em Escolher tipo de destino, escolha AWS Chatbot (Slack) ou SNStópico. Em Escolher destino, escolha o nome do cliente (para um cliente Slack configurado em AWS Chatbot) ou o Nome do recurso da Amazon (ARN) do SNS tópico da Amazon (para SNS tópicos da Amazon já configurados com a política necessária para notificações).

    • Se você não configurou um recurso para usar com notificações, escolha Criar alvo e, em seguida, escolha SNStópico. Forneça um nome para o tópico após codestar-notifications- e escolha Create (Criar).

    nota

    • Se você criar o SNS tópico da Amazon como parte da criação da regra de notificação, a política que permite que o recurso de notificações publique eventos no tópico será aplicada a 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 AWS Chatbot cliente como parte da criação de uma regra de notificação. Se você escolher AWS Chatbot (Slack), você verá um botão orientando você a configurar um cliente em. AWS Chatbot Escolher essa opção abre o AWS Chatbot console. Para obter mais informações, consulte Configurar integrações entre notificações e. AWS Chatbot

    • Se você quiser usar um SNS tópico existente da Amazon como alvo, você deve adicionar a política necessária para AWS CodeStar Notificações, além de quaisquer outras políticas que possam existir para esse tópico. Para obter mais informações, consulte Configurar SNS tópicos da Amazon para notificações e Compreender o conteúdo e a segurança das notificações.

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

  9. Você deve inscrever usuários no SNS tópico da Amazon para a regra antes que eles possam receber notificações. Para obter mais informações, consulte Inscrever usuários em SNS tópicos da Amazon que são alvos. Você também pode configurar a integração entre as notificações e enviar notificações AWS Chatbot para as salas de bate-papo do Amazon Chime. Para obter mais informações, consulte Configurar a integração entre notificações AWS Chatbot e.

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

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

    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 JSON arquivo em um editor de texto sem formatação e edite-o para incluir o recurso, os tipos de eventos e o destino que você deseja para a regra. O exemplo a seguir mostra uma regra de notificação com o nome MyNotificationRule de um repositório chamado MyDemoRepo em uma AWS conta com o ID 123456789012. As notificações com o tipo de detalhe completo são enviadas para um SNS tópico da Amazon 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 for bem-sucedido, o comando retornará a regra ARN de notificação, semelhante à seguinte:

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