Schedule

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

AWS Serverless Application Model(AWS SAM) genera 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
  Description: String
  Enabled: Boolean
  Input: String
  Name: String
  RetryPolicy: RetryPolicy
  Schedule: String

Properties

DeadLetterConfig

Configurar la cola de Amazon Simple Queue Service (Amazon SQS) en 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 de 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 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 datos de. LaAWS SAMversión de esta propiedad incluye subpropiedades adicionales, en caso de que lo deseeAWS SAMpara crear la cola de cartas fallidas por usted.

Description

Una descripción de la regla.

Type: Cadena

Obligatorio: No

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

Enabled

Indica si la regla está habilitada.

Para deshabilitar la regla, establezca esta propiedad enfalse.

Type: Booleano

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad es similar a laStatepropiedad de unAWS::Events::Rulerecurso. Si esta propiedad está establecida entruethenAWS SAMpasesENABLED, de lo contrario pasaDISABLED.

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 alTargetpropiedad de unAWS::Events::Rule Targetrecurso.

Name

El nombre de la regla. Si no especifica un nombre, AWS CloudFormation genera un único ID físico y utiliza el ID para el nombre de la regla.

Type: Cadena

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad se transfiere directamente alNamepropiedad 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 de 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 datos de.

Schedule

La expresión de programación que determina cuándo y con qué frecuencia se ejecuta la regla. Para obtener más información, consulte Expresiones de programación para reglas.

Type: Cadena

Obligatorio: Sí

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

Ejemplos

Evento de CloudWatch

Ejemplo de Evento de CloudWatch

YAML

CWSchedule:
  Type: Schedule
  Properties:
    Schedule: 'rate(1 minute)'
    Name: TestSchedule
    Description: test schedule
    Enabled: false