Erstellen einer Benachrichtigungsregel - Entwicklertools-Konsole

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 mit der Entwicklertools-Konsole oder der AWS CLI Benachrichtigungsregeln erstellen. Sie können beim Erstellen einer Regel ein Amazon-SNS-Thema als Ziel der Benachrichtigungsregel erstellen (empfohlen). Wenn Sie einen AWS-Chatbot-Client als Ziel verwenden möchten, müssen Sie diesen Client erstellen, bevor Sie die Regel erstellen können. Weitere Informationen finden Sie unter Konfigurieren eines AWS-Chatbot-Clients für einen Slack-Kanal.

So erstellen Sie eine Benachrichtigungsregel (Konsole):

  1. Öffnen Sie die AWS-Entwicklertools-Konsole unter https://console.aws.amazon.com/codesuite/settings/notifications.

  2. Verwenden Sie die Navigationsleiste, um zu der Ressource zu navigieren.

    • Gehen Sie für CodeBuild zu Build und wählen Sie unter Build projects (Build-Projekte) ein Build-Projekt.

    • Wählen Sie für CodeCommit die Option Source (Quelle), Repositories (Repositorys) und anschließend ein Repository aus.

    • Wählen Sie für CodeDeploy die Option Applications (Anwendungen) und anschließend eine Anwendung aus.

    • Gehen Sie für CodePipeline zu Pipeline und wählen Sie unter Pipelines eine aus.

  3. Wählen Sie auf der Ressourcenseite Notify (Benachrichtigung) und dann Create notification rule (Benachrichtigungsregel erstellen) aus. Sie können auch die Seite Settings (Einstellungen) für die Ressource aufrufen, zu Notifications (Benachrichtigungen) oder Notification rules (Benachrichtigungsregeln) wechseln und dann 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 Detail type (Detailtyp) die Option Basic (Einfach) aus, wenn nur die für Amazon EventBridge bereitgestellten Informationen in der Benachrichtigung enthalten sein sollen. Wählen Sie Full (Vollständig), wenn Sie für Amazon EventBridge bereitgestellte und möglicherweise vom Ressourcenservice oder vom Benachrichtigungsmanager bereitgestellte Informationen berücksichtigen möchten.

    Weitere Informationen finden Sie unter Grundlagen zu Benachrichtigungsinhalten und -sicherheit.

  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. Informationen zu den Ereignistypen für eine Ressource finden Sie in folgenden Abschnitten:

  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 auswählen) entweder AWS Chatbot (Slack), AWS Chatbot (Microsoft Teams) oder SNS topic (SNS-Thema) aus. Wählen Sie unter Choose target (Ziel auswählen) den Namen des Clients (für einen in AWS Chatbot konfigurierten Slack- oder Microsoft Teams-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) aus.

    • 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) oder AWS Chatbot (Microsoft Teams) auswählen, sehen Sie eine Schaltfläche, die Sie zur Konfiguration eines Clients in Chatbot führt. Wenn Sie diese Option auswählen, wird die AWS-Chatbot-Konsole geöffnet. Weitere Informationen finden Sie unter Konfigurieren eines AWS-Chatbot-Clients für einen Slack-Kanal.

    • Wenn Sie ein vorhandenes Amazon-SNS-Thema als Ziel verwenden möchten, müssen Sie AWS CodeStar Notifications zusätzlich zu allen anderen Richtlinien, die für dieses Thema vorhanden sind, die erforderliche Richtlinie hinzufügen. Weitere Informationen finden Sie unter Konfigurieren von Amazon-SNS-Themen für Benachrichtigungen und Grundlagen zu Benachrichtigungsinhalten und -sicherheit.

  8. Wählen Sie Submit (Absenden) und überprüfen Sie die Benachrichtigungsregel.

    Anmerkung

    Benutzer müssen das Amazon-SNS-Thema abonnieren und das Abonnement bestätigen, das Sie als Ziel der Regel angegeben haben, bevor sie Benachrichtigungen erhalten. Weitere Informationen finden Sie unter Ein Amazon-SNS-Thema, das für Benachrichtigungen verwendet wird, für Benutzer abonnieren.

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 Amazon-SNS-Ziel für die Regel enthält.

    Das folgende Beispiel zeigt eine Benachrichtigungsregel mit der Bezeichnung MyNotificationRule für ein Repository namens MyDemoRepo in einem AWS-Konto mit der ID 123456789012. Benachrichtigungen mit dem Detailtyp „full“ (vollständig) werden an ein Amazon-SNS-Thema namens MyNotificationTopic gesendet, 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 im 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 nachfolgend gezeigt aussieht:

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

So listen Sie Ereignistypen für Benachrichtigungsregeln auf (AWS CLI):

  1. Führen Sie in einem Terminal oder an einer Eingabeaufforderung den Befehl list-event-types aus. Sie können die --filters-Option verwenden, um die Antwort auf einen bestimmten Ressourcentyp oder ein anderes Attribut zu beschränken. Im Folgenden Beispiel wird eine Liste von Ereignistypen für CodeDeploy-Anwendungen zurückgegeben.

    aws codestar-notifications list-event-types --filters Name=SERVICE_NAME,Value=CodeDeploy

  2. Die Ausgabe dieses Befehls sieht etwa wie folgt aus.

    {
    "EventTypes": [
        {
            "EventTypeId": "codedeploy-application-deployment-succeeded",
            "ServiceName": "CodeDeploy",
            "EventTypeName": "Deployment: Succeeded",
            "ResourceType": "Application"
        },
        {
            "EventTypeId": "codedeploy-application-deployment-failed",
            "ServiceName": "CodeDeploy",
            "EventTypeName": "Deployment: Failed",
            "ResourceType": "Application"
        },
        {
            "EventTypeId": "codedeploy-application-deployment-started",
            "ServiceName": "CodeDeploy",
            "EventTypeName": "Deployment: Started",
            "ResourceType": "Application"
        }
    ]
}

So fügen Sie einer Benachrichtigungsregel ein Tag hinzu (AWS CLI):

  1. Führen Sie in einem Terminal oder an einer Eingabeaufforderung den Befehl tag-resource aus. Verwenden Sie beispielsweise den folgenden Befehl, um ein Tag-Schlüsselwert-Paar mit dem Namen Team und dem Wert Li_Juan hinzuzufügen.

    aws codestar-notifications tag-resource --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE --tags Team=Li_Juan

  2. Die Ausgabe dieses Befehls sieht etwa wie folgt aus.

    {
    "Tags": {
        "Team": "Li_Juan"
    }
}