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.
Benachrichtigungskonzepte
Das Einrichten und Verwenden von Benachrichtigungen ist einfacher, wenn Sie die Konzepte und Begriffe verstehen. Im Folgenden finden Sie einige Konzepte, die Sie kennen sollten, wenn Sie Benachrichtigungen verwenden.
Themen
- Benachrichtigungen
- Benachrichtigungsregeln
- Ereignisse
- Detailtypen
- Targets (Ziele)
- Benachrichtigungen und AWS CodeStar Notifications
- Ereignisse für Benachrichtigungsregeln für Repositorys
- Ereignisse für Benachrichtigungsregeln für Build-Projekte
- Ereignisse für Benachrichtigungsregeln für Bereitstellungsanwendungen
- Ereignisse für Benachrichtigungsregeln für Pipelines
Benachrichtigungen
Eine Benachrichtigung ist eine Nachricht, die Informationen zu Ereignissen enthält, die in den von Ihnen und Ihren Entwicklern verwendeten Ressourcen auftreten. Sie können Benachrichtigungen einrichten, damit Benutzer einer Ressource, wie z. B. eines Build-Projekts, eines Repositorys, einer Bereitstellungsanwendung oder einer Pipeline, E-Mail-Nachrichten zu den Ereignistypen erhalten, die Sie entsprechend der von Ihnen erstellten Benachrichtigungsregel angeben.
Benachrichtigungen für AWS CodeCommit können mithilfe von Sitzungs-Tags Benutzeridentitätsinformationen enthalten, wie z. B. einen Anzeigenamen oder eine E-Mail-Adresse. CodeCommit unterstützt die Verwendung von Sitzungs-Tags, bei denen es sich um Schlüssel-Wert-Paarattribute handelt, die Sie übergeben, wenn Sie eine IAM-Rolle übernehmen, temporäre Anmeldeinformationen verwenden oder einen Benutzer im AWS Security Token Service (AWS STS) zusammenführen. Sie können Tags auch einem IAM-Benutzer zuordnen. CodeCommit enthält die Werte für displayName (angezeigter Name) und emailAddress (E-Mail-Adresse) im Benachrichtigungsinhalt, wenn diese Tags vorhanden sind. Weitere Informationen finden Sie unter Verwenden von Tags zum Bereitstellen zusätzlicher Identitätsinformationen in CodeCommit.
Wichtig
Benachrichtigungen enthalten projektspezifische Informationen wie Build-Status, Bereitstellungsstatus, Codezeilen mit Kommentaren und Pipeline-Genehmigungen. Der Inhalt einer Benachrichtigung kann sich ändern, wenn neue Funktionen hinzugefügt werden. Sie sollten eine bewährte Methode für die Sicherheit anwenden und die Ziele der Benachrichtigungsregeln sowie die Amazon–SNS-Themenabonnenten regelmäßig überprüfen. Weitere Informationen finden Sie unter Grundlagen zu Benachrichtigungsinhalten und -sicherheit.
Benachrichtigungsregeln
Eine Benachrichtigungsregel ist eine AWS-Ressource, die Sie erstellen, um anzugeben, wann und wohin Benachrichtigungen gesendet werden. Sie definiert Folgendes:
-
Die Bedingungen, unter denen eine Benachrichtigung erstellt wird. Diese Bedingungen basieren auf Ereignissen, die Sie auswählen, und die spezifisch für den Ressourcentyp sind. Zu den unterstützten Ressourcentypen gehören Build-Projekte in AWS CodeBuild, Bereitstellungsanwendungen in AWS CodeDeploy, Pipelines in AWS CodePipeline und Repositorys in AWS CodeCommit.
-
Die Ziele, an die die Benachrichtigung gesendet wird. Sie können bis zu 10 Ziele für eine Benachrichtigungsregel angeben.
Benachrichtigungsregeln gelten für einzelne Build-Projekte, Bereitstellungsanwendungen, Pipelines und Repositorys. Benachrichtigungsregeln haben sowohl benutzerdefinierte Anzeigenamen als auch Amazon-Ressourcennamen (ARNs). Benachrichtigungsregeln müssen in der AWS-Region erstellt werden, in der sich auch die Ressource befindet. Wenn sich Ihr Build-Projekt beispielsweise in der Region USA Ost (Ohio) befindet, muss Ihre Benachrichtigungsregel ebenfalls in der Region USA Ost (Ohio) erstellt werden.
Sie können bis zu 10 Benachrichtigungsregeln für eine Ressource definieren.
Ereignisse
Ein Ereignis ist eine Statusänderung für eine Ressource, die Sie überwachen möchten. Jede Ressource verfügt über eine Liste von Ereignistypen, die Sie auswählen können. Wenn Sie eine Benachrichtigungsregel für eine Ressource einrichten, geben Sie die Ereignisse an, die dazu führen, dass Benachrichtigungen gesendet werden. Wenn Sie beispielsweise Benachrichtigungen für ein Repository in CodeCommit einrichten und Created (Erstellt) für Pull request (Pull-Anforderung) und Branches and tags (Zweige und Tags) auswählen, wird jedes Mal eine Benachrichtigung gesendet, wenn ein Benutzer in diesem Repository eine Pull-Anforderung, einen Zweig oder ein Git-Tag erstellt.
Detailtypen
Beim Erstellen einer Benachrichtigungsregel können Sie die Detailgenauigkeit (Level of Detail) oder den Detailtyp (Detail Type) wählen, die/der in den Benachrichtigungen enthalten ist (Full (Vollständig) oder Basic (Einfach)). Die Einstellung Full (Vollständig) (die Standardeinstellung) umfasst alle für das Ereignis in der Benachrichtigung verfügbaren Informationen, einschließlich aller erweiterten Informationen, die von Services für bestimmte Ereignisse bereitgestellt werden. Die Einstellung Basic (Einfach) enthält nur eine Teilmenge der verfügbaren Informationen.
In der folgenden Tabelle werden die für bestimmte Ereignistypen verfügbaren erweiterten Informationen aufgeführt und die Unterschiede zwischen den Detailtypen beschrieben.
| Service | Veranstaltung | Full (Vollständig) enthält | Basic (Einfach) enthält nicht |
|---|---|---|---|
|
CodeCommit |
Kommentare zu Commits Kommentare zu Pull-Anforderungen |
alle Ereignisdetails und der Inhalt des Kommentars, einschließlich aller Antworten oder Kommentar-Threads. Enthalten sind auch die Zeilennummer und die Codezeile, zu der der Kommentar abgegeben wurde. |
den Inhalt des Kommentars, die Zeilennummer, Codezeile oder irgendwelche Kommentar-Threads. |
|
CodeCommit |
Pull-Anforderung erstellt |
alle Ereignisdetails und die Anzahl der Dateien, die in der Pull-Anforderung in Bezug auf den Ziel-Branch hinzugefügt, geändert oder gelöscht wurden. |
eine Liste von Dateien oder Details darüber, ob in der Pull-Anforderung in Bezug auf den Quell-Branch Dateien hinzugefügt, geändert oder gelöscht wurden. |
|
CodePipeline |
Manuelle Genehmigung erforderlich |
alle Ereignisdetails und benutzerdefinierten Daten (falls konfiguriert). Die Benachrichtigung enthält auch einen Link zur erforderlichen Genehmigung in der Pipeline. |
keine benutzerdefinierten Daten oder Links. |
|
CodePipeline |
Aktionsausführung fehlgeschlagen Pipelineausführung fehlgeschlagen Phasenausführung fehlgeschlagen |
alle Ereignisdetails und den Inhalt der Fehlermeldung für den Ausfall. |
keinen Inhalt der Fehlermeldung. |
Targets (Ziele)
Ein Ziel ist ein Speicherort für den Empfang von Benachrichtigungen von Benachrichtigungsregeln. Die zulässigen Zieltypen sind Amazon-SNS-Themen und AWS-Chatbot-Clients, die für Slack- oder Microsoft Teams-Kanäle konfiguriert sind. Jeder Benutzer, der das Zielthema abonniert hat, erhält Benachrichtigungen über die von Ihnen in der Benachrichtigungsregel angegebenen Ereignisse.
Wenn Sie die Reichweite von Benachrichtigungen erweitern möchten, können Sie eine Integration der Benachrichtigungen mit AWS Chatbot konfigurieren, sodass Benachrichtigungen an Amazon-Chime-Chatrooms gesendet werden. Sie können dann das Amazon-SNS-Thema auswählen, das für diesen AWS-Chatbot-Client als Ziel für die Benachrichtigungsregel konfiguriert ist. Weitere Informationen finden Sie unter So integrieren Sie Benachrichtigungen in AWS Chatbot und Amazon Chime.
Wenn Sie einen AWS-Chatbot-Client als Ziel verwenden möchten, müssen Sie diesen Client zuerst in AWS Chatbot erstellen. Wenn Sie einen AWS-Chatbot-Client als Ziel für eine Benachrichtigungsregel auswählen, wird für diesen AWS-Chatbot-Client ein Amazon-SNS-Thema mit allen Richtlinien konfiguriert, die für das Senden von Benachrichtigungen an den Slack- oder Microsoft Teams-Kanal erforderlich sind. Sie müssen keine vorhandenen Amazon-SNS-Themen für den AWS-Chatbot-Client konfigurieren.
Sie können beim Erstellen einer Benachrichtigungsregel ein Amazon-SNS-Thema als Ziel erstellen (empfohlen). Sie können auch ein vorhandenes Amazon-SNS-Thema in derselben AWS-Region wie die Benachrichtigungsregel auswählen, müssen es aber mit der erforderlichen Richtlinie konfigurieren. Das Amazon-SNS-Thema, das Sie für ein Ziel verwenden, muss sich in Ihrem AWS-Konto befinden. Es muss sich auch in derselben AWS-Region befinden wie die Benachrichtigungsregel und die AWS-Ressource, für die die Regel erstellt wurde.
Wenn Sie beispielsweise eine Benachrichtigungsregel für ein Repository in der Region USA Ost (Ohio) erstellen, muss das Amazon-SNS-Thema auch in dieser Region vorhanden sein. Wenn Sie ein Amazon-SNS-Thema im Rahmen des Erstellens einer Benachrichtigungsregel erstellen, wird das Thema mit der erforderlichen Richtlinie konfiguriert, um die Veröffentlichung von Ereignissen für das Thema zu ermöglichen. Dies ist die beste Methode, um mit Zielen und Benachrichtigungsregeln zu arbeiten. Wenn Sie ein bereits vorhandenes Thema verwenden oder ein Thema manuell erstellen möchten, müssen Sie es mit den erforderlichen Berechtigungen konfigurieren. Erst dann erhalten Benutzer Benachrichtigungen. Weitere Informationen finden Sie unter Konfigurieren von Amazon-SNS-Themen für Benachrichtigungen.
Anmerkung
Wenn Sie ein vorhandenes Amazon-SNS-Thema verwenden möchten, anstatt ein neues zu erstellen, wählen Sie unter Targets (Ziele), dessen ARN aus. Stellen Sie sicher, dass das Thema über die entsprechende Zugriffsrichtlinie verfügt und Abonnentenliste nur die Benutzer enthält, denen Informationen zur Ressource angezeigt werden dürfen. Wenn das Amazon-SNS-Thema vor dem 5. November 2019 für CodeCommit-Benachrichtigungen verwendet wurde, enthält es eine Richtlinie, die es CodeCommit ermöglicht, darin zu veröffentlichen, und die andere Berechtigungen enthält als die für AWS CodeStar Notifications erforderlichen. Das Verwenden dieser Themen wird nicht empfohlen. Wenn Sie ein für jene Erfahrung erstelltes Thema verwenden möchten, müssen Sie die für AWS CodeStar Notifications erforderliche Richtlinie ergänzend zu der bereits vorhandenen Richtlinie hinzufügen. Weitere Informationen finden Sie unter Konfigurieren von Amazon-SNS-Themen für Benachrichtigungen und Grundlagen zu Benachrichtigungsinhalten und -sicherheit.
Benachrichtigungen und AWS CodeStar Notifications
Benachrichtigungen sind zwar Teil der Funktionen der Entwicklertools-Konsole, verfügen jedoch über eine eigene API: AWS CodeStar Notifications. Darüber hinaus verfügt sie über einen eigenen AWS-Ressourcentyp (Benachrichtigungsregeln), Berechtigungen und Ereignisse. Ereignisse für Benachrichtigungsregeln werden in AWS CloudTrail protokolliert. API-Aktionen können über IAM-Richtlinien erlaubt oder verweigert werden.
Ereignisse für Benachrichtigungsregeln für Repositorys
| Kategorie | Ereignisse | Ereignis-IDs |
|---|---|---|
|
Kommentare |
Auf Commits Auf Pull-Anforderungen |
|
| Genehmigungen |
Status geändert Regelüberschreibung |
|
|
Pull-Anforderung |
Erstellt Quelle aktualisiert Status geändert Zusammengeführt |
|
|
Zweige und Tags |
Erstellt Deleted (Gelöscht) Aktualisiert |
codecommit-repository-branches-and-tags-updated |
Ereignisse für Benachrichtigungsregeln für Build-Projekte
| Kategorie | Ereignisse | Ereignis-IDs |
|---|---|---|
|
Status des Builds |
Fehlgeschlagen Erfolgreich In Bearbeitung Angehalten |
|
|
Build-Phase |
Fehler Herzlichen Glückwunsch |
|
Ereignisse für Benachrichtigungsregeln für Bereitstellungsanwendungen
| Kategorie | Ereignisse | Ereignis-IDs |
|---|---|---|
|
Bereitstellung |
Fehlgeschlagen Erfolgreich Started |
codedeploy-application-deployment-started |
Ereignisse für Benachrichtigungsregeln für Pipelines
| Kategorie | Ereignisse | Ereignis-IDs |
|---|---|---|
|
Aktionsausführung |
Erfolgreich Fehlgeschlagen Canceled Started |
|
|
Phasenausführung |
Started Erfolgreich Fortgesetzt Canceled Fehlgeschlagen |
|
|
Pipeline-Ausführung |
Fehlgeschlagen Canceled Started Fortgesetzt Erfolgreich Ersetzt |
|
|
Manuelle Genehmigung |
Fehlgeschlagen Erforderlich Erfolgreich |
codepipeline-pipeline-manual-approval-succeeded |
