Schedule - 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.

Schedule

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

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

nota

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

Le recomendamos que utilice EventBridge Scheduler para invocar objetivos según un cronograma. Para definir este tipo de fuente de eventos en sus AWS SAM plantillas, consulteScheduleV2.

Sintaxis

Para declarar esta entidad en tu plantilla AWS Serverless Application Model (AWS SAM), usa 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 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, consulta Colas de mensajes fallidos en la Guía para desarrolladores de AWS Lambda .

Tipo: DeadLetterConfig

Obligatorio: no

CloudFormation compatibilidad: esta propiedad es similar a la DeadLetterConfig propiedad del tipo de datos. AWS::Events::Rule Target 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.

Description

Una descripción del conjunto de reglas.

Tipo: cadena

Obligatorio: no

CloudFormation compatibilidad: esta propiedad se transfiere directamente a la Description propiedad 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

CloudFormation compatibilidad: esta propiedad es similar a la State propiedad de un AWS::Events::Rule recurso. Si esta propiedad se establece en, true entonces, se AWS SAM aprueba; de lo contrarioENABLED, se apruebaDISABLED.

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

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

Name

El nombre de la regla. Si no especificas un nombre, CloudFormation genera un identificador físico único y lo utiliza como nombre de la regla.

Tipo: cadena

Obligatorio: no

CloudFormation compatibilidad: esta propiedad se transfiere directamente a la Name 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

CloudFormation compatibilidad: esta propiedad se transfiere directamente a la RetryPolicy propiedad 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, consulta Expresiones de programación para reglas.

Tipo: cadena

Obligatorio: sí

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

State

El estado de la regla.

Valores aceptados DISABLED | ENABLED:

nota

Especifique la propiedad Enabled o State, pero no ambas.

Tipo: cadena

Obligatorio: no

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

Ejemplos

CloudWatch Programar evento

CloudWatch Ejemplo de programar un evento

YAML

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