EventBridgeRule

L'objet décrivant un type de source d'EventBridgeRuleévénement, qui définit votre machine d'état comme cible pour 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 une AWS::Events::Ruleressource lorsque ce type d'événement est défini.

Syntaxe

Pour déclarer cette entité dans votre modèle AWS Serverless Application Model (AWS SAM), 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 (Amazon SQS) dans EventBridge laquelle les événements sont envoyés 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

Type : DeadLetterConfig

Obligatoire : non

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

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

Texte JSON 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 la section Événements et modèles d'événements EventBridge 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 valides : [ 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

La AWS ressource qui est EventBridge invoquée 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, 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. La version AWS SAM 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