Schedule

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

AWS Serverless Application Model (AWS SAM) génère une ressource AWS::Events::Rule lorsque ce type d'événement est défini.

Note

EventBridge propose désormais une nouvelle fonctionnalité de planification, Amazon EventBridge Scheduler. Amazon EventBridge Scheduler est un planificateur sans serveur qui vous permet de créer, d'exécuter et de gérer des tâches à partir d'un service géré centralisé. EventBridge Schedulerest hautement personnalisable et offre une évolutivité améliorée par rapport aux règles EventBridge planifiées, avec un ensemble plus large d'opérations d'API cibles etServices AWS.

Nous vous recommandons de l'utiliser EventBridge Scheduler pour invoquer des cibles selon un calendrier. Pour définir ce type de source d'événement dans vos modèles AWS SAM, consultez ScheduleV2.

Syntaxe

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

YAML

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

Propriétés

DeadLetterConfig

Configurez la file d'attente Amazon Simple Queue Service (Amazon SQS) dans EventBridge laquelle les événements sont envoyés 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 politique relative aux nouvelles tentatives relatives aux événements et l'utilisation des files d'attente contenant des lettres mortes dans le guide de l'utilisateur Amazon. EventBridge

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 en savoir plus sur la propriété de fonction DeadLetterQueue, consultez File d'attente de lettres mortes dans le Guide du développeur AWS Lambda.

Type : DeadLetterConfig

Obligatoire : non

Compatibilité AWS CloudFormation : cette propriété est similaire à la propriété DeadLetterConfig du type de données AWS::Events::Rule Target. La version AWS SAM de cette propriété inclut des sous-propriétés supplémentaires, au cas où vous souhaiteriez que AWS SAM crée la file d'attente de lettres mortes pour vous.

Description

Description de la règle.

Type : chaîne

Obligatoire : non

Compatibilité AWS CloudFormation : cette propriété est directement transmise à la propriété Description d'une ressource AWS::Events::Rule.

Enabled

Indique si la règle est activée.

Pour désactiver la règle, définissez cette propriété sur false.

Note

Spécifiez la propriété Enabled ou la propriété State, mais pas les deux.

Type : valeur booléenne

Obligatoire : non

Compatibilité AWS CloudFormation : cette propriété est similaire à la propriété State d'une ressource AWS::Events::Rule. Si cette propriété est définie sur true, alors AWS SAM passe ENABLED, sinon elle passe DISABLED.

Input

Texte JSON 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

Compatibilité AWS CloudFormation : cette propriété est directement transmise à la propriété Input d'une ressource AWS::Events::Rule Target.

Name

Le nom de la règle . Si vous ne spécifiez aucun nom, AWS CloudFormation génère un ID physique unique et l'utilise comme nom de règle.

Type : chaîne

Obligatoire : non

Compatibilité AWS CloudFormation : cette propriété est directement transmise à la propriété Name d'une ressource AWS::Events::Rule.

RetryPolicy

Objet RetryPolicy qui inclut des informations sur les paramètres de politique de nouvelle tentative. Pour plus d'informations, consultez la politique relative aux nouvelles tentatives relatives aux événements et l'utilisation des files d'attente contenant des lettres mortes dans le guide de l'utilisateur Amazon. EventBridge

Type : RetryPolicy

Obligatoire : non

Compatibilité AWS CloudFormation : cette propriété est directement transmise à la propriété RetryPolicy du type de données AWS::Events::Rule Target.

Schedule

Expression de planification qui détermine quand et à quelle fréquence la règle s'exécute. Pour plus d'informations, consultez Expression de planification des règles.

Type : chaîne

Obligatoire : oui

Compatibilité AWS CloudFormation : cette propriété est directement transmise à la propriété ScheduleExpression d'une ressource AWS::Events::Rule.

State

État de la règle.

Valeurs acceptées : DISABLED | ENABLED

Note

Spécifiez la propriété Enabled ou la propriété State, mais pas les deux.

Type : chaîne

Obligatoire : non

Compatibilité AWS CloudFormation : cette propriété est directement transmise à la propriété State d'une ressource AWS::Events::Rule.

Exemples

CloudWatch Planifier un événement

CloudWatch Exemple de planification d'un événement

YAML

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