EventBridgeRule - AWS Serverless Application Model
SintaxisPropiedadesEjemplos

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

EventBridgeRule

El objeto describe un tipo de fuente de eventos EventBridgeRule, que establece su función sin servidor objetivo de una regla de Amazon EventBridge. Para obtener más información, consulta ¿Qué es Amazon EventBridge? en la Guía del usuario de Amazon EventBridge.

AWS SAM genera un recurso AWS::Events::Rule cuando se establece este tipo de evento. AWS SAM también crea un recurso AWS::Lambda::Permission, que es necesario para que la EventBridgeRule pueda llamar a Lambda.

Sintaxis

Para declarar esta entidad en su plantilla de AWS Serverless Application Model (AWS SAM), usa la siguiente sintaxis:

Propiedades

DeadLetterConfig

Configura la cola de Amazon Simple Queue Service (Amazon SQS) en la que EventBridge envía los eventos tras una invocación de destino fallida. La invocación puede fallar, por ejemplo, cuando se envía un evento a una función de Lambda que no existe, o cuando EventBridge tiene permisos insuficientes para invocar la función de Lambda. Para obtener más información, consulta Política de reintentos de eventos y uso de colas de mensajes fallidos en la Guía del usuario de Amazon EventBridge.

nota

El tipo de recurso AWS::Serverless::Function tiene un tipo de datos similar, DeadLetterQueue, que gestiona los errores que se producen tras la invocación correcta de la función de Lambda de destino. Entre los ejemplos de estos tipos de errores se 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 propiedad DeadLetterQueue de la función, consulta Colas de mensajes fallidos en la Guía para desarrolladores de AWS Lambda.

Tipo: DeadLetterConfig

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad es similar a la propiedad DeadLetterConfig del tipo de datos AWS::Events::Rule Target. La versión AWS SAM de esta propiedad incluye subpropiedades adicionales, en caso de que desee que AWS SAM cree automáticamente una cola de mensajes fallidos.

EventBusName

El bus de eventos que se asociará a esta regla. Si omites esta propiedad, AWS SAM utilizará el bus de eventos predeterminado.

Tipo: cadena

Obligatorio: no

Predeterminado: bus de eventos predeterminado

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad EventBusName de un recurso AWS::Events::Rule.

Input

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

Tipo: cadena

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad Input de un recurso AWS::Events::Rule Target.

InputPath

Cuando no desee pasar todo el evento coincidente al destino, utilice la propiedad InputPath para describir qué parte del evento pasar.

Tipo: cadena

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad InputPath de un recurso de AWS::Events::Rule Target.

InputTransformer

Configuración que permite proporcionar una entrada personalizada a un destino en función de determinados datos de eventos. Puedes extraer uno o más pares clave-valor del evento y, a continuación, utilizar dichos datos para enviar una entrada personalizada al destino. Para obtener más información, consulta transformación de entrada de Amazon EventBridge en la Guía del usuario de Amazon EventBridge.

Tipo: InputTransformer

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad pasa directamente a la propiedad InputTransformer del tipo de datos Target de AWS::Events::Rule.

Pattern

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

Tipo: EventPattern

Obligatorio: sí

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad EventPattern de un recurso AWS::Events::Rule.

RetryPolicy

Objeto de la RetryPolicy que incluye información acerca de la configuración de la política de reintentos. Para obtener más información, consulta Política de reintentos de eventos y uso de colas de mensajes fallidos en la Guía del usuario de Amazon EventBridge.

Tipo: RetryPolicy

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad RetryPolicy del tipo de datos AWS::Events::Rule Target.

RuleName

El nombre de la regla.

Tipo: cadena

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad Name de un recurso AWS::Events::Rule.

State

El estado de la regla.

Valores aceptados: DISABLED | ENABLED | ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS

Tipo: cadena

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad State de un recurso de AWS::Events::Rule.

Target

El recurso AWS que EventBridge invoca cuando se activa una regla. Puedes utilizar esta propiedad para especificar el ID lógico del objetivo. Si no se especifica esta propiedad, AWS SAM genera el ID lógico del objetivo.

Tipo: destino

Obligatorio: no

Compatibilidad de CloudFormation: esta propiedad es similar a la propiedad Targets de un recurso AWS::Events::Rule. Amazon EC2 RebootInstances API call es un ejemplo de una propiedad de destino. La versión AWS SAM de esta propiedad solo permite especificar el identificador lógico de un único destino.

Ejemplos

EventBridgeRule

A continuación, se muestra un ejemplo de un tipo de fuente de evento 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