Création d'une règle de notification

Vous pouvez utiliser des règles de notification pour informer les utilisateurs de changements importants, notamment des succès et des échecs de création. Les règles de notification spécifient à la fois les événements et le sujet Amazon SNS utilisé pour envoyer des notifications. Pour plus d'informations, consultez Que sont les notifications ?

Vous pouvez utiliser la console ou l’AWS CLI pour créer des règles de notification pour AWS CodeBuild.

Pour créer une règle de notification (console)

1. Connectez-vous à la CodeBuild console AWS Management Console et ouvrez-la à l'adresse https://console.aws.amazon.com/codebuild/.

2. Choisissez Build (Générer), puis Build projects (Générer des projets), puis sélectionnez un projet de création auquel vous souhaitez ajouter des notifications.

3. Sur la page du projet de création, choisissez Notify (Notifier), puis Create notification rule (Créer une règle de notification). Vous pouvez également accéder à la page Settings (Paramètres) du projet de génération et choisir Create notification rule (Créer une règle de notification).

4. Dans Notification name (Nom de la notification), saisissez le nom de la règle.

5. Dans Type de détail, choisissez Basic si vous souhaitez que seules les informations fournies à Amazon soient EventBridge incluses dans la notification. Choisissez Complet si vous souhaitez inclure les informations fournies à Amazon EventBridge et les informations susceptibles d'être fournies par le CodeBuild ou le gestionnaire de notifications.

   Pour plus d'informations, consultez Présentation du contenu des notifications et de la sécurité.

6. Dans Événements qui déclenchent des notifications, sélectionnez les événements pour lesquels vous souhaitez envoyer des notifications. Pour de plus amples informations, veuillez consulter Événements pour les règles de notification sur les projets de génération.

7. Dans Targets (Cibles), effectuez l'une des actions suivantes :

   • Si vous avez déjà configuré une ressource à utiliser avec les notifications, dans Choose target type (Choisir le type de cible), choisissez AWS Chatbot (Slack) ou SNS topic (Rubrique SNS). Dans Choisir une cible, choisissez le nom du client (pour un client Slack configuré dansAWS Chatbot) ou le nom de ressource Amazon (ARN) de la rubrique Amazon SNS (pour les rubriques Amazon SNS déjà configurées avec la politique requise pour les notifications).

   • Si vous n'avez pas configuré de ressource à utiliser avec les notifications, choisissez Create target (Créer une cible), puis SNS topic (Rubrique SNS). Donnez un nom à la rubrique après codestar-notifications-, puis choisissez Create (Créer).

   Note

   • Si vous créez la rubrique Amazon SNS dans le cadre de la création de la règle de notification, la stratégie qui permet à la fonctionnalité de notifications de publier des événements dans la rubrique est appliquée automatiquement. L'utilisation d'une rubrique créée pour les règles de notification vous permet de vous assurer que vous n'abonnez que les utilisateurs qui doivent recevoir des notifications sur ce référentiel.

   • Vous ne pouvez pas créer un client AWS Chatbot dans le cadre de la création d'une règle de notification. Si vous choisissez AWS Chatbot (Slack), vous verrez un bouton vous demandant de configurer un client dans AWS Chatbot. Le choix de cette option provoque l’ouverture de la console AWS Chatbot. Pour de plus amples informations, veuillez consulter Configurer les intégrations entre les notifications et AWS Chatbot.

   • Si vous souhaitez utiliser une rubrique Amazon SNS existante comme cible, vous devez ajouter la politique requise pour les AWS CodeStar notifications en plus de toute autre politique susceptible d'exister pour cette rubrique. Pour de plus amples informations, veuillez consulter Configurer les rubriques Amazon SNS existantes pour les notifications et Présentation du contenu des notifications et de la sécurité.

8. Pour terminer la création de la règle, choisissez Submit (Soumettre).

9. Vous devez inscrire les utilisateurs à la rubrique Amazon SNS relative à la règle pour qu'ils puissent recevoir des notifications. Pour plus d'informations, consultez Abonner des utilisateurs aux rubriques Amazon SNS qui sont des cibles. Vous pouvez également configurer l'intégration entre les notifications et envoyer des notifications AWS Chatbot aux forums de discussion Amazon Chime. Pour plus d'informations, consultez Configurer l'intégration entre les notifications et AWS Chatbot.

Pour créer une règle de notification (AWS CLI)

1. Dans un terminal ou une invite de commandes, exécutez la commande create-notification rule pour générer le squelette JSON :

   aws codestarnotifications create-notification-rule --generate-cli-skeleton > rule.json

   Vous pouvez donner au fichier le nom de votre choix. Dans cet exemple, le fichier est nommé rule.json.

2. Ouvrez le fichier JSON dans un éditeur de texte brut et modifiez-le pour y inclure la ressource, les types d'événements et la cible que vous souhaitez pour la règle. L'exemple suivant montre une règle de notification nommée MyNotificationRule pour un projet de construction nommé MyBuildProjectdans un AWS compte avec l'ID 123456789012. Les notifications sont envoyées avec le type de détail complet à une rubrique Amazon SNS nommée codestar-notifications, lorsque les builds sont réussis : MyNotificationTopic

   {
       "Name": "MyNotificationRule",
       "EventTypeIds": [
           "codebuild-project-build-state-succeeded"
       ],
       "Resource": "arn:aws:codebuild:us-east-2:123456789012:MyBuildProject",
       "Targets": [
           {
               "TargetType": "SNS",
               "TargetAddress": "arn:aws:sns:us-east-2:123456789012:codestar-notifications-MyNotificationTopic"
           }
       ],
       "Status": "ENABLED",
       "DetailType": "FULL"
   }

   Sauvegardez le fichier.

3. À l'aide du fichier que vous venez de modifier, à partir du terminal ou de la ligne de commande, exécutez à nouveau la commande create-notification-rule pour créer la règle de notification :

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

4. En cas de réussite, la commande renvoie l'ARN de la règle de notification, comme suit :

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