

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.

# Schedule
<a name="sam-property-function-schedule"></a>

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 ?](https://docs.aws.amazon.com/eventbridge/latest/userguide/what-is-amazon-eventbridge.html) dans le *guide de EventBridge l'utilisateur Amazon*.

AWS Serverless Application Model (AWS SAM) génère une [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html)ressource lorsque ce type d'événement est défini.

**Note**  
EventBridge propose désormais une nouvelle fonctionnalité de planification, [Amazon EventBridge Scheduler](https://docs.aws.amazon.com/scheduler/latest/UserGuide/what-is-scheduler.html). 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 et Services AWS.  
Nous vous recommandons d’utiliser EventBridge Scheduler pour invoquer des cibles selon un calendrier. Pour définir ce type de source d'événement dans vos AWS SAM modèles, consultez[ScheduleV2](sam-property-function-schedulev2.md).

## Syntaxe
<a name="sam-property-function-schedule-syntax"></a>

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

### YAML
<a name="sam-property-function-schedule-syntax.yaml"></a>

```
  [DeadLetterConfig](#sam-function-schedule-deadletterconfig): DeadLetterConfig
  [Description](#sam-function-schedule-description): String
  [Enabled](#sam-function-schedule-enabled): Boolean
  [Input](#sam-function-schedule-input): String
  [Name](#sam-function-schedule-name): String
  [RetryPolicy](#sam-function-schedule-retrypolicy): [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)
  [Schedule](#sam-function-schedule-schedule): String
  [State](#sam-function-schedule-state): String
```

## Propriétés
<a name="sam-property-function-schedule-properties"></a>

 `DeadLetterConfig`   <a name="sam-function-schedule-deadletterconfig"></a>
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](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html) le guide de l'utilisateur Amazon. EventBridge *  
Le type de ressource [AWS::Serverless::Function](sam-resource-function.md) 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](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq) dans le *Guide du développeur AWS Lambda *.
*Type :* [DeadLetterConfig](sam-property-function-scheduledeadletterconfig.md)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est similaire à celle du type de `AWS::Events::Rule` `Target` données. `[DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-deadletterconfig)` La AWS SAM version de cette propriété inclut des sous-propriétés supplémentaires, au cas où vous souhaiteriez AWS SAM créer la file d'attente de lettres mortes pour vous.

 `Description`   <a name="sam-function-schedule-description"></a>
Description de la règle.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-description)` propriété d'une `AWS::Events::Rule` ressource.

 `Enabled`   <a name="sam-function-schedule-enabled"></a>
Indique si la règle est activée.  
Pour désactiver la règle, définissez cette propriété sur `false`.  
Spécifiez la propriété `Enabled` ou la propriété `State`, mais pas les deux.
*Type* : valeur booléenne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est similaire à celle `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)` d'une `AWS::Events::Rule` ressource. Si cette propriété est définie sur `true` then`ENABLED`, elle est AWS SAM transmise dans le cas contraire`DISABLED`.

 `Input`   <a name="sam-function-schedule-input"></a>
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  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input)` propriété d'une `AWS::Events::Rule Target` ressource.

 `Name`   <a name="sam-function-schedule-name"></a>
Le nom de la règle . Si vous ne spécifiez pas de nom, CloudFormation génère un identifiant physique unique et utilise cet identifiant comme nom de règle.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name)` propriété d'une `AWS::Events::Rule` ressource.

 `RetryPolicy`   <a name="sam-function-schedule-retrypolicy"></a>
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](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html) le guide de l'utilisateur Amazon. EventBridge *  
*Type :* [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)` propriété du type de `AWS::Events::Rule` `Target` données.

 `Schedule`   <a name="sam-function-schedule-schedule"></a>
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](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html).  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ScheduleExpression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression)` propriété d'une `AWS::Events::Rule` ressource.

 `State`   <a name="sam-function-schedule-state"></a>
État de la règle.  
*Valeurs acceptées :* `DISABLED | ENABLED`  
Spécifiez la propriété `Enabled` ou la propriété `State`, mais pas les deux.
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)` propriété d'une `AWS::Events::Rule` ressource.

## Exemples
<a name="sam-property-function-schedule--examples"></a>

### CloudWatch Planifier un événement
<a name="sam-property-function-schedule--examples--cloudwatch-schedule-event"></a>

CloudWatch Exemple de planification d'un événement

#### YAML
<a name="sam-property-function-schedule--examples--cloudwatch-schedule-event--yaml"></a>

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

# DeadLetterConfig
<a name="sam-property-function-scheduledeadletterconfig"></a>

L'objet utilisé pour spécifier la file d'attente Amazon Simple Queue Service (Amazon SQS) EventBridge où envoie les événements après l'échec d'un appel cible. L'appel peut échouer, par exemple, lors de l'envoi d'un événement à une fonction Lambda qui n'existe pas, ou en cas d'autorisations 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](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html) le guide de l'utilisateur Amazon. EventBridge *

**Note**  
Le type de ressource [AWS::Serverless::Function](sam-resource-function.md) a un type de données similaire, `DeadLetterQueue`, qui gère les échecs qui se produisent après l'appel réussi de la fonction Lambda cible. Des exemples de ce type de défaillance 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](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq) dans le *Guide du développeur AWS Lambda *.

## Syntaxe
<a name="sam-property-function-scheduledeadletterconfig-syntax"></a>

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

### YAML
<a name="sam-property-function-scheduledeadletterconfig-syntax.yaml"></a>

```
  [Arn](#sam-function-scheduledeadletterconfig-arn): String
  [QueueLogicalId](#sam-function-scheduledeadletterconfig-queuelogicalid): String
  [Type](#sam-function-scheduledeadletterconfig-type): String
```

## Propriétés
<a name="sam-property-function-scheduledeadletterconfig-properties"></a>

 `Arn`   <a name="sam-function-scheduledeadletterconfig-arn"></a>
L'Amazon Resource Name (ARN) de la file d'attente Amazon SQS spécifiée comme cible pour la file d'attente de lettres mortes.  
Spécifiez la propriété `Type` ou la propriété `Arn`, mais pas les deux.
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[Arn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html#cfn-events-rule-deadletterconfig-arn)` propriété du type de `AWS::Events::Rule` `DeadLetterConfig` données.

 `QueueLogicalId`   <a name="sam-function-scheduledeadletterconfig-queuelogicalid"></a>
Le nom personnalisé de la file d'attente de lettres mortes qui la AWS SAM crée `Type` est spécifié.  
Si la propriété `Type` n'est pas définie, cette propriété est ignorée.
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `Type`   <a name="sam-function-scheduledeadletterconfig-type"></a>
Type de la file d'attente. Lorsque cette propriété est définie, crée AWS SAM automatiquement une file d'attente de lettres mortes et y joint la [politique basée sur les ressources](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-perms) nécessaire pour autoriser la ressource à envoyer des événements à la file d'attente.  
Spécifiez la propriété `Type` ou la propriété `Arn`, mais pas les deux.
*Valeurs valides* : `SQS`  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

## Exemples
<a name="sam-property-function-scheduledeadletterconfig--examples"></a>

### DeadLetterConfig
<a name="sam-property-function-scheduledeadletterconfig--examples--deadletterconfig"></a>

DeadLetterConfig

#### YAML
<a name="sam-property-function-scheduledeadletterconfig--examples--deadletterconfig--yaml"></a>

```
DeadLetterConfig:
  Type: SQS
  QueueLogicalId: MyDLQ
```