Erstellen einer Benachrichtigungsregel

Sie können Benachrichtigungsregeln verwenden, um Benutzer über wichtige Änderungen zu informieren, z. B. wenn eine Pipeline eine Ausführung startet. In den Benachrichtigungsregeln werden sowohl die Ereignisse als auch das Amazon SNS SNS-Thema festgelegt, das zum Senden von Benachrichtigungen verwendet wird. Weitere Informationen finden Sie unter Was sind Benachrichtigungen?.

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

So erstellen Sie eine Benachrichtigungsregel (Konsole):

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

2. Wählen Sie Pipelines (Pipelines) und anschließend die Pipeline aus, der Sie Benachrichtigungen hinzufügen möchten.

3. Wählen Sie auf der Seite für Pipelines Notify (Benachrichtigen) und anschließend Create notification rule (Benachrichtigungsregel erstellen) aus. Sie können auch zur Seite Settings (Einstellungen) für die Pipeline navigieren und Create notification rule (Benachrichtigungsregel erstellen)auswä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 CodePipeline oder vom Benachrichtigungsmanager 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 Pipelines.

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

   • Wenn Sie bereits eine Ressource zur Verwendung mit Benachrichtigungen konfiguriert haben, wählen Sie unter Choose target type (Zieltyp wählen) entweder AWS Chatbot(Slack) oder SNS topic (SNS-Thema)aus. Wählen Sie unter Ziel auswählen den Namen des Clients (für einen in konfigurierten Slack-ClientAWS Chatbot) oder den Amazon-Ressourcennamen (ARN) des Amazon SNS-Themas (für Amazon SNS SNS-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 Create target (Ziel erstellen) und dann SNS topic (SNS-Thema) aus. Geben Sie nach codestar-notifications- einen Namen für das Thema an und wählen Sie dann Create (Erstellen).

   Anmerkung

   • Wenn Sie das Amazon-SNS-Thema im Rahmen des Erstellens der Benachrichtigungsregel erstellen, wird die Richtlinie, die es ermöglicht, Ereignisse in 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 keinen AWS Chatbot-Client als Teil der Erstellung einer Benachrichtigungsregel erstellen. Wenn Sie AWS Chatbot (Slack) wählen, sehen Sie eine Schaltfläche, die Sie zur Konfiguration eines Clients in AWS Chatbot führt. Wenn Sie diese Option auswählen, wird die AWS Chatbot-Konsole geöffnet. Weitere Informationen finden Sie unter Konfigurieren der Integration zwischen Benachrichtigungen und AWS Chatbot.

   • Wenn Sie ein vorhandenes Amazon SNS SNS-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 Konfigurieren vorhandener Amazon SNS-Themen für Benachrichtigungen und Informationen zu Inhalten und Sicherheit von Benachrichtigungen.

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

9. Sie müssen das Amazon SNS SNS-Thema für die Regel abonnieren, bevor sie Benachrichtigungen erhalten können. Weitere Informationen finden Sie unter Amazon SNS SNS-Themen, die Ziele sind für Benutzer abonnieren. Sie können auch die Integration zwischen Benachrichtigungen einrichten und AWS Chatbot Benachrichtigungen an Amazon Chime-Chatrooms oder Slack-Kanäle senden. Weitere Informationen finden Sie unter Konfigurieren der Integration zwischen Benachrichtigungen und AWS Chatbot.

So erstellen Sie eine Benachrichtigungsregel (AWS CLI):

1. Führen Sie in einem Terminal oder einer Eingabeaufforderung den Befehl create-notification rule 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 trägt die Datei den Namen rule.json.

2. Öffnen Sie die JSON-Datei in einem Texteditor, und bearbeiten Sie sie so, dass sie die Ressource, die Ereignistypen und das gewünschte Ziel für die Regel enthält. Das folgende Beispiel zeigt eine Benachrichtigungsregel, die nach einer Pipeline benannt ist, MyNotificationRule die MyDemoPipelinein einem AWS Konto mit der ID 123456789012 benannt ist. Benachrichtigungen werden mit dem vollständigen Detailtyp an ein Amazon SNS SNS-Thema namens codestar-notifications gesendet, MyNotificationTopic wenn Pipeline-Ausführungen beginnen:

   {
       "Name": "MyNotificationRule",
       "EventTypeIds": [
           "codepipeline-pipeline-pipeline-execution-started"
       ],
       "Resource": "arn:aws:codebuild:us-east-2:123456789012:MyDemoPipeline",
       "Targets": [
           {
               "TargetType": "SNS",
               "TargetAddress": "arn:aws:sns:us-east-2:123456789012:codestar-notifications-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 ARN der Benachrichtigungsregel zurück, der ähnlich wie im Folgenden dargestellt aussieht:

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