EventBridgeRule

El objeto que describe unEventBridgeRuleel tipo de origen de eventos, que establece la función sin servidor como destino de una regla de Amazon EventBridge. Para obtener más información, consulte¿Qué es Amazon EventBridge?en laGuía del usuario de Amazon EventBridge.

AWS SAMgenera unAWS::Events::Rulerecurso cuando se establece este tipo de evento.

Sintaxis

Para declarar esta entidad en suAWS Serverless Application Model(AWS SAM), utilice la siguiente sintaxis.

YAML

  DeadLetterConfig: DeadLetterConfig
  EventBusName: String
  Input: String
  InputPath: String
  Pattern: EventPattern
  RetryPolicy: RetryPolicy
  Target: Target

Properties

DeadLetterConfig

Configurar la cola de Amazon Simple Queue Service (Amazon SQS) a la que EventBridge envía eventos tras una invocación de destino fallida. La invocación puede fallar, por ejemplo, al enviar un evento a una función de Lambda que no existe o cuando EventBridge no tiene permisos suficientes para invocar la función Lambda. Para obtener más información, consultePolítica de reintentos de eventos y uso de colas fallidosen laGuía del usuario de Amazon EventBridge.

Nota: LaAWS::Serverless::Functionel tipo de recurso tiene un tipo de datos similar,DeadLetterQueue, que controla los errores que se producen tras la invocación correcta de la función Lambda objetivo. Algunos ejemplos de estos tipos de errores incluyen la limitación de Lambda o los errores devueltos por la función de destino de Lambda. Para obtener más información sobre la funciónDeadLetterQueuepropiedad, véaseAWS LambdaColas de mensajes fallidos de funciones deen laAWS LambdaGuía para desarrolladores.

Type: DeadLetterConfig

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad es similar a laDeadLetterConfigpropiedad delAWS::Events::Rule TargetTipos de LaAWS SAMversión de esta propiedad incluye subpropiedades adicionales, en caso de que lo deseeAWS SAMpara crear la cola de letras fallidas para usted.

EventBusName

El bus de eventos que se asociará a esta regla. Si omite esta propiedad,AWS SAMutiliza el bus de eventos predeterminado.

Type: Cadena

Obligatorio: No

Valor predeterminado: Bus de eventos predeterminado

AWS CloudFormationcompatibilidad: Esta propiedad se transfiere directamente alEventBusNamepropiedad de unAWS::Events::Rulerecurso.

Input

Texto JSON válido transmitido al destino. Si utiliza esta propiedad, no se transmite al destino nada del propio evento.

Type: Cadena

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad se transfiere directamente alInputpropiedad de unAWS::Events::Rule Targetrecurso.

InputPath

Si no desea transferir todo el evento relacionado al destino, utilice elInputPathpropiedad para describir qué parte del evento aprobar.

Type: Cadena

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad se transfiere directamente alInputPathpropiedad de unAWS::Events::Rule Targetrecurso.

Pattern

Describe qué eventos se direccionan al destino especificado. Para obtener más información, consulte Eventos y patrones de eventos en EventBridge en la Guía del usuario de Amazon EventBridge.

Type: EventPattern

Obligatorio: Sí

AWS CloudFormationcompatibilidad: Esta propiedad se transfiere directamente alEventPatternpropiedad de unAWS::Events::Rulerecurso.

RetryPolicy

Objeto RetryPolicy que incluye información acerca de la configuración de la política de reintentos. Para obtener más información, consultePolítica de reintentos de eventos y uso de colas fallidosen laGuía del usuario de Amazon EventBridge.

Type: RetryPolicy

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad se transfiere directamente alRetryPolicypropiedad delAWS::Events::Rule TargetTipos de

Target

LaAWSrecurso que EventBridge invoca cuando se desencadena una regla. Puede utilizar esta propiedad para especificar el ID lógico del destino. Si no se especifica esta propiedad,AWS SAMgenera el ID lógico del destino.

Type: Target

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad es similar a laTargetspropiedad de unAWS::Events::Rulerecurso. LaAWS SAMversión de esta propiedad solo permite especificar el ID lógico de un único destino.

Ejemplos

Evento Bridge Regla

A continuación se muestra un ejemplo deEventBridgeRuletipo de origen de evento.

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