API-Ziele als Ziele in Amazon EventBridge

EventBridge API-Ziele sind HTTPS-Endpunkte, die Sie als Ziel einer Event-Bus-Regel oder Pipe aufrufen können, ähnlich wie Sie einen AWS Dienst oder eine Ressource als Ziel aufrufen. Mithilfe von API-Zielen können Sie Ereignisse mithilfe von API-Aufrufen zwischen AWS Diensten, integrierten Software-as-a-Service (SaaS) -Anwendungen und öffentlichen oder privaten Anwendungen weiterleiten.

Wenn Sie ein API-Ziel als Regel oder Pipe-Ziel angeben, EventBridge ruft es den HTTPS-Endpunkt für jedes Ereignis auf, das dem in der Regel oder Pipe angegebenen Ereignismuster entspricht, und übermittelt dann die Ereignisinformationen zusammen mit der Anfrage. Mit EventBridge können Sie jede HTTP-Methode außer CONNECT und TRACE für die Anfrage verwenden. Die am häufigsten verwendeten HTTP-Methoden sind PUT und POST.

Sie können auch Eingabe-Transformatoren verwenden, um das Ereignis an die Parameter bestimmter HTTP-Endpunktparameter anzupassen. Weitere Informationen finden Sie unter Transformation Amazon EventBridge Amazon-Eingaben.

EventBridge API-Ziele verwenden Verbindungen, um die Autorisierungsmethode und die Anmeldeinformationen sowie die Netzwerkkonnektivität EventBridge zu definieren, die verwendet werden sollen, wenn eine Verbindung zu einem bestimmten HTTPS-Endpunkt hergestellt wird. Verbindungen unterstützen sowohl öffentliche als auch private Verbindungen APIs. Weitere Informationen finden Sie unter Verbindungen.

Das folgende Video zeigt die Verwendung des API-Ziels:

Serviceverknüpfte Rolle für API-Ziele

Wenn Sie eine Verbindung für ein API-Ziel herstellen, AWS ServiceRoleForAmazonEventBridgeApiDestinationswird Ihrem Konto eine dienstbezogene Rolle mit dem Namen hinzugefügt. EventBridge verwendet die dienstverknüpfte Rolle, um ein Geheimnis in Secrets Manager zu erstellen und zu speichern. Um der dienstbezogenen Rolle die erforderlichen Berechtigungen zu gewähren, hängt die EventBridge AmazonEventBridgeApiDestinationsServiceRolePolicyRichtlinie an die Rolle an. Die Richtlinie beschränkt die gewährten Berechtigungen auf diejenigen, die für die Interaktion der Rolle mit dem Secret für die Verbindung erforderlich sind. Es sind keine weiteren Berechtigungen enthalten und die Rolle kann nur mit den Verbindungen in Ihrem Konto interagieren, um das Secret zu verwalten.

Die folgende Richtlinie ist die AmazonEventBridgeApiDestinationsServiceRolePolicy.

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "secretsmanager:CreateSecret",
                "secretsmanager:UpdateSecret",
                "secretsmanager:DescribeSecret",
                "secretsmanager:DeleteSecret",
                "secretsmanager:GetSecretValue",
                "secretsmanager:PutSecretValue"
            ],
            "Resource": "arn:aws:secretsmanager:*:*:secret:events!connection/*"
        }
    ]
}

Weitere Informationen zu serviceverknüpften Rollen finden Sie unter Verwenden serviceverknüpfter Rollen im IAM-Benutzerhandbuch.

Verfügbarkeit in Regionen

Die AmazonEventBridgeApiDestinationsServiceRolePolicy dienstbezogene Rolle wird in den folgenden Regionen unterstützt: AWS

Header in Anforderungen an API-Ziele

Im folgenden Abschnitt wird beschrieben, wie HTTP-Header in Anfragen an API-Ziele EventBridge behandelt werden.

Header, die in Anforderungen an API-Ziele enthalten sind

EventBridge Enthält zusätzlich zu den Autorisierungsheadern, die für die Verbindung definiert sind, die für ein API-Ziel verwendet wird, die folgenden Header in jeder Anfrage.

Header, die in Anforderungen an API-Ziele nicht überschrieben werden können

EventBridge erlaubt es Ihnen nicht, die folgenden Header zu überschreiben:

Headers EventBridge werden aus Anfragen an API-Ziele entfernt

EventBridge entfernt die folgenden Header für alle API-Zielanfragen:

Fehlercodes für das API-Ziel

Wenn EventBridge versucht wird, ein Ereignis an ein API-Ziel zu senden, und ein Fehler auftritt, EventBridge geht Folgendes vor:

EventBridge API-Ziele lesen den Standard-HTTP-Antwort-HeaderRetry-After, um herauszufinden, wie lange gewartet werden muss, bevor eine Folgeanfrage gestellt wird. EventBridgeWählt für Event-Busse den konservativeren Wert zwischen der definierten Wiederholungsrichtlinie und dem Retry-After Header. Wenn der Retry-After Wert negativ ist, wird der erneute Zustellversuch für dieses Ereignis EventBridge beendet.

Wie wirkt sich die Aufrufrate auf die Ereigniszustellung aus

Wenn Sie die Aufrufrate pro Sekunde auf einen Wert festlegen, der deutlich unter der Anzahl der generierten Aufrufe liegt, werden Ereignisse möglicherweise nicht innerhalb der 24-stündigen Wiederholungszeit für Ereignisse zugestellt. Wenn Sie beispielsweise die Aufrufrate auf 10 Aufrufe pro Sekunde festlegen, aber Tausende von Ereignissen pro Sekunde generiert werden, entsteht schnell ein Backlog an zuzustellenden Ereignissen, der 24 Stunden überschreitet. Wenn Sie sicherstellen möchten, dass keine Ereignisse verloren gehen, richten Sie eine Warteschlange für unzustellbare Nachrichten ein, an die Ereignisse mit fehlgeschlagenen Aufrufen gesendet werden, sodass Sie die Ereignisse zu einem späteren Zeitpunkt verarbeiten können. Weitere Informationen finden Sie unter Verwenden von Warteschlangen mit unzugestellten Nachrichten zur Verarbeitung nicht zugestellter Ereignisse in EventBridge.