View a markdown version of this page

Erstellen einer Benachrichtigungsregel - AWS CodeCommit

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

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 Amazon SNS-Thema, das zum Senden 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 der für diese Region verfügbaren Benutzeroberfläche 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-Managementkonsole 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 Einfach aus, wenn nur die Informationen, die Amazon zur Verfügung gestellt wurden, in der Benachrichtigung EventBridge enthalten sein sollen. Wählen Sie „Vollständig“, wenn Sie Informationen, die Amazon zur Verfügung gestellt wurden, EventBridge sowie Informationen, die möglicherweise vom CodeCommit oder dem Benachrichtigungsmanager bereitgestellt werden, 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 Sie bereits eine Ressource für Benachrichtigungen konfiguriert haben, wählen Sie unter Zieltyp auswählen entweder Amazon Q Developer in Chat-Anwendungen (Slack) oder ein SNS-Thema aus. Wählen Sie unter Ziel auswählen den Namen des Clients (für einen in Amazon Q Developer in Chat-Anwendungen konfigurierten Slack-Client) oder den Amazon-Ressourcennamen (ARN) des Amazon SNS-Themas (für Amazon SNS-Themen, die bereits mit der für Benachrichtigungen erforderlichen Richtlinie konfiguriert sind).

    • 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 im Rahmen der Erstellung einer Benachrichtigungsregel keinen Amazon Q Developer im Client für Chat-Anwendungen erstellen. Wenn Sie Amazon Q Developer in Chat-Anwendungen (Slack) wählen, wird Ihnen eine Schaltfläche angezeigt, über die Sie in Amazon Q Developer in Chat-Anwendungen einen Client konfigurieren können. Wenn Sie diese Option auswählen, wird der Amazon Q Developer in der Chat-Anwendungskonsole geöffnet. Weitere Informationen finden Sie unter Konfigurieren von Integrationen zwischen Benachrichtigungen und Amazon Q Developer in Chat-Anwendungen.

    • Wenn Sie ein vorhandenes Amazon SNS-Thema als Ziel verwenden möchten, müssen Sie zusätzlich zu allen anderen Richtlinien, die möglicherweise für dieses Thema existieren, die erforderliche Richtlinie für AWS CodeStar Benachrichtigungen hinzufügen. 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 Benutzern das Amazon SNS-Thema für die Regel abonnieren, bevor sie Benachrichtigungen erhalten können. Weitere Informationen finden Sie unter Abonnieren von Amazon SNS-Themen, die als Zielgruppen gelten. Sie können auch die Integration zwischen Benachrichtigungen und Amazon Q Developer in Chat-Anwendungen einrichten, um Benachrichtigungen an Amazon Chime-Chatrooms zu senden. Weitere Informationen finden Sie unter Konfigurieren der Integration zwischen Benachrichtigungen und Amazon Q Developer in Chat-Anwendungen.

Um eine Benachrichtigungsregel zu erstellen (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 heißt die Datei 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 MyNotificationRule nach einem Repository benannt ist, das MyDemoRepo in einem AWS Konto mit der ID 123456789012 benannt ist. Benachrichtigungen mit dem vollständigen Detailtyp werden an ein Amazon SNS-Thema gesendet, das MyNotificationTopic bei der Erstellung von Branches und Tags benannt wird:

    {
    "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 ARN der Benachrichtigungsregel zurück, der ähnlich wie im Folgenden dargestellt aussieht:

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