ScheduleV2 - AWS Serverless Application Model
SyntaxePropriétésExemples

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

ScheduleV2

L'objet décrivant un type de source d'ScheduleV2événement, qui définit votre fonction sans serveur comme cible d'un événement Amazon EventBridge Scheduler qui se déclenche selon un calendrier. Pour plus d'informations, consultez Qu'est-ce qu'Amazon EventBridge Scheduler ? dans le guide de l'utilisateur EventBridge du planificateur.

AWS Serverless Application Model (AWS SAM) génère un AWS::Scheduler::Scheduleressource lorsque ce type d'événement est défini.

Syntaxe

Pour déclarer cette entité dans votre AWS Serverless Application Model (AWS SAM) modèle, utilisez la syntaxe suivante.

Propriétés

DeadLetterConfig

Configurez la file d'attente Amazon Simple Queue Service (AmazonSQS) où EventBridge envoie les événements après l'échec d'un appel cible. L'invocation peut échouer, par exemple, lors de l'envoi d'un événement à une fonction Lambda qui n'existe pas ou EventBridge lorsque les autorisations sont insuffisantes pour appeler la fonction Lambda. Pour plus d'informations, consultez la section Configuration d'une file d'attente de lettres mortes pour le EventBridge planificateur dans le guide de l'utilisateur du EventBridge planificateur.

Note

Le type de ressource AWS::Serverless::Function a un type de données similaire, DeadLetterQueue, qui gère les échecs qui se produisent après l'invocation réussie de la fonction Lambda cible. Des exemples de ces types d'échecs incluent la limitation Lambda, ou les erreurs renvoyées par la fonction cible Lambda. Pour plus d'informations sur la DeadLetterQueue propriété de la fonction, voir les files d'attente contenant des lettres mortes dans le AWS Lambda Guide du développeur.

Type : DeadLetterConfig

Obligatoire : non

AWS CloudFormation compatibilité  : cette propriété est similaire à celle du type de AWS::Scheduler::Schedule Target données. DeadLetterConfig Le AWS SAM la version de cette propriété inclut des sous-propriétés supplémentaires, au cas où vous le souhaiteriez AWS SAM pour créer pour vous la file d'attente des lettres mortes.

Description

Description de la planification.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité  : cette propriété est transmise directement à la Description propriété d'une AWS::Scheduler::Schedule ressource.

EndDate

Date (enUTC) avant laquelle le planning peut invoquer sa cible. En fonction de l'expression de récurrence de la planification, les appels peuvent s'arrêter avant, ou au moment de, la EndDate spécifiée.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité  : cette propriété est transmise directement à la EndDate propriété d'une AWS::Scheduler::Schedule ressource.

FlexibleTimeWindow

Permet de configurer une fenêtre dans laquelle une planification peut être appelée.

Type : FlexibleTimeWindow

Obligatoire : non

AWS CloudFormation compatibilité  : cette propriété est transmise directement à la FlexibleTimeWindow propriété d'une AWS::Scheduler::Schedule ressource.

GroupName

Nom du groupe de planifications à associer à cette planification. S'il n'est pas défini, le groupe par défaut est utilisé.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité  : cette propriété est transmise directement à la GroupName propriété d'une AWS::Scheduler::Schedule ressource.

Input

JSONTexte valide transmis à la cible. Si vous utilisez cette propriété, aucun élément du texte de l'événement lui-même n'est transmis à la cible.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité  : cette propriété est transmise directement à la Input propriété d'une AWS::Scheduler::Schedule Target ressource.

KmsKeyArn

Il s'ARNagit d'une KMS clé qui sera utilisée pour chiffrer les données des clients.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité  : cette propriété est transmise directement à la KmsKeyArn propriété d'une AWS::Scheduler::Schedule ressource.

Name

Nom du calendrier. Si vous ne spécifiez pas de nom, AWS SAM génère un nom au format Function-Logical-IDEvent-Source-Name et utilise cet ID pour le nom du planning.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité  : cette propriété est transmise directement à la Name propriété d'une AWS::Scheduler::Schedule ressource.

OmitName

Par défaut, AWS SAM génère et utilise un nom de calendrier au format de <Function-logical-ID><event-source-name>. Définissez cette propriété true sur AWS CloudFormation générez un identifiant physique unique et utilisez-le plutôt pour le nom du calendrier.

Type : valeur booléenne

Obligatoire : non

Par défaut : false

AWS CloudFormation compatibilité  : cette propriété est propre à AWS SAM et n'a pas de AWS CloudFormation équivalent.

PermissionsBoundary

La ARN politique utilisée pour définir la limite des autorisations pour le rôle.

Note

S'PermissionsBoundaryil est défini, AWS SAM appliquera les mêmes limites au rôle cible IAM du planning du planificateur.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité  : cette propriété est transmise directement à la PermissionsBoundary propriété d'une AWS::IAM::Role ressource.

RetryPolicy

Objet RetryPolicy qui inclut des informations sur les paramètres de politique de nouvelle tentative.

Type : RetryPolicy

Obligatoire : non

AWS CloudFormation compatibilité  : cette propriété est transmise directement à la RetryPolicy propriété du type de AWS::Scheduler::Schedule Target données.

RoleArn

Le ARN IAM rôle que le EventBridge planificateur utilisera pour la cible lorsque le calendrier sera invoqué.

Type : RoleArn

Obligatoire : non

AWS CloudFormation compatibilité  : cette propriété est transmise directement à la RoleArn propriété du type de AWS::Scheduler::Schedule Target données.

ScheduleExpression

Expression de planification qui détermine quand et à quelle fréquence l'événement de planification du planificateur s'exécute.

Type : chaîne

Obligatoire : oui

AWS CloudFormation compatibilité  : cette propriété est transmise directement à la ScheduleExpression propriété d'une AWS::Scheduler::Schedule ressource.

ScheduleExpressionTimezone

Fuseau horaire dans lequel l'expression de planification est évaluée.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité  : cette propriété est transmise directement à la ScheduleExpressionTimezone propriété d'une AWS::Scheduler::Schedule ressource.

StartDate

Date, enUTC, après laquelle le calendrier peut commencer à invoquer une cible. En fonction de l'expression de récurrence de la planification, les appels peuvent se dérouler après, ou au moment de, la StartDate spécifiée.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité  : cette propriété est transmise directement à la StartDate propriété d'une AWS::Scheduler::Schedule ressource.

State

État de la planification du planificateur.

Valeurs acceptées : DISABLED | ENABLED

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité  : cette propriété est transmise directement à la State propriété d'une AWS::Scheduler::Schedule ressource.

Exemples

Exemple de base de définition d'une ressource 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
Note

L'ID physique généré par ScheduleV2 n'inclut pas le nom de la pile.