Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
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 un 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:DeadLetterConfigEventBusName:StringInput:StringInputPath:StringInputTransformer:InputTransformerPattern:EventPatternRetryPolicy:RetryPolicyRuleName:StringState:StringTarget: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
CloudFormation compatibilité : cette propriété est similaire à celle du type de
AWS::Events::RuleTargetdonnées.DeadLetterConfigLa 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
CloudFormation compatibilité : cette propriété est transmise directement à la
EventBusNamepropriété d'uneAWS::Events::Ruleressource. -
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
CloudFormation compatibilité : cette propriété est transmise directement à la
Inputpropriété d'uneAWS::Events::Rule Targetressource. -
InputPath -
Lorsque vous ne voulez pas transmettre l'événement correspondant complet, utilisez la propriété
InputPathpour décrire quelles parties de l'événement transmettre à la cible.Type : chaîne
Obligatoire : non
CloudFormation compatibilité : cette propriété est transmise directement à la
InputPathpropriété d'uneAWS::Events::Rule Targetressource. 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
CloudFormation compatibilité : cette propriété est transmise directement à la
InputTransformerpropriété d'un type deAWS::Events::RuleTargetdonné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
CloudFormation compatibilité : cette propriété est transmise directement à la
EventPatternpropriété d'uneAWS::Events::Ruleressource. -
RetryPolicy -
Objet
RetryPolicyqui 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. EventBridgeType : RetryPolicy
Obligatoire : non
CloudFormation compatibilité : cette propriété est transmise directement à la
RetryPolicypropriété du type deAWS::Events::RuleTargetdonnées. -
RuleName -
Le nom de la règle .
Type : chaîne
Obligatoire : non
CloudFormation compatibilité : cette propriété est transmise directement à la
Namepropriété d'uneAWS::Events::Ruleressource. State-
État de la règle.
Valeurs valides :
[ DISABLED | ENABLED ]Type : chaîne
Obligatoire : non
CloudFormation compatibilité : cette propriété est transmise directement à la
Statepropriété d'uneAWS::Events::Ruleressource. -
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
CloudFormation compatibilité : cette propriété est similaire à celle
Targetsd'uneAWS::Events::Ruleressource. 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