Création d'une règle de notification

Vous pouvez utiliser des règles de notification pour informer les utilisateurs des modifications apportées aux applications de déploiement, notamment les succès et les échecs du déploiement. Les règles de notification spécifient à la fois les événements et la rubrique Amazon SNS utilisés pour envoyer des notifications. Pour plus d'informations, consultez Que sont les notifications ?

Vous pouvez utiliser la console ou le AWS CLI pour créer des règles de notification pour AWS CodeDeploy.

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

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

2. Choisissez Application, puis une application dans laquelle vous souhaitez ajouter des notifications.

3. Sur la page de l’application, choisissez Notify (Notifier), puis Create notification rule (Créer une règle de notification). Vous pouvez également accéder à la page Settings (Paramètres) de l'application 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 CodeDeploy ou le gestionnaire de notifications.

   Pour plus d'informations, voir Comprendre le contenu et la sécurité des notifications.

6. Dans Événements qui déclenchent des notifications, sélectionnez les événements pour lesquels vous souhaitez envoyer des notifications.

   Catégorie	Événements
   Déploiement	Échec Réussi Démarré(e)

7. Dans Targets (Cibles), choisissez Create SNS topic (Créer une rubrique SNS).

   Note

   Lorsque vous créez le sujet, la politique qui permet CodeDeploy de publier des événements sur le sujet est appliquée pour vous. L'utilisation d'une rubrique créée spécifiquement pour CodeDeploy les notifications permet également de garantir que vous n'ajoutez que des utilisateurs à la liste d'abonnement pour la rubrique pour laquelle vous souhaitez voir les notifications relatives à cette application de déploiement.

   Après le préfixe codestar-notifications-, entrez un nom pour la rubrique, puis choisissez Submit (Envoyer).

   Note

   Si vous souhaitez utiliser une rubrique Amazon SNS existante au lieu d'en créer une nouvelle, dans Targets (Cibles), choisissez son ARN. Assurez-vous que la rubrique dispose de la stratégie d'accès appropriée et que la liste d'abonnés contient uniquement les utilisateurs autorisés à voir des informations sur l'application de déploiement. Pour plus d'informations, consultez Configurer les rubriques Amazon SNS existantes pour les notifications et Comprendre le contenu et la sécurité des notifications.

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 les 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 ou aux chaînes Slack. Pour plus d'informations, voir 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 codestar-notifications 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 inclure la ressource, les types d'événements et la cible Amazon SNS que vous souhaitez pour la règle. L'exemple suivant montre une règle de notification nommée MyNotificationRule pour une application nommée MyDeploymentApplicationdans 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 déploiements sont réussis : MyNotificationTopic

   {
       "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"
   }

   Enregistrez 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 codestar-notifications 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"
   }