Schedule

El objeto que describe un tipo de origen de eventos Schedule, que establece su función sin servidor como el destino de una regla de Amazon EventBridge que se activa de forma programada. Para obtener más información, consulte ¿Qué es Amazon EventBridge? en la Guía del usuario de Amazon EventBridge.

AWS Serverless Application Model (AWS SAM) genera un recurso AWS::Events::Rule cuando se establece este tipo de evento.

nota

EventBridge ahora ofrece una nueva capacidad de programación, Amazon EventBridge Scheduler. El Scheduler de Amazon EventBridge es un programador sin servidor que le permite crear, ejecutar y administrar tareas desde un servicio administrado y centralizado. El Scheduler de EventBridge es altamente personalizable y ofrece una escalabilidad mejorada en comparación con las reglas programadas de EventBridge, con un conjunto más amplio de operaciones de la API de destino y Servicios de AWS.

Se recomienda utilizar el Scheduler de EventBridge para invocar los destinos en un programa. Para definir este tipo de origen de eventos en sus plantillas de AWS SAM, consulte ScheduleV2.

Sintaxis

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

YAML

  DeadLetterConfig: DeadLetterConfig
  Description: String
  Enabled: Boolean
  Input: String
  Name: String
  RetryPolicy: RetryPolicy
  Schedule: String
  State: String

Propiedades

DeadLetterConfig

Configure 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, consulte 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, consulte Colas de mensajes fallidos en la Guía para desarrolladores de AWS Lambda.

Tipo: DeadLetterConfig

Obligatorio: no

Compatibilidad con AWS 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, por si quiere que AWS SAM cree automáticamente una cola de mensajes fallidos.

Description

Una descripción del conjunto de reglas.

Tipo: cadena

Obligatorio: no

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

Enabled

Indica si la regla está habilitada.

Para deshabilitar la regla, defina esta propiedad en false.

nota

Especifique la propiedad Enabled o State, pero no ambas.

Tipo: Booleano

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad es similar a la propiedad State de un recurso AWS::Events::Rule. Si esta propiedad se establece en true entonces AWS SAM pasa; de lo contrarioENABLED, pasa DISABLED.

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 AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad Input de un recurso AWS::Events::Rule Target.

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.

Tipo: cadena

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad Name 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, consulte 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 AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad RetryPolicy del tipo de datos AWS::Events::Rule Target.

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.

Tipo: cadena

Obligatorio: sí

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

State

El estado de la regla.

Valores aceptados DISABLED | ENABLED:

nota

Especifique la propiedad Enabled o State, pero no ambas.

Tipo: cadena

Obligatorio: no

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

Ejemplos

Evento programado de CloudWatch

Ejemplo de evento de programación de CloudWatch

YAML

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