Destinations d'API en tant que cibles sur Amazon EventBridge

EventBridge Les destinations d'API sont des points de terminaison HTTPS que vous pouvez invoquer comme cible d'une règle ou d'un canal de bus d'événements, de la même manière que vous appelez un AWS service ou une ressource en tant que cible. À l'aide des destinations d'API, vous pouvez acheminer des événements entre AWS des services, des applications logicielles intégrées en tant que service (SaaS) et des applications publiques ou privées à l'aide d'appels d'API.

Lorsque vous spécifiez une destination d'API en tant que règle ou cible de canal, EventBridge invoque le point de terminaison HTTPS pour tout événement correspondant au modèle d'événement spécifié dans la règle ou le canal, puis fournit les informations relatives à l'événement avec la demande. Avec EventBridge, vous pouvez utiliser n'importe quelle méthode HTTP sauf CONNECT et TRACE pour la requête. Les méthodes HTTP les plus couramment utilisées sont PUT et POST.

Vous pouvez également utiliser des transformateurs d’entrée pour personnaliser l’événement en fonction des paramètres d’un point de terminaison HTTP spécifique. Pour de plus amples informations, veuillez consulter Transformation des EventBridge entrées Amazon.

EventBridge Les destinations d'API utilisent des connexions pour définir la méthode d'autorisation, les informations d'identification et la connectivité réseau EventBridge à utiliser lors de la connexion à un point de terminaison HTTPS donné. Les connexions sont à la fois publiques et privées APIs. Pour de plus amples informations, veuillez consulter Connexions.

La vidéo suivante montre l’utilisation de la destination d’API :

Rôle lié à un service pour les destinations d’API

Lorsque vous créez une connexion pour une destination d'API, un rôle lié à un service nommé AWS ServiceRoleForAmazonEventBridgeApiDestinationsest ajouté à votre compte. EventBridge utilise le rôle lié au service pour créer et stocker un secret dans Secrets Manager. Pour accorder les autorisations nécessaires au rôle lié au service, associez EventBridge la AmazonEventBridgeApiDestinationsServiceRolePolicypolitique au rôle. La politique limite les autorisations accordées aux autorisations nécessaires pour que le rôle interagisse avec le secret de la connexion. Aucune autre autorisation n’est incluse et le rôle ne peut interagir qu’avec les connexions de votre compte pour gérer le secret.

La politique suivante est 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/*"
        }
    ]
}

Pour plus d’informations sur l’utilisation des rôles liés à un service, consultez Utilisation des rôles liés à un service dans le Guide de l’utilisateur IAM.

Disponibilité dans les Régions

Le rôle AmazonEventBridgeApiDestinationsServiceRolePolicy lié à un service est pris en charge dans les régions suivantes : AWS

En-têtes dans les demandes adressées aux destinations d’API

La section suivante explique comment EventBridge gérer les en-têtes HTTP dans les demandes adressées aux destinations d'API.

En-têtes inclus dans les demandes adressées aux destinations d’API

Outre les en-têtes d'autorisation définis pour la connexion utilisée pour une destination d'API, EventBridge inclut les en-têtes suivants dans chaque demande.

En-têtes qui ne peuvent pas être remplacés dans les demandes adressées aux destinations d’API

EventBridge ne vous permet pas de remplacer les en-têtes suivants :

Les en-têtes sont EventBridge supprimés des demandes destinées aux destinations de l'API

EventBridge supprime les en-têtes suivants pour toutes les demandes de destination d'API :

Codes d’erreur de destination d’API

Lorsque EventBridge vous essayez de transmettre un événement à une destination d'API et qu'une erreur se produit EventBridge, procédez comme suit :

EventBridge Les destinations d'API lisent l'en-tête de réponse HTTP standard Retry-After pour savoir combien de temps il faut attendre avant de faire une demande de suivi. Pour les bus d'événements, EventBridge choisit la valeur la plus prudente entre la politique de réessai définie et l'Retry-Afteren-tête. Si Retry-After la valeur est négative, EventBridge arrête toute nouvelle tentative de livraison pour cet événement.

Comment le taux d’invocation affecte la livraison d’événements

Si vous définissez le taux d’invocation par seconde sur une valeur bien inférieure au nombre d’invocations générées, les événements peuvent ne pas être livrés dans le délai de 24 heures imparti pour les nouvelles tentatives. Par exemple, si vous définissez le taux d’invocation sur 10 invocations par seconde, mais que des milliers d’événements sont générés par seconde, votre retard au niveau des événements à livrer dépassera rapidement 24 heures. Pour vous assurer qu’aucun événement n’est perdu, configurez une file d’attente de lettres mortes à laquelle envoyer les événements dont les invocations ont échoué afin de pouvoir les traiter ultérieurement. Pour de plus amples informations, veuillez consulter Utilisation de files d'attente de lettres mortes pour traiter les événements non livrés dans EventBridge.