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 su máquina de estados como el objetivo de una EventBridge regla que se activa según una programación. 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 recurso 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), use 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
-
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
Tipo: DeadLetterConfig
Obligatorio: no
Compatibilidad con AWS CloudFormation: esta propiedad es similar a la propiedad
DeadLetterConfig
del tipo de datosAWS::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 recursoAWS::Events::Rule
. -
Enabled
-
Indica si la regla está habilitada.
Para deshabilitar la regla, defina esta propiedad en
false
.nota
Especifique la propiedad
Enabled
oState
, pero no ambas.Tipo: Booleano
Obligatorio: no
Compatibilidad con AWS CloudFormation: esta propiedad es similar a la propiedad
State
de un recursoAWS::Events::Rule
. Si esta propiedad se establece entrue
entonces AWS SAM pasa; de lo contrarioENABLED
, pasaDISABLED
. -
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 recursoAWS::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 recursoAWS::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 la política de reintentos de eventos y el uso de colas con letra muerta en la Guía del usuario de Amazon. EventBridgeTipo: RetryPolicy
Obligatorio: no
Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad
RetryPolicy
del tipo de datosAWS::Events::Rule
Target
. -
RoleArn
-
El ARN de la función de IAM que EventBridge Scheduler utilizará para el destino cuando se invoque la programación.
Tipo: RoleArn
Requerido: no. Si no se proporciona, se creará y utilizará un nuevo rol.
Compatibilidad con AWS CloudFormation: esta propiedad pasa directamente a la propiedad
RoleArn
del tipo de datosAWS::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, 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 recursoAWS::Events::Rule
. -
State
-
El estado de la regla.
Valores aceptados
DISABLED | ENABLED
:nota
Especifique la propiedad
Enabled
oState
, pero no ambas.Tipo: cadena
Obligatorio: no
Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad
State
de un recursoAWS::Events::Rule
. -
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
Compatibilidad con AWS CloudFormation: esta propiedad es similar a la propiedad
Targets
de un recursoAWS::Events::Rule
. La versión AWS SAM de esta propiedad solo permite especificar el identificador lógico de un único destino.
Ejemplos
CloudWatch Programa un evento
CloudWatch Ejemplo de programar un evento
YAML
CWSchedule: Type: Schedule Properties: Schedule: 'rate(1 minute)' Name: TestSchedule Description: test schedule Enabled: false