EventBridgeRule

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

AWS SAM genera un AWS::Events::Rulerecurso cuando se establece este tipo de evento.

Sintaxis

Para declarar esta entidad en tu plantilla AWS Serverless Application Model (AWS SAM), usa la siguiente sintaxis.

YAML

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

Propiedades

DeadLetterConfig

Configure la cola del Amazon Simple Queue Service (Amazon SQS), desde la que EventBridge se envían 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 EventBridge cuando no hay permisos suficientes para invocar la función de Lambda. Para obtener más información, consulta la política de reintentos de eventos y el uso de colas con letra muerta 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, consulte Colas de mensajes fallidos en la Guía para desarrolladores de AWS Lambda .

Tipo: DeadLetterConfig

Obligatorio: no

AWS CloudFormation compatibilidad: esta propiedad es similar a la DeadLetterConfig propiedad del tipo de AWS::Events::Rule Target datos. La AWS SAM versión de esta propiedad incluye subpropiedades adicionales, por si AWS SAM quiere crear automáticamente una cola de texto sin procesar.

EventBusName

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

Tipo: cadena

Obligatorio: no

Predeterminado: bus de eventos predeterminado

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la EventBusName propiedad de un AWS::Events::Rule recurso.

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

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la Input propiedad de un AWS::Events::Rule Target recurso.

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

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la InputPath propiedad de un AWS::Events::Rule Target recurso.

InputTransformer

Configuración que permite proporcionar una entrada personalizada a un destino en función de determinados datos de eventos. Puede 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 la transformación EventBridge de entradas de Amazon en la Guía del EventBridge usuario de Amazon.

Tipo: InputTransformer

Obligatorio: no

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la InputTransformer propiedad de un tipo de AWS::Events::Rule Target datos.

Pattern

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

Tipo: EventPattern

Obligatorio: sí

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la EventPattern propiedad de un AWS::Events::Rule recurso.

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 la política de reintentos de eventos y el uso de colas con letra muerta en la Guía del usuario de Amazon. EventBridge

Tipo: RetryPolicy

Obligatorio: no

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la RetryPolicy propiedad del tipo de AWS::Events::Rule Target datos.

RuleName

El nombre de la regla.

Tipo: cadena

Obligatorio: no

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la Name propiedad de un AWS::Events::Rule recurso.

State

El estado de la regla.

Valores aceptados: DISABLED | ENABLED

Tipo: cadena

Obligatorio: no

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la State propiedad de un AWS::Events::Rule recurso.

Target

El AWS recurso que se EventBridge invoca cuando se activa una regla. Puede 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

AWS CloudFormation compatibilidad: esta propiedad es similar a la Targets propiedad de un AWS::Events::Rule recurso. 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