EventBridgeRule

L'objet décrivant un type de source d'EventBridgeRuleévénement, qui définit votre fonction sans serveur comme cible d'une EventBridge règle Amazon. Pour plus d'informations, consultez Qu'est-ce qu'Amazon EventBridge ? dans le guide de EventBridge l'utilisateur Amazon.

AWS SAM génère un AWS::Events::Ruleressource lorsque ce type d'événement est défini. AWS SAM crée également une AWS::Lambda::Permission ressource, qui est nécessaire pour appeler Lambda. EventBridgeRule

Syntaxe

Pour déclarer cette entité dans votre AWS Serverless Application Model (AWS SAM) modèle, utilisez la syntaxe suivante.

YAML

  DeadLetterConfig: DeadLetterConfig
  EventBusName: String
  Input: String
  InputPath: String
  InputTransformer: InputTransformer
  Pattern: EventPattern
  RetryPolicy: RetryPolicy
  RuleName: String 
  State: String
  Target: Target

Propriétés

DeadLetterConfig

Configurez la file d'attente Amazon Simple Queue Service (AmazonSQS) où EventBridge envoie les événements après l'échec d'un appel cible. L'invocation peut échouer, par exemple, lors de l'envoi d'un événement à une fonction Lambda qui n'existe pas ou EventBridge lorsque les autorisations sont insuffisantes pour appeler la fonction Lambda. Pour plus d'informations, consultez la politique relative aux nouvelles tentatives relatives aux événements et l'utilisation des files d'attente contenant des lettres mortes dans le guide de l'utilisateur Amazon. EventBridge

Note

Le type de ressource AWS::Serverless::Function a un type de données similaire, DeadLetterQueue, qui gère les échecs qui se produisent après l'invocation réussie de la fonction Lambda cible. Des exemples de ces types d'échecs incluent la limitation Lambda, ou les erreurs renvoyées par la fonction cible Lambda. Pour plus d'informations sur la DeadLetterQueue propriété de la fonction, voir les files d'attente contenant des lettres mortes dans le AWS Lambda Guide du développeur.

Type : DeadLetterConfig

Obligatoire : non

AWS CloudFormation compatibilité  : cette propriété est similaire à celle du type de AWS::Events::Rule Target données. DeadLetterConfig Le AWS SAM la version de cette propriété inclut des sous-propriétés supplémentaires, au cas où vous le souhaiteriez AWS SAM pour créer pour vous la file d'attente des lettres mortes.

EventBusName

Le bus d'événements à associer à cette règle. Si vous omettez cette propriété, AWS SAM utilise le bus d'événements par défaut.

Type : chaîne

Obligatoire : non

Par défaut : bus d'événement par défaut

AWS CloudFormation compatibilité  : cette propriété est transmise directement à la EventBusName propriété d'une AWS::Events::Rule ressource.

Input

JSONTexte valide transmis à la cible. Si vous utilisez cette propriété, aucun élément du texte de l'événement lui-même n'est transmis à la cible.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité  : cette propriété est transmise directement à la Input propriété d'une AWS::Events::Rule Target ressource.

InputPath

Lorsque vous ne voulez pas transmettre l'événement correspondant complet, utilisez la propriété InputPath pour décrire quelles parties de l'événement transmettre à la cible.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité  : cette propriété est transmise directement à la InputPath propriété d'une AWS::Events::Rule Target ressource.

InputTransformer

Paramètres qui vous permettent de fournir une entrée personnalisée à une cible en fonction de certaines données d'événement. Vous pouvez extraire une ou plusieurs paires clé-valeur à partir de l'événement, puis utiliser ces données pour envoyer l'entrée personnalisée à la cible. Pour plus d'informations, consultez la section Transformation des EventBridge entrées Amazon dans le guide de EventBridge l'utilisateur Amazon.

Type : InputTransformer

Obligatoire : non

AWS CloudFormation compatibilité  : cette propriété est transmise directement à la InputTransformer propriété d'un type de AWS::Events::Rule Target données.

Pattern

Décrit les événements qui sont acheminés vers la cible spécifiée. Pour plus d'informations, consultez les EventBridgeévénements Amazon et les modèles EventBridge d'événements dans le guide de EventBridge l'utilisateur Amazon.

Type : EventPattern

Obligatoire : oui

AWS CloudFormation compatibilité  : cette propriété est transmise directement à la EventPattern propriété d'une AWS::Events::Rule ressource.

RetryPolicy

Objet RetryPolicy qui inclut des informations sur les paramètres de politique de nouvelle tentative. Pour plus d'informations, consultez la politique relative aux nouvelles tentatives relatives aux événements et l'utilisation des files d'attente contenant des lettres mortes dans le guide de l'utilisateur Amazon. EventBridge

Type : RetryPolicy

Obligatoire : non

AWS CloudFormation compatibilité  : cette propriété est transmise directement à la RetryPolicy propriété du type de AWS::Events::Rule Target données.

RuleName

Le nom de la règle .

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité  : cette propriété est transmise directement à la Name propriété d'une AWS::Events::Rule ressource.

State

État de la règle.

Valeurs acceptées : DISABLED | ENABLED

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité  : cette propriété est transmise directement à la State propriété d'une AWS::Events::Rule ressource.

Target

Le AWS ressource qui EventBridge invoque lorsqu'une règle est déclenchée. Vous pouvez utiliser cette propriété pour spécifier l'ID logique de la cible. Si cette propriété n'est pas spécifiée, alors AWS SAM génère l'ID logique de la cible.

Type : cible

Obligatoire : non

AWS CloudFormation compatibilité  : cette propriété est similaire à celle Targets d'une AWS::Events::Rule ressource. Amazon EC2 RebootInstances API callest un exemple de propriété cible. Le AWS SAM La version de cette propriété vous permet uniquement de spécifier l'ID logique d'une seule cible.

Exemples

EventBridgeRule

Voici un exemple de type de source d'événement EventBridgeRule.

YAML

EBRule:
  Type: EventBridgeRule
  Properties:
    Input: '{"Key": "Value"}'
    Pattern:
      detail:
        state:
          - terminated
    RetryPolicy:
      MaximumRetryAttempts: 5
      MaximumEventAgeInSeconds: 900
    DeadLetterConfig:
      Type: SQS
      QueueLogicalId: EBRuleDLQ
    Target:
      Id: MyTarget