Erstellen einer Benachrichtigungsregel

Sie können Benachrichtigungsregeln verwenden, um Benutzer über wichtige Änderungen zu informieren, z. B. wenn eine Pull-Anfrage in einem Repository erstellt wird. Die Benachrichtigungsregeln spezifizieren sowohl die Ereignisse als auch das SNS Amazon-Thema, das für den Versand von Benachrichtigungen verwendet wird. Weitere Informationen finden Sie unter Was sind Benachrichtigungen?.

Anmerkung

Diese Funktion ist in der Region Europa (Mailand) nicht verfügbar. Informationen zur Konfiguration von Benachrichtigungen in dem in dieser Region verfügbaren Erlebnis finden Sie unter Repository-Benachrichtigungen konfigurieren.

Sie können die Konsole oder die verwenden AWS CLI , um Benachrichtigungsregeln für zu erstellen AWS CodeCommit.

So erstellen Sie eine Benachrichtigungsregel (Konsole):

1. Melden Sie sich bei der an AWS Management Console und öffnen Sie die CodeCommit Konsole unter https://console.aws.amazon.com/codecommit/.

2. Wählen Sie Repositories (Repositorys) und dann ein Repository aus, zu dem Sie Benachrichtigungsregeln hinzufügen möchten.

3. Wählen Sie auf der Repository-Seite Notify (Benachrichtigen) und dann Create notification rule (Benachrichtigungsregel erstellen). Sie können auch zur Seite Settings (Einstellungen) für das Repository navigieren und Create notification rule (Benachrichtigungsregel erstellen) wählen.

4. Geben Sie unter Notification name (Benachrichtigungsname) einen Namen für die Regel ein.

5. Wählen Sie unter Detailtyp die Option Basic aus, wenn Sie möchten, dass nur die Informationen, die Amazon zur Verfügung gestellt wurden, in der Benachrichtigung EventBridge enthalten sind. Wählen Sie Vollständig, wenn Sie Informationen, die Amazon zur Verfügung gestellt wurden, EventBridge und Informationen, die möglicherweise vom CodeCommit oder vom Notification Manager bereitgestellt wurden, einbeziehen möchten.

   Weitere Informationen finden Sie unter Informationen zu Inhalten und Sicherheit von Benachrichtigungen.

6. Wählen Sie unter Events that trigger notifications (Ereignisse, die Benachrichtigungen auslösen) die Ereignisse aus, für die Sie Benachrichtigungen senden möchten. Weitere Informationen finden Sie unter Ereignisse für Benachrichtigungsregeln in Repositories.

7. Führen Sie unter Targets (Ziele) einen der folgenden Schritte aus:

   • Wenn du bereits eine Ressource für Benachrichtigungen konfiguriert hast, wähle unter Zieltyp auswählen entweder AWS Chatbot (Slack) oder SNSThema aus. Wähle unter Ziel auswählen den Namen des Clients (für einen in konfigurierten Slack-Client AWS Chatbot) oder den Amazon-Ressourcennamen (ARN) des Amazon-Themas (für SNS SNS Amazon-Themen, die bereits mit der für Benachrichtigungen erforderlichen Richtlinie konfiguriert wurden).

   • Wenn Sie keine Ressource für die Verwendung mit Benachrichtigungen konfiguriert haben, wählen Sie Ziel erstellen und dann SNSThema aus. Geben Sie nach codestar-notifications- einen Namen für das Thema an und wählen Sie dann Create (Erstellen).

   Anmerkung

   • Wenn Sie das SNS Amazon-Thema im Rahmen der Erstellung der Benachrichtigungsregel erstellen, wird die Richtlinie, die es der Benachrichtigungsfunktion ermöglicht, Ereignisse zu dem Thema zu veröffentlichen, für Sie angewendet. Durch die Verwendung eines Themas, das für Benachrichtigungsregeln erstellt wurde, kann sichergestellt werden, dass Sie das Thema nur für die Benutzer abonnieren, die Benachrichtigungen zu dieser Ressource erhalten sollen.

   • Sie können im Rahmen der Erstellung einer Benachrichtigungsregel keinen AWS Chatbot Client erstellen. Wenn du AWS Chatbot (Slack) auswählst, siehst du eine Schaltfläche, in der du einen Client konfigurieren kannst. AWS Chatbot Wenn Sie diese Option wählen, wird die AWS Chatbot Konsole geöffnet. Weitere Informationen finden Sie unter Integrationen zwischen Benachrichtigungen konfigurieren und AWS Chatbot.

   • Wenn Sie ein vorhandenes SNS Amazon-Thema als Ziel verwenden möchten, müssen Sie die erforderliche Richtlinie für AWS CodeStar Benachrichtigungen zusätzlich zu allen anderen Richtlinien hinzufügen, die möglicherweise für dieses Thema existieren. Weitere Informationen finden Sie unter SNS Amazon-Themen für Benachrichtigungen konfigurieren und Inhalt und Sicherheit von Benachrichtigungen verstehen.

8. Um die Erstellung der Regel abzuschließen, wählen Sie Submit (Absenden) aus.

9. Sie müssen das SNS Amazon-Thema für die Regel abonnieren, bevor sie Benachrichtigungen erhalten können. Weitere Informationen finden Sie unter Amazon SNS Topics That Are Targets für Benutzer abonnieren. Sie können auch die Integration zwischen Benachrichtigungen einrichten und Benachrichtigungen AWS Chatbot an Amazon Chime Chime-Chatrooms senden. Weitere Informationen finden Sie unter Konfiguration der Integration zwischen Benachrichtigungen und. AWS Chatbot

So erstellen Sie eine Benachrichtigungsregel (AWS CLI):

1. Führen Sie in einem Terminal oder an einer Befehlszeile den create-notification rule Befehl aus, um das JSON Skelett zu generieren:

   aws codestar-notifications create-notification-rule --generate-cli-skeleton > rule.json

   Sie können die Datei beliebig benennen. In diesem Beispiel hat die Datei den Namen rule.json.

2. Öffnen Sie die JSON Datei in einem Nur-Text-Editor und bearbeiten Sie sie so, dass sie die Ressource, die Ereignistypen und das Ziel enthält, die Sie für die Regel verwenden möchten. Das folgende Beispiel zeigt eine Benachrichtigungsregel, die nach einem Repository mit dem Namen benannt MyNotificationRule ist MyDemoRepo in einem AWS Konto mit der ID 123456789012. Benachrichtigungen mit dem vollständigen Detailtyp werden an ein SNS Amazon-Thema mit dem Namen gesendet MyNotificationTopic wenn Zweige und Tags erstellt werden:

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

   Speichern Sie die Datei.

3. Führen Sie unter Verwendung der soeben bearbeiteten Datei am Terminal oder in der Befehlszeile erneut den Befehl create-notification-rule aus, um die Benachrichtigungsregel zu erstellen:

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

4. Bei Erfolg gibt der Befehl den Wert ARN der Benachrichtigungsregel zurück, ähnlich der folgenden:

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