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

ScheduleV2

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

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

Sintaxis

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

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 Configuración de una cola de mensajes fallidos para Programaciones de EventBridge en la Guía del usuario del Programador de 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

Compatibilidad con AWS CloudFormation: esta propiedad es similar a la propiedad DeadLetterConfig del tipo de datos AWS::Scheduler::Schedule 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 programa.

Tipo: cadena

Obligatorio: no

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

EndDate

La fecha, en UTC, antes de la cual la programación puede invocar su destino. Según la expresión de recurrencia de la programación, las invocaciones se pueden detener en la EndDate que especifique o antes de ella.

Tipo: cadena

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad EndDate de un recurso AWS::Scheduler::Schedule.

FlexibleTimeWindow

Permite configurar una ventana en la cual se puede invocar una programación.

Tipo: FlexibleTimeWindow

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad FlexibleTimeWindow de un recurso AWS::Scheduler::Schedule.

GroupName

El nombre de grupo de programación asociado a esta programación. Si no está definido, se utiliza el grupo predeterminado.

Tipo: cadena

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad GroupName de un recurso AWS::Scheduler::Schedule.

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::Scheduler::Schedule Target.

KmsKeyArn

El ARN de una clave de KMS que se utiliza para cifrar datos personalizados.

Tipo: cadena

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad KmsKeyArn de un recurso AWS::Scheduler::Schedule.

Name

El nombre de la programación. Si no especificas un nombre, AWS SAM genera uno en el formato Function-Logical-IDEvent-Source-Name y utiliza ese identificador para el nombre de la programación.

Tipo: cadena

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad Name de un recurso AWS::Scheduler::Schedule.

OmitName

De forma predeterminada, AWS SAM genera y usa un nombre de programación con el formato de <Function-logical-ID><event-source-name>. Establezca esta propiedad true para que AWS CloudFormation genere un identificador físico único y utilícelo en su lugar para el nombre del programa.

Tipo: Booleano

Obligatorio: no

Valor predeterminado: false

Compatibilidad con AWS CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente AWS CloudFormation.

PermissionsBoundary

El ARN de la política que se utilizará para definir el límite de los permisos para el rol.

nota

Si PermissionsBoundary está definido, AWS SAM aplicará los mismos límites al rol de IAM de destino del programador.

Tipo: cadena

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad PermissionsBoundary de un recurso AWS::IAM::Role.

RetryPolicy

Objeto de la RetryPolicy que incluye información acerca de la configuración de la política de reintentos.

Tipo: RetryPolicy

Obligatorio: no

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

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad RoleArn del tipo de datos AWS::Scheduler::Schedule Target.

ScheduleExpression

La expresión de programación que determina cuándo y con qué frecuencia se ejecuta el evento programado.

Tipo: cadena

Obligatorio: sí

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

ScheduleExpressionTimezone

La zona horaria en la que se evalúa la expresión de programación.

Tipo: cadena

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad ScheduleExpressionTimezone de un recurso AWS::Scheduler::Schedule.

StartDate

La fecha, en UTC, después de la cual la programación puede invocar un objetivo. Según la expresión de recurrencia de la programación, las invocaciones se pueden realizar en la StartDate que especifique o después de ella.

Tipo: cadena

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad StartDate de un recurso AWS::Scheduler::Schedule.

State

Estado de la programación del programador.

Valores aceptados DISABLED | ENABLED:

Tipo: cadena

Obligatorio: no

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

Ejemplos

Ejemplo básico de definición de un recurso de ScheduleV2

Resources:
  Function:
    Properties:
      ...
      Events:
        ScheduleEvent:
          Type: ScheduleV2
          Properties:
            ScheduleExpression: "rate(1 minute)"
        ComplexScheduleEvent:
          Type: ScheduleV2
          Properties:
            ScheduleExpression: rate(1 minute)
            FlexibleTimeWindow:
              Mode: FLEXIBLE
              MaximumWindowInMinutes: 5
            StartDate: '2022-12-28T12:00:00.000Z'
            EndDate: '2023-01-28T12:00:00.000Z'
            ScheduleExpressionTimezone: UTC
            RetryPolicy:
              MaximumRetryAttempts: 5
              MaximumEventAgeInSeconds: 300
            DeadLetterConfig:
              Type: SQS
nota

El ID físico generado de ScheduleV2 no incluye el nombre de la pila.