Schedule - AWS Serverless Application Model
SintaxisPropiedadesEjemplos

Schedule

El objeto que describe un tipo de origen de evento de Schedule, que establece su máquina de estados como el objetivo de una regla de EventBridge que se activa según una programación. Para obtener más información, consulta ¿Qué es Amazon EventBridge? en la Guía del usuario de Amazon EventBridge.

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

Sintaxis

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

YAML

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

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.

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, 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 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 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 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 especificas un nombre, CloudFormation genera un único ID físico y utiliza el ID para 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.

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 pasa directamente a la propiedad RetryPolicy del tipo de datos AWS::Events::Rule Target.

RoleArn

El ARN del rol de IAM que utilizará el Programador de EventBridge para este destino cuando se invoque la programación.

Tipo: RoleArn

Requerido: no. Si no se proporciona, se creará y utilizará un nuevo rol.

Compatibilidad con CloudFormation: esta propiedad pasa directamente a la propiedad RoleArn del tipo de datos AWS::Scheduler::Schedule 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í

Compatibilidad con 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 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 con CloudFormation: esta propiedad es similar a la propiedad Targets de un recurso AWS::Events::Rule. La versión AWS SAM de esta propiedad solo permite especificar el identificador lógico de un único destino.

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