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.

# AWS::Serverless::Function
<a name="sam-resource-function"></a>

Crée une AWS Lambda fonction, un rôle d'exécution Gestion des identités et des accès AWS (IAM) et des mappages de sources d'événements qui déclenchent la fonction.

La [AWS::Serverless::Function](#sam-resource-function) ressource prend également en charge l'attribut `Metadata` resource, ce qui vous permet de demander de AWS SAM créer des environnements d'exécution personnalisés dont votre application a besoin. Pour plus d'informations sur la création d'une exécution personnalisée, consultez [Création de fonctions Lambda avec des environnements d'exécution personnalisés dans AWS SAM](building-custom-runtimes.md).

**Note**  
Lorsque vous déployez vers AWS CloudFormation, vos AWS SAM ressources sont AWS SAM transformées en CloudFormation ressources. Pour de plus amples informations, veuillez consulter [CloudFormation Ressources générées pour AWS SAM](sam-specification-generated-resources.md).

## Syntaxe
<a name="sam-resource-function-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-resource-function-syntax.yaml"></a>

```
Type: AWS::Serverless::Function
Properties:
  [Architectures](#sam-function-architectures): List
  [AssumeRolePolicyDocument](#sam-function-assumerolepolicydocument): JSON
  [AutoPublishAlias](#sam-function-autopublishalias): String
  AutoPublishAliasAllProperties: Boolean
  [AutoPublishCodeSha256](#sam-function-autopublishcodesha256): String
  [CapacityProviderConfig](#sam-function-capacityproviderconfig): CapacityProviderConfig
  [CodeSigningConfigArn](#sam-function-codesigningconfigarn): String
  [CodeUri](#sam-function-codeuri): String | FunctionCode
  [DeadLetterQueue](#sam-function-deadletterqueue): Map | DeadLetterQueue
  [DeploymentPreference](#sam-function-deploymentpreference): DeploymentPreference
  [Description](#sam-function-description): String
  [DurableConfig](#sam-function-durableconfig): DurableConfig
  [Environment](#sam-function-environment): [Environment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-environment.html)
  [EphemeralStorage](#sam-function-ephemeralstorage): [EphemeralStorage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-ephemeralstorage)
  [EventInvokeConfig](#sam-function-eventinvokeconfig): EventInvokeConfiguration
  [Events](#sam-function-events): EventSource
  [FileSystemConfigs](#sam-function-filesystemconfigs): List
  [FunctionName](#sam-function-functionname): String
  [FunctionScalingConfig](#sam-function-functionscalingconfig): FunctionScalingConfig
  [FunctionUrlConfig](#sam-function-functionurlconfig): FunctionUrlConfig
  [Handler](#sam-function-handler): String
  [ImageConfig](#sam-function-imageconfig): [ImageConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-imageconfig)
  [ImageUri](#sam-function-imageuri): String
  [InlineCode](#sam-function-inlinecode): String
  [KmsKeyArn](#sam-function-kmskeyarn): String
  [Layers](#sam-function-layers): List
  LoggingConfig: [LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-loggingconfig.html)
  [MemorySize](#sam-function-memorysize): Integer
  [PackageType](#sam-function-packagetype): String
  [PermissionsBoundary](#sam-function-permissionsboundary): String
  [Policies](#sam-function-policies): String | List | Map
  [PublishToLatestPublished](#sam-function-publishtolatestpublished): Boolean
  PropagateTags: Boolean
  [ProvisionedConcurrencyConfig](#sam-function-provisionedconcurrencyconfig): [ProvisionedConcurrencyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-provisionedconcurrencyconfig)
  RecursiveLoop: String
  [ReservedConcurrentExecutions](#sam-function-reservedconcurrentexecutions): Integer
  [Role](#sam-function-role): String
  [RolePath](#sam-function-rolepath): String
  [Runtime](#sam-function-runtime): String
  RuntimeManagementConfig: [RuntimeManagementConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-runtimemanagementconfig.html)
  SnapStart: [SnapStart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-snapstart.html)
  [SourceKMSKeyArn](#sam-function-sourcekmskeyarn): String
  [Tags](#sam-function-tags): Map
  [TenancyConfig](#sam-function-tenancyconfig): TenancyConfig
  [Timeout](#sam-function-timeout): Integer
  [Tracing](#sam-function-tracing): String
  [VersionDescription](#sam-function-versiondescription): String
  [VersionDeletionPolicy](#sam-function-versiondeletionpolicy): String
  [VpcConfig](#sam-function-vpcconfig): [VpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html)
```

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

 `Architectures`   <a name="sam-function-architectures"></a>
Architecture du jeu d'instructions de la fonction.  
Pour en savoir plus sur cette propriété, consultez [Architectures du jeu d'instructions Lambda](https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html) dans le*guide du développeur AWS Lambda *.  
*Valeurs valides* : Une de `x86_64` ou `arm64`  
*Type* : liste  
*Obligatoire* : non  
*Par défaut* : `x86_64`  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[Architectures](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-architectures)` propriété d'une `AWS::Lambda::Function` ressource.

 `AssumeRolePolicyDocument`   <a name="sam-function-assumerolepolicydocument"></a>
Ajoute un AssumeRolePolicyDocument pour la valeur par défaut créée `Role` pour cette fonction. Si cette propriété n'est pas spécifiée, AWS SAM ajoute un rôle d'assume par défaut pour cette fonction.  
*Type* : JSON  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est similaire à celle `[AssumeRolePolicyDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-assumerolepolicydocument)` d'une `AWS::IAM::Role` ressource. AWS SAM ajoute cette propriété au rôle IAM généré pour cette fonction. Si l'Amazon Resource Name (ARN) d'un rôle est fourni pour cette fonction, cette propriété ne fait rien.

 `AutoPublishAlias`   <a name="sam-function-autopublishalias"></a>
Le nom de l'alias Lambda. Pour plus d'informations sur l'utilisation des alias Lambda, consultez [Alias de fonction Lambda](https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html) dans le *Guide du développeur AWS Lambda *. Pour obtenir des exemples qui utilisent cette propriété, consultez [Déploiement progressif d'applications sans serveur avec AWS SAM](automating-updates-to-serverless-apps.md).  
AWS SAM génère [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html)et fournit [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html)des ressources lorsque cette propriété est définie. Pour plus d'informations sur ce scénario, consultez [AutoPublishAlias la propriété est spécifiée](sam-specification-generated-resources-function.md#sam-specification-generated-resources-function-autopublishalias). Pour des informations générales sur les CloudFormation ressources générées, consultez[CloudFormation Ressources générées pour AWS SAM](sam-specification-generated-resources.md).  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `AutoPublishAliasAllProperties`   <a name="sam-function-autopublishaliasallproperties"></a>
Spécifie quand une nouvelle version [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html) est créée. Lorsque l'option est `true`, une nouvelle version Lambda est créée lorsqu'une propriété de la fonction Lambda est modifiée. Lorsque l'option est `false`, une nouvelle version Lambda est créée uniquement lorsque l'une des propriétés suivantes est modifiée :  
+ `Environment`, `MemorySize`, ou `SnapStart`.
+ Toute modification entraînant une mise à jour de la propriété du `Code`, telle que `CodeDict`, `ImageUri` ou `InlineCode`.
Cette propriété nécessite que `AutoPublishAlias` soit défini.  
Si `AutoPublishCodeSha256` est également spécifié, son comportement est prioritaire sur `AutoPublishAliasAllProperties: true`.  
*Type* : valeur booléenne  
*Obligatoire* : non  
*Valeur par défaut* : `false`  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `AutoPublishCodeSha256`   <a name="sam-function-autopublishcodesha256"></a>
Lorsqu'elle est utilisée, cette chaîne fonctionne avec la `CodeUri` valeur pour déterminer si une nouvelle version de Lambda doit être publiée. Cette propriété est souvent utilisée pour résoudre le problème de déploiement suivant : un package de déploiement est stocké dans un emplacement Amazon S3 et est remplacé par un nouveau package de déploiement avec un code de fonction Lambda mis à jour, mais la `CodeUri` propriété reste inchangée (par opposition au téléchargement du nouveau package de déploiement vers un nouvel emplacement Amazon S3 et `CodeUri` remplacé par le nouvel emplacement).  
Ce problème est marqué par un AWS SAM modèle présentant les caractéristiques suivantes :  
+ L'`DeploymentPreference`objet est configuré pour des déploiements progressifs (comme décrit dans[Déploiement progressif d'applications sans serveur avec AWS SAM](automating-updates-to-serverless-apps.md))
+ La `AutoPublishAlias` propriété est définie et ne change pas entre les déploiements
+ La `CodeUri` propriété est définie et ne change pas entre les déploiements.
Dans ce scénario, la mise à jour des résultats `AutoPublishCodeSha256` entraîne la création d'une nouvelle version Lambda. Toutefois, le nouveau code de fonction déployé sur Amazon S3 n'est pas reconnu. Pour reconnaître le nouveau code de fonction, pensez à utiliser la gestion des versions dans votre compartiment Amazon S3. Spécifiez la propriété `Version` de votre fonction Lambda et configurez votre compartiment pour qu'il utilise toujours le dernier Package de déploiement.  
Dans ce scénario, pour déclencher le déploiement progressif avec succès, vous devez fournir une valeur unique pour `AutoPublishCodeSha256`.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `CapacityProviderConfig`   <a name="sam-function-capacityproviderconfig"></a>
Configure le fournisseur de capacité auquel les versions publiées de la fonction seront associées. Cela permet à la fonction de s'exécuter sur des instances EC2 appartenant au client et gérées par des instances gérées par Lambda.  
*Type :* [CapacityProviderConfig](sam-property-function-capacityproviderconfig.md)  
*Obligatoire* : non  
*CloudFormation compatibilité* : SAM aplatit la propriété transmise à la `[CapacityProviderConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-capacityproviderconfig)` propriété d'une `AWS::Lambda::Function` ressource et reconstruit la structure imbriquée.

 `CodeSigningConfigArn`   <a name="sam-function-codesigningconfigarn"></a>
L'ARN de la ressource [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html), utilisée pour activer la signature de code pour cette fonction. Pour plus d'informations sur la signature de code, consultez [Configurer la signature de code pour votre AWS SAM application](authoring-codesigning.md).  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[CodeSigningConfigArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-codesigningconfigarn)` propriété d'une `AWS::Lambda::Function` ressource.

 `CodeUri`   <a name="sam-function-codeuri"></a>
Code pour la fonction. Les valeurs acceptées incluent :  
+ l'URI Amazon S3 de la fonction ; Par exemple, `s3://bucket-123456789/sam-app/1234567890abcdefg`.
+ le chemin local vers la fonction. Par exemple, `hello_world/`.
+ Un objet [FunctionCode](sam-property-function-functioncode.md).
Si vous fournissez l'URI Amazon S3 d'une fonction ou l'objet [FunctionCode](sam-property-function-functioncode.md), vous devez référencer un [package de déploiement Lambda](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) valide.  
Si vous fournissez un chemin de fichier local, utilisez la CLI  AWS SAM pour charger le fichier local lors du déploiement. Pour en savoir plus, veuillez consulter la section [Comment AWS SAM télécharge les fichiers locaux lors du déploiement](deploy-upload-local-files.md).  
Si vous utilisez des fonctions intrinsèques dans les `CodeUri` propriétés, vous ne AWS SAM pourrez pas analyser correctement les valeurs. Envisagez plutôt d'utiliser [AWS::LanguageExtensions transform](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-languageextensions.html).
*Type* : [ chaîne de caractères \$1 [FunctionCode](sam-property-function-functioncode.md) ]  
*Obligatoire :* selon les conditions. Lorsque `PackageType` est défini sur `Zip`, un `CodeUri` ou un `InlineCode` est requis.  
*CloudFormation compatibilité* : cette propriété est similaire à celle `[ Code](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-code)` d'une `AWS::Lambda::Function` ressource. Les propriétés imbriquées d'Amazon S3 sont nommées différemment.

 `DeadLetterQueue`   <a name="sam-function-deadletterqueue"></a>
Configure une rubrique Amazon Simple Notification Service (Amazon SNS) ou une file d'attente Amazon Simple Queue Service (Amazon SQS) où Lambda envoie les événements qu'il ne peut pas traiter. Pour en savoir plus sur la fonctionnalité de la file d'attente de lettres mortes, consultez [File d'attente de lettres mortes](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async-retain-records.html#invocation-dlq) dans le *Guide du développeur AWS Lambda *.  
Si la source d'événements de votre fonction Lambda est une file d'attente Amazon SQS, configurez une file d'attente de lettres mortes pour la file d'attente source, et pas pour la fonction Lambda. La file d'attente de lettres mortes que vous configurez pour une fonction est utilisée pour la [file d'attente d'invocations asynchrones](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html) de la fonction et pas pour les files d'attente source d'événement.
*Type* : Carte \$1 [DeadLetterQueue](sam-property-function-deadletterqueue.md)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est similaire à celle `[DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-deadletterconfig.html)` d'une `AWS::Lambda::Function` ressource. Dans CloudFormation le type est dérivé du`TargetArn`, tandis que dans AWS SAM vous devez transmettre le type avec le`TargetArn`.

 `DeploymentPreference`   <a name="sam-function-deploymentpreference"></a>
Les paramètres permettant d’activer les déploiements Lambda progressifs.  
Si un `DeploymentPreference` objet est spécifié, AWS SAM crée un [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-application.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-application.html)appelé `ServerlessDeploymentApplication` (un par pile), un [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html)appelé `<function-logical-id>DeploymentGroup` et un [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html)appelé`CodeDeployServiceRole`.  
*Type :* [DeploymentPreference](sam-property-function-deploymentpreference.md)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.  
*Voir aussi* : pour plus d'informations sur cette propriété, consultez [Déploiement progressif d'applications sans serveur avec AWS SAM](automating-updates-to-serverless-apps.md).

 `Description`   <a name="sam-function-description"></a>
Description de la fonction.  
*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-lambda-function.html#cfn-lambda-function-description)` propriété d'une `AWS::Lambda::Function` ressource.

 `DurableConfig`   <a name="sam-function-durableconfig"></a>
Configuration pour des fonctions durables. Permet une exécution dynamique avec des fonctionnalités de point de contrôle et de rediffusion automatiques.  
*Type :* [DurableConfig](sam-property-function-durableconfig.md)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `Environment`   <a name="sam-function-environment"></a>
La configuration de l'environnement d'exécution.  
*Type* : [Environment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-environment.html)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[Environment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-environment.html)` propriété d'une `AWS::Lambda::Function` ressource.

 `EphemeralStorage`   <a name="sam-function-ephemeralstorage"></a>
Objet qui spécifie l'espace disque, en Mo, disponible pour votre fonction Lambda dans `/tmp`.  
Pour plus d'informations sur cette propriété, consultez [Environnement d’exécution Lambda](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html) dans le *Guide du développeur AWS Lambda *.  
*Type :* [EphemeralStorage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-ephemeralstorage)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[EphemeralStorage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-ephemeralstorage)` propriété d'une `AWS::Lambda::Function` ressource.

 `EventInvokeConfig`   <a name="sam-function-eventinvokeconfig"></a>
L'objet qui décrit l'événement appelle la configuration sur une fonction Lambda.  
*Type :* [EventInvokeConfiguration](sam-property-function-eventinvokeconfiguration.md)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `Events`   <a name="sam-function-events"></a>
Spécifie les événements qui déclenchent cette fonction. Les événements sont constitués d'un type et d'un ensemble de propriétés qui dépendent du type.  
*Type :* [EventSource](sam-property-function-eventsource.md)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `FileSystemConfigs`   <a name="sam-function-filesystemconfigs"></a>
Liste des [FileSystemConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-filesystemconfig.html)objets qui spécifient les paramètres de connexion pour un système de fichiers Amazon Elastic File System (Amazon EFS).  
Si votre modèle contient une ressource [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html), vous devez également préciser un `DependsOn` attribut pour vous assurer que la cible de montage est créée ou mise à jour avant la fonction.  
*Type* : liste  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[FileSystemConfigs](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-filesystemconfigs)` propriété d'une `AWS::Lambda::Function` ressource.

 `FunctionName`   <a name="sam-function-functionname"></a>
Nom de la fonction. Si vous ne spécifiez aucun nom, un nom unique sera généré pour vous.  
*Type :* chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[FunctionName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionname)` propriété d'une `AWS::Lambda::Function` ressource.

 `FunctionScalingConfig`   <a name="sam-function-functionscalingconfig"></a>
Configure le comportement de dimensionnement des fonctions Lambda exécutées sur des fournisseurs de capacité. Définit le nombre minimal et maximal d'environnements d'exécution.  
*Type :* [FunctionScalingConfig](sam-property-function-functionscalingconfig.md)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[FunctionScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionscalingconfig)` propriété d'une `AWS::Lambda::Function` ressource.

 `FunctionUrlConfig`   <a name="sam-function-functionurlconfig"></a>
Objet qui décrit l'URL d'une fonction. Une URL de fonction est un point de terminaison HTTPS que vous pouvez utiliser pour appeler votre fonction.  
Pour plus d'informations, consultez [la section Fonction URLs](https://docs.aws.amazon.com/lambda/latest/dg/lambda-urls.html) dans le *guide du AWS Lambda développeur*.  
*Type :* [FunctionUrlConfig](sam-property-function-functionurlconfig.md)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `Handler`   <a name="sam-function-handler"></a>
La fonction dans votre code qui est appelée pour commencer l'exécution. Cette propriété n'est requise que si la propriété `PackageType` est définie sur `Zip`.  
*Type :* chaîne  
*Obligatoire* : Conditionnelle  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[Handler](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-handler)` propriété d'une `AWS::Lambda::Function` ressource.

 `ImageConfig`   <a name="sam-function-imageconfig"></a>
Objet utilisé pour configurer les paramètres d'image du conteneur Lambda. Pour plus d'informations sur l'utilisation de Lambda, consultez la section [Mise en route avec Lambda](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) du *Guide du développeur AWS Lambda *.  
*Type :* [ImageConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-imageconfig)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ImageConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-imageconfig)` propriété d'une `AWS::Lambda::Function` ressource.

 `ImageUri`   <a name="sam-function-imageuri"></a>
L'URI du référentiel Amazon Elastic Container Registry (Amazon ECR) pour l'image de conteneur de la fonction Lambda. Cette propriété s'applique uniquement si la propriété `PackageType` est définie sur `Image`, sinon, elle est ignorée. Pour plus d'informations, consultez la section [Utilisation d'images de conteneur avec Lambda](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) dans le *Guide du développeur AWS Lambda *.  
Si la `PackageType` propriété est définie sur`Image`, l'une des deux `ImageUri` est obligatoire ou vous devez créer votre application avec `Metadata` les entrées nécessaires dans le fichier AWS SAM modèle. Pour de plus amples informations, veuillez consulter [Construit par défaut avec AWS SAM](serverless-sam-cli-using-build.md).
Créer votre application avec les `Metadata` nécessaires, les entrées sont prioritaires sur `ImageUri`, donc si vous précisez les deux, alors `ImageUri` sera ignoré.  
*Type :* chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ImageUri](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-imageuri)` propriété du type de `AWS::Lambda::Function` `Code` données.

 `InlineCode`   <a name="sam-function-inlinecode"></a>
Le code de fonction Lambda qui est écrit directement dans le modèle. Cette propriété s'applique uniquement si la propriété `PackageType` est définie sur `Zip`, sinon, elle est ignorée.  
Si la propriété `PackageType` est définie sur `Zip` (par défaut), alors l'un des `CodeUri` ou `InlineCode` est requis.
*Type* : chaîne  
*Obligatoire* : Conditionnelle  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ZipFile](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-zipfile)` propriété du type de `AWS::Lambda::Function` `Code` données.

 `KmsKeyArn`   <a name="sam-function-kmskeyarn"></a>
L'ARN d'une clé AWS Key Management Service (AWS KMS) que Lambda utilise pour chiffrer et déchiffrer les variables d'environnement de votre fonction.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-kmskeyarn)` propriété d'une `AWS::Lambda::Function` ressource.

 `Layers`   <a name="sam-function-layers"></a>
Liste des éléments `LayerVersion` ARNs que cette fonction doit utiliser. L'ordre spécifié ici est l'ordre dans lequel ils seront importés lors de l'exécution de la fonction Lambda. La version est soit un ARN complet incluant la version, soit une référence à une LayerVersion ressource. Par exemple, une référence à un `LayerVersion` will sera `!Ref MyLayer` alors qu'un ARN complet incluant la version le sera`arn:aws:lambda:region:account-id:layer:layer-name:version`.  
*Type* : liste  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[Layers](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-layers)` propriété d'une `AWS::Lambda::Function` ressource.

 `LoggingConfig`   <a name="sam-function-loggingconfig"></a>
Les paramètres de configuration Amazon CloudWatch Logs de la fonction.  
*Type :* [LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-loggingconfig.html)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-loggingconfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-loggingconfig)propriété d'une `AWS::Lambda::Function` ressource.

 `MemorySize`   <a name="sam-function-memorysize"></a>
La taille de la mémoire en Mo allouée par invocation de la fonction.  
*Type* : entier  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[MemorySize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-memorysize)` propriété d'une `AWS::Lambda::Function` ressource.

 `PackageType`   <a name="sam-function-packagetype"></a>
Le package de déploiement de la fonction Lambda. Pour plus d'informations, consultez [Packages de déploiement M Lambda](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) dans le *Guide du développeur AWS Lambda *.  
**Remarques** :  
1. Si cette propriété est définie sur `Zip`(par défaut), alors soit `CodeUri` ou `InlineCode`s'applique, et `ImageUri` est ignoré.  
2. Si cette propriété est définie sur `Image`, alors uniquement `ImageUri` s'applique, et `CodeUri` et `InlineCode` sont ignorés. Le référentiel Amazon ECR requis pour stocker l'image du conteneur de la fonction peut être créé automatiquement par le AWS SAMCLI. Pour de plus amples informations, veuillez consulter [sam deploy](sam-cli-command-reference-sam-deploy.md).  
*Valeurs valides* : `Zip` ou `Image`  
*Type :* chaîne  
*Obligatoire* : non  
*Par défaut* : `Zip`  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[PackageType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-packagetype)` propriété d'une `AWS::Lambda::Function` ressource.

 `PermissionsBoundary`   <a name="sam-function-permissionsboundary"></a>
L'ARN d'une limite d'autorisations à utiliser pour le rôle d'exécution de cette fonction. Cette propriété ne fonctionne que si le rôle est généré pour vous.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[PermissionsBoundary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-permissionsboundary)` propriété d'une `AWS::IAM::Role` ressource.

 `Policies`   <a name="sam-function-policies"></a>
Politiques d'autorisation pour cette fonction. Les politiques seront ajoutées au rôle d'exécution par défaut Gestion des identités et des accès AWS (IAM) de la fonction.  
Cette propriété accepte une valeur unique ou une liste de valeurs. Les valeurs autorisées sont les suivantes :  
+ [Modèles de politique AWS SAM](serverless-policy-templates.md).
+ L'ARN d'une [politique gérée par AWS](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#aws-managed-policies) ou d'une [politique gérée par le client](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#customer-managed-policies).
+ Le nom d'une politique AWS gérée dans la [liste](https://github.com/aws/serverless-application-model/blob/develop/samtranslator/internal/data/aws_managed_policies.json) suivante.
+ Une [politique IAM en ligne](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#inline-policies) formatée dans YAML sous forme de mappage.
Si vous définissez la propriété `Role`, cette propriété est ignorée.
*Type* : chaîne \$1 liste \$1 carte  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est similaire à celle `[Policies](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-policies)` d'une `AWS::IAM::Role` ressource.

 `PublishToLatestPublished`   <a name="sam-function-publishtolatestpublished"></a>
Spécifie s'il faut publier la dernière version de la fonction lors de la mise à jour de la fonction.  
*Type* : valeur booléenne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[PublishToLatestPublished](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-publishtolatestpublished)` propriété d'une `AWS::Lambda::Function` ressource.

`PropagateTags`  <a name="sam-function-propagatetags"></a>
Indiquez s'il faut ou non transmettre les balises de la propriété `Tags` aux ressources [AWS::Serverless::Function](sam-specification-generated-resources-function.md) que vous avez générées. Spécifiez `True` pour la propagation des balises dans vos ressources générées.  
*Type* : valeur booléenne  
*Obligatoire* : non  
*Par défaut* : `False`  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `ProvisionedConcurrencyConfig`   <a name="sam-function-provisionedconcurrencyconfig"></a>
La configuration de la simultanéité allouée pour l'alias d'une fonction.  
`ProvisionedConcurrencyConfig` peut être spécifiée uniquement si `AutoPublishAlias` est définie. Si vous ne le faites pas, une erreur se produit.
*Type :* [ProvisionedConcurrencyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-provisionedconcurrencyconfig)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ProvisionedConcurrencyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-provisionedconcurrencyconfig)` propriété d'une `AWS::Lambda::Alias` ressource.

 `RecursiveLoop`   <a name="sam-function-recursiveloop"></a>
État de la configuration de détection de boucle récursive de votre fonction.  
Lorsque cette valeur est définie sur `Allow` et que Lambda détecte que votre fonction est invoquée dans le cadre d'une boucle récursive, aucune action n'est entreprise.  
Lorsque cette valeur est définie sur `Terminate` et que Lambda détecte que votre fonction est invoquée dans le cadre d'une boucle récursive, il arrête l'appel de votre fonction et vous en informe.   
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[RecursiveLoop](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-recursiveloop)` propriété de la `AWS::Lambda::Function` ressource.

 `ReservedConcurrentExecutions`   <a name="sam-function-reservedconcurrentexecutions"></a>
Le nombre maximum d'exécutions simultanées à réserver pour la fonction.  
Pour plus d'informations sur cette propriété, consultez [Mise à échelle de fonction Lambda](https://docs.aws.amazon.com/lambda/latest/dg/scaling.html) dans le *Guide du développeur AWS Lambda *.  
*Type* : entier  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ReservedConcurrentExecutions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-reservedconcurrentexecutions)` propriété d'une `AWS::Lambda::Function` ressource.

 `Role`   <a name="sam-function-role"></a>
L'ARN d'un rôle IAM à utiliser comme rôle d'exécution de cette fonction.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est similaire à celle `[Role](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-role)` d'une `AWS::Lambda::Function` ressource. Cela est obligatoire dans CloudFormation mais pas dans AWS SAM. Si aucun rôle n'est spécifié, un rôle est créé pour vous avec une ID logique de `<function-logical-id>Role`.

 `RolePath`   <a name="sam-function-rolepath"></a>
Chemin d'accès du rôle d'exécution IAM de la fonction.  
Utilisez cette propriété lorsque le rôle est généré pour vous. Ne l'utilisez pas lorsque le rôle est spécifié avec la propriété `Role`.  
*Type* : chaîne  
*Obligatoire* : Conditionnelle  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[Path](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-path)` propriété d'une `AWS::IAM::Role` ressource.

 `Runtime`   <a name="sam-function-runtime"></a>
Identifiant de l’[exécution](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) de la fonction. Cette propriété n'est requise que si la propriété `PackageType` est définie sur `Zip`.  
Si vous spécifiez l'`provided`identifiant de cette propriété, vous pouvez utiliser l'attribut `Metadata` resource pour demander de AWS SAM créer le runtime personnalisé requis par cette fonction. Pour plus d'informations sur la création d'une exécution personnalisée, consultez [Création de fonctions Lambda avec des environnements d'exécution personnalisés dans AWS SAM](building-custom-runtimes.md).
*Type* : chaîne  
*Obligatoire* : Conditionnelle  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[Runtime](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-runtime)` propriété d'une `AWS::Lambda::Function` ressource.

 `RuntimeManagementConfig`   <a name="sam-function-runtimemanagementconfig"></a>
Configurez les options de gestion de l'exécution pour vos fonctions Lambda, telles que les mises à jour de l'environnement d'exécution, le comportement d'annulation et la sélection d'une version d'exécution spécifique. Pour en savoir plus, consultez les [mises à jour du temps d'exécution Lambda](https://docs.aws.amazon.com//lambda/latest/dg/runtimes-update.html) dans le *Guide du développeur AWS Lambda *.  
*Type :* [RuntimeManagementConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-runtimemanagementconfig.html)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ RuntimeManagementConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-runtimemanagementconfig.html)` propriété d'une `AWS::Lambda::Function` ressource.

 `SnapStart`   <a name="sam-function-snapstart"></a>
Créez un instantané de toute nouvelle version de fonction Lambda. Un instantané est un état mis en cache de votre fonction initialisée, y compris de toutes ses dépendances. La fonction n'est initialisée qu'une seule fois et l'état mis en cache est réutilisé pour tous les appels futurs, ce qui améliore les performances de l'application en réduisant le nombre de fois que votre fonction doit être initialisée. Pour en savoir plus, consultez [la section Améliorer les performances de démarrage avec Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) dans le guide du *AWS Lambda développeur*.  
*Type :* [SnapStart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-snapstart.html)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[SnapStart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-snapstart.html)` propriété d'une `AWS::Lambda::Function` ressource.

 `SourceKMSKeyArn`   <a name="sam-function-sourcekmskeyarn"></a>
Représente un ARN de clé KMS utilisé pour chiffrer le code de fonction ZIP du client.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[SourceKMSKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-sourcekmskeyarn)` propriété d'un type de `AWS::Lambda::Function` `Code` données.

 `Tags`   <a name="sam-function-tags"></a>
Un mappage (chaîne à chaîne) qui spécifie les balises ajoutées à cette fonction. Pour en savoir plus sur les clés et les valeurs valides pour les étiquettes, consultez [Exigences relatives à la clé et à la valeur des étiquettes ](https://docs.aws.amazon.com/lambda/latest/dg/configuration-tags.html#configuration-tags-restrictions) dans le *guide du développeur AWS Lambda *.  
Lorsque la pile est créée, ajoute AWS SAM automatiquement une `lambda:createdBy:SAM` balise à cette fonction Lambda et aux rôles par défaut générés pour cette fonction.  
*Type*: carte (map)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est similaire à celle `[Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tags)` d'une `AWS::Lambda::Function` ressource. La `Tags` propriété in AWS SAM est constituée de paires clé-valeur (alors que dans CloudFormation cette propriété, elle consiste en une liste d'`Tag`objets). Ajoute également AWS SAM automatiquement une `lambda:createdBy:SAM` balise à cette fonction Lambda et aux rôles par défaut générés pour cette fonction.

 `TenancyConfig`   <a name="sam-function-tenancyconfig"></a>
Configuration pour le mode d'isolation des locataires Lambda. Garantit que les environnements d'exécution ne sont jamais partagés entre différents locataires IDs, offrant ainsi une isolation au niveau du calcul pour les applications multi-locataires.  
*Type :* [TenancyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-tenancyconfig.html)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[TenancyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tenancyconfig)` propriété d'une `AWS::Lambda::Function` ressource.

 `Timeout`   <a name="sam-function-timeout"></a>
La durée maximale en secondes pendant laquelle la fonction peut s'exécuter avant qu'elle ne soit arrêtée.  
*Type* : entier  
*Obligatoire* : non  
*Par défaut *: 3  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[Timeout](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-timeout)` propriété d'une `AWS::Lambda::Function` ressource.

 `Tracing`   <a name="sam-function-tracing"></a>
La chaîne qui spécifie le mode de traçage X-Ray de la fonction.  
+ `Active` : active le suivi X-Ray pour la fonction.
+ `Disabled` : désactive X-Ray pour la fonction.
+ `PassThrough` : active le suivi X-Ray pour la fonction. La décision d'échantillonnage est déléguée aux services en aval.
Si défini sur `Active` ou `PassThrough` et que la propriété `Role` n'est pas spécifiée, AWS SAM ajoute la stratégie `arn:aws:iam::aws:policy/AWSXrayWriteOnlyAccess` au rôle d'exécution Lambda qu'il crée pour vous.  
Pour plus d'informations sur X-Ray, consultez la section [Utiliser AWS Lambda avec AWS X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/lambda-x-ray.html) dans le *manuel du AWS Lambda développeur*.  
*Valeurs valides* : [`Active`\$1`Disabled`\$1`PassThrough`]  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est similaire à celle `[TracingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tracingconfig)` d'une `AWS::Lambda::Function` ressource.

 `VersionDescription`   <a name="sam-function-versiondescription"></a>
Spécifie le champ `Description` qui est ajouté sur la nouvelle ressource de version Lambda.  
*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-lambda-version.html#cfn-lambda-version-description)` propriété d'une `AWS::Lambda::Version` ressource.

 `VersionDeletionPolicy`   <a name="sam-function-versiondeletionpolicy"></a>
Spécifie la politique de suppression pour la ressource de version Lambda créée lorsqu'elle `AutoPublishAlias` est définie. Cela permet de contrôler si la ressource de version est conservée ou supprimée lorsque la pile est supprimée.  
*Valeurs valides* : `Delete`, `Retain` ou `Snapshot`  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent. Il définit l'`DeletionPolicy`attribut de la `AWS::Lambda::Version` ressource générée.

 `VpcConfig`   <a name="sam-function-vpcconfig"></a>
La configuration qui permet à cette fonction d'accéder aux ressources privées dans votre VPC (Virtual Private Cloud).  
*Type :* [VpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[VpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html)` propriété d'une `AWS::Lambda::Function` ressource.

## Valeurs renvoyées
<a name="sam-resource-function-return-values"></a>

### Réf
<a name="sam-resource-function-return-values-ref"></a>

Lorsque l'ID logique de cette ressource est fournie à la fonction intrinsèque `Ref`, elle renvoie le nom de la ressource Lambda sous-jacente.

Pour plus d'informations sur l'utilisation de la fonction `Ref`, consultez [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) dans le *Guide de l'utilisateur AWS CloudFormation *. 

### Ventilateur : GetAtt
<a name="sam-resource-function-return-values-fn--getatt"></a>

`Fn::GetAtt` renvoie une valeur pour un attribut de ce type indiqué. Voici les attributs disponibles et des exemples de valeurs de retour. 

Pour plus d'informations sur l'utilisation de `Fn::GetAtt`, consultez [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html) dans le *Guide de l'utilisateur AWS CloudFormation *. 

`Arn`  <a name="Arn-fn::getatt"></a>
L'ARN de la fonction Lambda sous-jacente.

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

### Fonction simple
<a name="sam-resource-function-examples-simple-function"></a>

Ce qui suit est un exemple basique d'une ressource [AWS::Serverless::Function](#sam-resource-function) du type de package `Zip` (par défaut) et du code de fonction dans un compartiment Amazon S3.

#### YAML
<a name="sam-resource-function-examples-simple-function--yaml"></a>

```
Type: AWS::Serverless::Function
Properties:
  Handler: index.handler
  Runtime: python3.9
  CodeUri: s3://bucket-name/key-name
```

### Exemple de propriétés de fonction
<a name="sam-resource-function-examples-function-properties-example"></a>

Voici un exemple d'une [AWS::Serverless::Function](#sam-resource-function) de type de package `Zip` (par défaut) qui utilise `InlineCode`, `Layers`, `Tracing`, `Policies`, `Amazon EFS`, et une source d'événement `Api`.

#### YAML
<a name="sam-resource-function-examples-function-properties-example--yaml"></a>

```
Type: AWS::Serverless::Function
DependsOn: MyMountTarget        # This is needed if an AWS::EFS::MountTarget resource is declared for EFS
Properties:
  Handler: index.handler
  Runtime: python3.9
  InlineCode: |
    def handler(event, context):
      print("Hello, world!")
  ReservedConcurrentExecutions: 30
  Layers:
    - Ref: MyLayer
  Tracing: Active
  Timeout: 120
  FileSystemConfigs:
    - Arn: !Ref MyEfsFileSystem
      LocalMountPath: /mnt/EFS
  Policies:
    - AWSLambdaExecute
    - Version: '2012-10-17		 	 	 ' 
      Statement:
        - Effect: Allow
          Action:
            - s3:GetObject
            - s3:GetObjectACL
          Resource: 'arn:aws:s3:::sam-s3-demo-bucket/*'
  Events:
    ApiEvent:
      Type: Api
      Properties:
        Path: /path
        Method: get
```

### ImageConfig exemple
<a name="sam-resource-function-examples-imageconfig-example"></a>

Voici un exemple d'`ImageConfig` pour une fonction Lambda de type de package `Image`.

#### YAML
<a name="sam-resource-function-examples-imageconfig-example--yaml"></a>

```
HelloWorldFunction:
  Type: AWS::Serverless::Function
  Properties:
    PackageType: Image
    ImageUri: account-id.dkr.ecr.region.amazonaws.com/ecr-repo-name:image-name
    ImageConfig:
      Command:
        - "app.lambda_handler"
      EntryPoint:
        - "entrypoint1"
      WorkingDirectory: "workDir"
```

### RuntimeManagementConfig exemples
<a name="sam-resource-function-examples-runtimemanagementconfig-examples"></a>

Une fonction Lambda configurée pour mettre à jour son environnement d'exécution en fonction du comportement actuel :

```
TestFunction
  Type: AWS::Serverless::Function
  Properties:
    ...
    Runtime: python3.9
    RuntimeManagementConfig:
      UpdateRuntimeOn: Auto
```

Une fonction Lambda configurée pour mettre à jour son environnement d'exécution lorsque la fonction est mise à jour :

```
TestFunction
  Type: AWS::Serverless::Function
  Properties:
    ...
    Runtime: python3.9
    RuntimeManagementConfig:
      UpdateRuntimeOn: FunctionUpdate
```

Une fonction Lambda configurée pour mettre à jour manuellement son environnement d'exécution :

```
TestFunction
  Type: AWS::Serverless::Function
  Properties:
    ...
    Runtime: python3.9
    RuntimeManagementConfig:
      RuntimeVersionArn: arn:aws:lambda:us-east-1::runtime:4c459dd0104ee29ec65dcad056c0b3ddbe20d6db76b265ade7eda9a066859b1e
      UpdateRuntimeOn: Manual
```

### SnapStart exemples
<a name="sam-resource-function-examples-snapstart-examples"></a>

Exemple de fonction Lambda SnapStart activée pour les futures versions :

```
TestFunc
  Type: AWS::Serverless::Function
  Properties:
    ...
    SnapStart:
      ApplyOn: PublishedVersions
```

### TenancyConfig exemples
<a name="sam-resource-function-examples-tenancyconfig-examples"></a>

Exemple de fonction Lambda avec le mode d'isolation des locataires activé :

```
TestFunction
  Type: AWS::Serverless::Function
  Properties:
    ...
    TenancyConfig:
      TenantIsolationMode: PER_TENANT
```

# DeadLetterQueue
<a name="sam-property-function-deadletterqueue"></a>

Spécifie une file d'attente SQS ou une rubrique SNS à laquelle ( AWS Lambda Lambda) envoie des événements lorsqu'elle ne peut pas les traiter. Pour en savoir plus sur la fonctionnalité de file d'attente de lettres mortes, consultez [File d'attente de lettres mortes](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async-retain-records.html#invocation-dlq) dans le *Guide du développeur AWS Lambda *.

SAM ajoutera automatiquement l'autorisation appropriée à votre rôle d'exécution de fonction Lambda pour permettre au service Lambda d'accéder à la ressource. sqs : SendMessage sera ajouté pour les files d'attente SQS et SNS:Publish pour les rubriques SNS.

## Syntaxe
<a name="sam-property-function-deadletterqueue-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-deadletterqueue-syntax.yaml"></a>

```
  [TargetArn](#sam-function-deadletterqueue-targetarn): String
  [Type](#sam-function-deadletterqueue-type): String
```

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

 `TargetArn`   <a name="sam-function-deadletterqueue-targetarn"></a>
L'Amazon Resource Name (ARN) d'une file d'attente Amazon SQS ou d'une rubrique Amazon SNS.  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[TargetArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-deadletterconfig.html#cfn-lambda-function-deadletterconfig-targetarn)` propriété du type de `AWS::Lambda::Function` `DeadLetterConfig` données.

 `Type`   <a name="sam-function-deadletterqueue-type"></a>
Le type de file d'attente de lettres mortes.  
*Valeurs valides *: `SNS`, `SQS`  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

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

### DeadLetterQueue
<a name="sam-property-function-deadletterqueue--examples--deadletterqueue"></a>

Exemple de file d'attente de lettres mortes pour une rubrique SNS.

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

```
DeadLetterQueue:
  Type: SNS
  TargetArn: arn:aws:sns:us-east-2:123456789012:my-topic
```

# DeploymentPreference
<a name="sam-property-function-deploymentpreference"></a>

Spécifie les configurations permettant d'activer les déploiements Lambda progressifs. Pour plus d'informations sur les configurations de déploiement progressif Lambda, consultez [Déploiement progressif d'applications sans serveur avec AWS SAM](automating-updates-to-serverless-apps.md).

**Note**  
Vous devez spécifier un `AutoPublishAlias` dans votre fonction [AWS::Serverless::Function](sam-resource-function.md) pour utiliser un objet `DeploymentPreference`. Si vous ne le faites pas, une erreur se produit.

## Syntaxe
<a name="sam-property-function-deploymentpreference-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-deploymentpreference-syntax.yaml"></a>

```
  [Alarms](#sam-function-deploymentpreference-alarms): List
  [Enabled](#sam-function-deploymentpreference-enabled): Boolean
  [Hooks](#sam-function-deploymentpreference-hooks): Hooks
  [PassthroughCondition](#sam-function-deploymentpreference-passthroughcondition): Boolean
  [Role](#sam-function-deploymentpreference-role): String
  [TriggerConfigurations](#sam-function-deploymentpreference-triggerconfigurations): List
  [Type](#sam-function-deploymentpreference-type): String
```

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

 `Alarms`   <a name="sam-function-deploymentpreference-alarms"></a>
Liste des CloudWatch alarmes que vous souhaitez déclencher en cas d'erreur provoquée par le déploiement.  
Cette propriété accepte la fonction intrinsèque `Fn::If`. Reportez-vous à la section Exemples au bas de cette rubrique pour obtenir un exemple de modèle qui utilise `Fn::If`.  
*Type* : liste  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `Enabled`   <a name="sam-function-deploymentpreference-enabled"></a>
Indique si cette préférence de déploiement est activée.  
*Type* : valeur booléenne  
*Obligatoire* : non  
*Valeur par défaut* : VRAI  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `Hooks`   <a name="sam-function-deploymentpreference-hooks"></a>
Validation des fonctions Lambda qui sont exécutées avant et après le déplacement du trafic.  
*Type* : [crochets](sam-property-function-hooks.md)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `PassthroughCondition`   <a name="sam-function-deploymentpreference-passthroughcondition"></a>
Si la valeur est True, et si cette préférence de déploiement est activée, la condition de la fonction sera transmise à la CodeDeploy ressource générée. En règle générale, vous devez définir cette valeur sur True (Vrai). Dans le cas contraire, la CodeDeploy ressource serait créée même si la condition de la fonction prend la valeur False.  
*Type* : valeur booléenne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `Role`   <a name="sam-function-deploymentpreference-role"></a>
Un ARN de rôle IAM qui CodeDeploy sera utilisé pour le transfert du trafic. Un rôle IAM ne sera pas créé si cela est fourni.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `TriggerConfigurations`   <a name="sam-function-deploymentpreference-triggerconfigurations"></a>
Une liste des configurations de déclenchement que vous souhaitez associer au groupe de déploiement. Utilisé pour notifier une rubrique SNS sur les événements du cycle de vie.  
*Type* : liste  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[TriggerConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-triggerconfigurations)` propriété d'une `AWS::CodeDeploy::DeploymentGroup` ressource.

 `Type`   <a name="sam-function-deploymentpreference-type"></a>
Il existe actuellement deux catégories de types de déploiement : Linéaire et Canary. Pour plus d'informations sur les types de déploiements, consultez [Déploiement progressif d'applications sans serveur avec AWS SAM](automating-updates-to-serverless-apps.md).  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

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

### DeploymentPreference avec des crochets avant et après le trafic.
<a name="sam-property-function-deploymentpreference--examples--deploymentpreference-with-pre--and-post-traffic-hooks."></a>

Exemple de préférence de déploiement contenant des crochets pré- et post-trafic.

#### YAML
<a name="sam-property-function-deploymentpreference--examples--deploymentpreference-with-pre--and-post-traffic-hooks.--yaml"></a>

```
DeploymentPreference:
  Enabled: true
  Type: Canary10Percent10Minutes 
  Alarms:
    - !Ref: AliasErrorMetricGreaterThanZeroAlarm
    - !Ref: LatestVersionErrorMetricGreaterThanZeroAlarm
  Hooks:
    PreTraffic:
      !Ref: PreTrafficLambdaFunction
    PostTraffic:
      !Ref: PostTrafficLambdaFunction
```

### DeploymentPreference avec fonction intrinsèque Fn : :If
<a name="sam-property-function-deploymentpreference--examples--deploymentpreference-with-fn::if-intrinsic-function"></a>

Exemple de préférence de déploiement qui utilise `Fn::If` pour configurer les alarmes. Dans cet exemple,`Alarm1` sera configuré si `MyCondition` est `true`, et `Alarm2` et `Alarm5` seront configurés si `MyCondition` est `false`.

#### YAML
<a name="sam-property-function-deploymentpreference--examples--deploymentpreference-with-fn::if-intrinsic-function--yaml"></a>

```
DeploymentPreference:
  Enabled: true
  Type: Canary10Percent10Minutes 
  Alarms:
    Fn::If:
      - MyCondition
      - - Alarm1
      - - Alarm2
        - Alarm5
```

# Hooks
<a name="sam-property-function-hooks"></a>

Validation des fonctions Lambda qui sont exécutées avant et après le déplacement du trafic.

**Note**  
Les fonctions Lambda référencées dans cette propriété configurent l'objet `CodeDeployLambdaAliasUpdate` de la ressource [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html) qui en résulte. Pour plus d'informations, consultez la section [CodeDeployLambdaAliasUpdate Politique](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-codedeploylambdaaliasupdate) du *guide de AWS CloudFormation l'utilisateur*.

## Syntaxe
<a name="sam-property-function-hooks-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-hooks-syntax.yaml"></a>

```
  [PostTraffic](#sam-function-hooks-posttraffic): String
  [PreTraffic](#sam-function-hooks-pretraffic): String
```

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

 `PostTraffic`   <a name="sam-function-hooks-posttraffic"></a>
Fonction Lambda qui est exécutée après le déplacement du trafic.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `PreTraffic`   <a name="sam-function-hooks-pretraffic"></a>
Fonction Lambda qui est exécutée avant le déplacement du trafic.  
*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-hooks--examples"></a>

### Crochets
<a name="sam-property-function-hooks--examples--hooks"></a>

Exemple de fonctions de crochet

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

```
Hooks:
  PreTraffic:
    Ref: PreTrafficLambdaFunction
  PostTraffic:
    Ref: PostTrafficLambdaFunction
```

# DurableConfig
<a name="sam-property-function-durableconfig"></a>

Configure les paramètres d'exécution durables des AWS Lambda fonctions. Les fonctions durables peuvent fonctionner jusqu'à un an et contrôler automatiquement la progression des points de travail, ce qui permet des flux de travail de longue durée et des applications tolérantes aux pannes. Pour plus d'informations sur les fonctions durables, consultez la section [Fonctions durables Lambda](https://docs.aws.amazon.com/lambda/latest/dg/durable-functions.html) dans le Guide du *AWS Lambda développeur*.

## Syntaxe
<a name="sam-property-function-durableconfig-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-durableconfig-syntax.yaml"></a>

```
  [ExecutionTimeout](#sam-function-durableconfig-executiontimeout): Integer
  [RetentionPeriodInDays](#sam-function-durableconfig-retentionperiodindays): Integer
```

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

 `ExecutionTimeout`   <a name="sam-function-durableconfig-executiontimeout"></a>
Durée (en secondes) pendant laquelle Lambda permet à une fonction durable de s'exécuter avant de l'arrêter. Le maximum est d'une année de 366 jours ou 31 622 400 secondes.  
*Type* : entier  
*Obligatoire* : oui  
*Minimum* : 1  
*Maximum* : 31622400  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ExecutionTimeout](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-durableconfig.html#cfn-lambda-function-durableconfig-executiontimeout)` propriété du type de `AWS::Lambda::Function` `DurableConfig` données.

 `RetentionPeriodInDays`   <a name="sam-function-durableconfig-retentionperiodindays"></a>
Le nombre de jours après la clôture d'une exécution durable pendant lesquels Lambda conserve son historique, de un à 90 jours. La durée par défaut est de 14 jours.  
*Type* : entier  
*Obligatoire* : non  
*Par défaut* : 14  
*Minimum* : 1  
*Maximum* : 90  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[RetentionPeriodInDays](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-durableconfig.html#cfn-lambda-function-durableconfig-retentionperiodindays)` propriété du type de `AWS::Lambda::Function` `DurableConfig` données.

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

### DurableConfig
<a name="sam-property-function-durableconfig--examples--durableconfig"></a>

Exemple de configuration durable pour une fonction avec un délai d'exécution d'une heure et une période de rétention de 7 jours.

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

```
DurableConfig:
  ExecutionTimeout: 3600
  RetentionPeriodInDays: 7
```

# EventInvokeConfiguration
<a name="sam-property-function-eventinvokeconfiguration"></a>

Options de configuration pour les appels Lambda Alias ou Version [Asynchrones](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html).

## Syntaxe
<a name="sam-property-function-eventinvokeconfiguration-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-eventinvokeconfiguration-syntax.yaml"></a>

```
  [DestinationConfig](#sam-function-eventinvokeconfiguration-destinationconfig): EventInvokeDestinationConfiguration
  [MaximumEventAgeInSeconds](#sam-function-eventinvokeconfiguration-maximumeventageinseconds): Integer
  [MaximumRetryAttempts](#sam-function-eventinvokeconfiguration-maximumretryattempts): Integer
```

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

 `DestinationConfig`   <a name="sam-function-eventinvokeconfiguration-destinationconfig"></a>
Objet de configuration qui spécifie la destination d'un événement après son traitement par Lambda.  
*Type :* [EventInvokeDestinationConfiguration](sam-property-function-eventinvokedestinationconfiguration.md)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est similaire à celle `[DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig.html)` d'une `AWS::Lambda::EventInvokeConfig` ressource. SAM nécessite un paramètre supplémentaire, « Type », qui n'existe pas dans CloudFormation.

 `MaximumEventAgeInSeconds`   <a name="sam-function-eventinvokeconfiguration-maximumeventageinseconds"></a>
Âge maximum d’une demande que Lambda envoie à une fonction pour traitement.  
*Type* : entier  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[MaximumEventAgeInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-maximumeventageinseconds)` propriété d'une `AWS::Lambda::EventInvokeConfig` ressource.

 `MaximumRetryAttempts`   <a name="sam-function-eventinvokeconfiguration-maximumretryattempts"></a>
Nombre maximal de tentatives autorisées avant que la fonction renvoie une erreur.  
*Type* : entier  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[MaximumRetryAttempts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-maximumretryattempts)` propriété d'une `AWS::Lambda::EventInvokeConfig` ressource.

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

### MaximumEventAgeInSeconds
<a name="sam-property-function-eventinvokeconfiguration--examples--maximumeventageinseconds"></a>

MaximumEventAgeInSeconds exemple

#### YAML
<a name="sam-property-function-eventinvokeconfiguration--examples--maximumeventageinseconds--yaml"></a>

```
EventInvokeConfig:
  MaximumEventAgeInSeconds: 60
  MaximumRetryAttempts: 2
  DestinationConfig:
    OnSuccess:
      Type: SQS
      Destination: arn:aws:sqs:us-west-2:012345678901:my-queue
    OnFailure:
      Type: Lambda
      Destination: !GetAtt DestinationLambda.Arn
```

# EventInvokeDestinationConfiguration
<a name="sam-property-function-eventinvokedestinationconfiguration"></a>

Objet de configuration qui spécifie la destination d'un événement après son traitement par Lambda.

## Syntaxe
<a name="sam-property-function-eventinvokedestinationconfiguration-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-eventinvokedestinationconfiguration-syntax.yaml"></a>

```
  [OnFailure](#sam-function-eventinvokedestinationconfiguration-onfailure): OnFailure
  [OnSuccess](#sam-function-eventinvokedestinationconfiguration-onsuccess): OnSuccess
```

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

 `OnFailure`   <a name="sam-function-eventinvokedestinationconfiguration-onfailure"></a>
Destination des événements dont le traitement a échoué.  
*Type :* [OnFailure](sam-property-function-onfailure.md)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est similaire à celle `[OnFailure](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-onfailure.html)` d'une `AWS::Lambda::EventInvokeConfig` ressource. Nécessite `Type`, une propriété SAM-only supplémentaire.

 `OnSuccess`   <a name="sam-function-eventinvokedestinationconfiguration-onsuccess"></a>
Destination des événements traités avec succès.  
*Type :* [OnSuccess](sam-property-function-onsuccess.md)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est similaire à celle `[OnSuccess](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-onsuccess)` d'une `AWS::Lambda::EventInvokeConfig` ressource. Nécessite `Type`, une propriété SAM-only supplémentaire.

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

### OnSuccess
<a name="sam-property-function-eventinvokedestinationconfiguration--examples--onsuccess"></a>

OnSuccess exemple

#### YAML
<a name="sam-property-function-eventinvokedestinationconfiguration--examples--onsuccess--yaml"></a>

```
EventInvokeConfig:
  DestinationConfig:
    OnSuccess:
      Type: SQS
      Destination: arn:aws:sqs:us-west-2:012345678901:my-queue
    OnFailure:
      Type: Lambda
      Destination: !GetAtt DestinationLambda.Arn
```

# OnFailure
<a name="sam-property-function-onfailure"></a>

Destination des événements dont le traitement a échoué.

## Syntaxe
<a name="sam-property-function-onfailure-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-onfailure-syntax.yaml"></a>

```
  [Destination](#sam-function-onfailure-destination): String
  [Type](#sam-function-onfailure-type): String
```

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

 `Destination`   <a name="sam-function-onfailure-destination"></a>
Amazon Resource Name (ARN) de la ressource de destination.  
*Type* : chaîne  
*Obligatoire* : Conditionnelle  
*CloudFormation compatibilité* : cette propriété est similaire à celle `[OnFailure](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-onfailure.html)` d'une `AWS::Lambda::EventInvokeConfig` ressource. SAM ajoute toutes les autorisations nécessaires au rôle IAM généré automatiquement associé à cette fonction pour accéder à la ressource référencée dans cette propriété.  
*Remarques supplémentaires* : Si le type est Lambda/EventBridge, Destination est obligatoire.

 `Type`   <a name="sam-function-onfailure-type"></a>
Type de la ressource référencée dans la destination. Les types pris en charge sont `SQS` `SNS``S3`,`Lambda`, et`EventBridge`.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.  
*Remarques supplémentaires* : Si le type est SQS/SNS et que la `Destination` propriété est laissée vide, la SQS/SNS ressource est générée automatiquement par SAM. Pour référencer la ressource, utilisez `<function-logical-id>.DestinationQueue` pour SQS ou `<function-logical-id>.DestinationTopic` pour SNS. Si le type est Lambda/EventBridge, `Destination` c'est obligatoire.

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

### EventInvoke Exemple de configuration avec des destinations SQS et Lambda
<a name="sam-property-function-onfailure--examples--eventinvoke-configuration-example-with-sqs-and-lambda-destinations"></a>

Dans cet exemple, aucune destination n'est donnée pour la OnSuccess configuration SQS. SAM crée donc implicitement une file d'attente SQS et ajoute les autorisations nécessaires. Dans cet exemple également, une destination pour une ressource Lambda déclarée dans le fichier modèle est spécifiée dans la OnFailure configuration. SAM ajoute donc les autorisations nécessaires à cette fonction Lambda pour appeler la fonction Lambda de destination.

#### YAML
<a name="sam-property-function-onfailure--examples--eventinvoke-configuration-example-with-sqs-and-lambda-destinations--yaml"></a>

```
EventInvokeConfig:
  DestinationConfig:
    OnSuccess:
      Type: SQS
    OnFailure:
      Type: Lambda
      Destination: !GetAtt DestinationLambda.Arn  # Arn of a Lambda function declared in the template file.
```

### EventInvoke Exemple de configuration avec destination SNS
<a name="sam-property-function-onfailure--examples--eventinvoke-configuration-example-with-sns-destination"></a>

Dans cet exemple, une destination est donnée pour une rubrique SNS déclarée dans le fichier modèle de OnSuccess configuration.

#### YAML
<a name="sam-property-function-onfailure--examples--eventinvoke-configuration-example-with-sns-destination--yaml"></a>

```
EventInvokeConfig:
  DestinationConfig:
    OnSuccess:
      Type: SNS
      Destination:
        Ref: DestinationSNS       # Arn of an SNS topic declared in the tempate file
```

# OnSuccess
<a name="sam-property-function-onsuccess"></a>

Destination des événements traités avec succès.

## Syntaxe
<a name="sam-property-function-onsuccess-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-onsuccess-syntax.yaml"></a>

```
  [Destination](#sam-function-onsuccess-destination): String
  [Type](#sam-function-onsuccess-type): String
```

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

 `Destination`   <a name="sam-function-onsuccess-destination"></a>
L'Amazon Resource Name (ARN) de la ressource de destination.  
*Type* : chaîne  
*Obligatoire* : Conditionnelle  
*CloudFormation compatibilité* : cette propriété est similaire à celle `[OnSuccess](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-onsuccess)` d'une `AWS::Lambda::EventInvokeConfig` ressource. SAM ajoute toutes les autorisations nécessaires au rôle IAM généré automatiquement associé à cette fonction pour accéder à la ressource référencée dans cette propriété.  
*Remarques supplémentaires* : Si le type est Lambda/EventBridge, Destination est obligatoire.

 `Type`   <a name="sam-function-onsuccess-type"></a>
Type de la ressource référencée dans la destination. Les types pris en charge sont `SQS` `SNS``S3`,`Lambda`, et`EventBridge`.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.  
*Remarques supplémentaires* : Si le type est SQS/SNS et que la `Destination` propriété est laissée vide, la SQS/SNS ressource est générée automatiquement par SAM. Pour référencer la ressource, utilisez `<function-logical-id>.DestinationQueue` pour SQS ou `<function-logical-id>.DestinationTopic` pour SNS. Si le type est Lambda/EventBridge, `Destination` c'est obligatoire.

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

### EventInvoke Exemple de configuration avec des destinations SQS et Lambda
<a name="sam-property-function-onsuccess--examples--eventinvoke-configuration-example-with-sqs-and-lambda-destinations"></a>

Dans cet exemple, aucune destination n'est donnée pour la OnSuccess configuration SQS. SAM crée donc implicitement une file d'attente SQS et ajoute les autorisations nécessaires. Dans cet exemple également, une destination pour une ressource Lambda déclarée dans le fichier modèle est spécifiée dans la OnFailure configuration. SAM ajoute donc les autorisations nécessaires à cette fonction Lambda pour appeler la fonction Lambda de destination.

#### YAML
<a name="sam-property-function-onsuccess--examples--eventinvoke-configuration-example-with-sqs-and-lambda-destinations--yaml"></a>

```
EventInvokeConfig:
  DestinationConfig:
    OnSuccess:
      Type: SQS
    OnFailure:
      Type: Lambda
      Destination: !GetAtt DestinationLambda.Arn  # Arn of a Lambda function declared in the template file.
```

### EventInvoke Exemple de configuration avec destination SNS
<a name="sam-property-function-onsuccess--examples--eventinvoke-configuration-example-with-sns-destination"></a>

Dans cet exemple, une destination est donnée pour une rubrique SNS déclarée dans le fichier modèle de OnSuccess configuration.

#### YAML
<a name="sam-property-function-onsuccess--examples--eventinvoke-configuration-example-with-sns-destination--yaml"></a>

```
EventInvokeConfig:
  DestinationConfig:
    OnSuccess:
      Type: SNS
      Destination:
        Ref: DestinationSNS       # Arn of an SNS topic declared in the tempate file
```

# EventSource
<a name="sam-property-function-eventsource"></a>

L'objet décrivant la source des événements qui déclenchent la fonction. Chaque événement se compose d'un type et d'un ensemble de propriétés qui dépendent de ce type. Pour plus d'informations sur les propriétés de chaque source d'événement, consultez la rubrique correspondant à ce type.

## Syntaxe
<a name="sam-property-function-eventsource-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-eventsource-syntax.yaml"></a>

```
  [Properties](#sam-function-eventsource-properties): AlexaSkill | Api | CloudWatchEvent | CloudWatchLogs | Cognito | DocumentDB | DynamoDB | EventBridgeRule | HttpApi | IoTRule | Kinesis | MQ | MSK | S3 | Schedule | ScheduleV2 | SelfManagedKafka | SNS | SQS
  [Type](#sam-function-eventsource-type): String
```

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

 `Properties`   <a name="sam-function-eventsource-properties"></a>
Objet décrivant les propriétés de ce mappage de cet événement. L'ensemble de propriétés doit être conforme au Type défini.  
*Type* [[[[[: [AlexaSkill](sam-property-function-alexaskill.md)\$1 [Api](sam-property-function-api.md) \$1 \$1 [CloudWatchEvent](sam-property-function-cloudwatchevent.md)\$1 [Cognito [CloudWatchLogs](sam-property-function-cloudwatchlogs.md)](sam-property-function-cognito.md)\$1 DocumentDB \$1 [[DynamoDB](sam-property-function-dynamodb.md)](sam-property-function-documentdb.md) \$1 \$1 \$1 Io \$1 [Kinesis \$1 MQ EventBridgeRule HttpApi [[HttpApi](sam-property-function-httpapi.md)](sam-property-function-eventbridgerule.md)\$1 [MSK TRule](sam-property-function-iotrule.md) \$1 S3 \$1 Planification](sam-property-function-kinesis.md)[\$1 [ScheduleV2 \$1 \$1](sam-property-function-mq.md) SNS \$1 SQS [SelfManagedKafka](sam-property-function-selfmanagedkafka.md)](sam-property-function-msk.md)](sam-property-function-sqs.md)](sam-property-function-sns.md)](sam-property-function-schedulev2.md)](sam-property-function-schedule.md)](sam-property-function-s3.md)  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `Type`   <a name="sam-function-eventsource-type"></a>
Type d’événement.  
*Valeurs valides *: `AlexaSkill`, `Api`, `CloudWatchEvent`, `CloudWatchLogs`, `Cognito`, `DocumentDB`, `DynamoDB`, `EventBridgeRule`, `HttpApi`, `IoTRule`, `Kinesis`, `MQ`, `MSK`, `S3`, `Schedule`, `ScheduleV2`, `SelfManagedKafka`, `SNS`, `SQS`  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

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

### APIEvent
<a name="sam-property-function-eventsource--examples--apievent"></a>

Exemple d'utilisation d'un événement API

#### YAML
<a name="sam-property-function-eventsource--examples--apievent--yaml"></a>

```
ApiEvent:
  Type: Api
  Properties:
    Method: get
    Path: /group/{user}
    RestApiId: 
      Ref: MyApi
```

# AlexaSkill
<a name="sam-property-function-alexaskill"></a>

L'objet décrivant un type de source d'événement `AlexaSkill`.

## Syntaxe
<a name="sam-property-function-alexaskill-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-alexaskill-syntax.yaml"></a>

```
  [SkillId](#sam-function-alexaskill-skillid): String
```

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

 `SkillId`   <a name="sam-function-alexaskill-skillid"></a>
L'Alexa Skill ID (ID de compétence Alexa) pour votre compétence Alexa. Pour plus d'informations sur l'ID de compétence, consultez [Configurer le déclencheur pour une fonction Lambda](https://developer.amazon.com/docs/custom-skills/host-a-custom-skill-as-an-aws-lambda-function.html#configuring-the-alexa-skills-kit-trigger) dans la documentation du Kit de compétences Alexa.  
*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-alexaskill--examples"></a>

### AlexaSkillTrigger
<a name="sam-property-function-alexaskill--examples--alexaskilltrigger"></a>

Exemple d'événement de compétence Alexa

#### YAML
<a name="sam-property-function-alexaskill--examples--alexaskilltrigger--yaml"></a>

```
AlexaSkillEvent:
  Type: AlexaSkill
```

# Api
<a name="sam-property-function-api"></a>

L'objet décrivant un type de source d'événement `Api`. Si une ressource [AWS::Serverless::Api](sam-resource-api.md) est définie, les valeurs de chemin d'accès et de méthode doivent correspondre à une opération dans la définition OpenAPI de l'API.

Si aucune [AWS::Serverless::Api](sam-resource-api.md) n'est définie, l'entrée et la sortie de la fonction sont une représentation de la demande HTTP et de la réponse HTTP.

Par exemple, à l'aide de l' JavaScript API, le code d'état et le corps de la réponse peuvent être contrôlés en renvoyant un objet avec les clés statusCode et body.

## Syntaxe
<a name="sam-property-function-api-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-api-syntax.yaml"></a>

```
  [Auth](#sam-function-api-auth): ApiFunctionAuth
  [Method](#sam-function-api-method): String
  [Path](#sam-function-api-path): String
  [RequestModel](#sam-function-api-requestmodel): RequestModel
  [RequestParameters](#sam-function-api-requestparameters): List of [ String | RequestParameter ]
  [RestApiId](#sam-function-api-restapiid): String
  [ResponseTransferMode](#sam-function-api-responsetransfermode): String
  TimeoutInMillis: Integer
```

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

 `Auth`   <a name="sam-function-api-auth"></a>
Configuration d'authentification pour cette méthode Api\$1Chemin\$1Méthode spécifique.  
Utile pour remplacer la configuration d'autorisation du paramètre de `DefaultAuthorizer` de l'API sur un chemin d'accès individuel, lorsqu'aucun `DefaultAuthorizer` n'est spécifié, ou pour remplacer le paramètre `ApiKeyRequired` par défaut.  
*Type :* [ApiFunctionAuth](sam-property-function-apifunctionauth.md)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `Method`   <a name="sam-function-api-method"></a>
Méthode HTTP pour laquelle cette fonction est appelée. Les options incluent `DELETE``GET`,`HEAD`,`OPTIONS`,`PATCH`,`POST`,`PUT`, et`ANY`. Reportez-vous à la section [Configurer une méthode HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-settings-method-request.html#setup-method-add-http-method) dans le *guide du développeur d'API Gateway* pour plus de détails.  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `Path`   <a name="sam-function-api-path"></a>
Chemin d'accès d'URI pour lequel cette fonction est appelée. Doit commencer par `/`.  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `RequestModel`   <a name="sam-function-api-requestmodel"></a>
Demander un modèle à utiliser pour cette formule Api\$1Chemin\$1Méthode spécifique. Cela devrait faire référence au nom d'un modèle spécifié dans la section `Models` d'une ressource [AWS::Serverless::Api](sam-resource-api.md).  
*Type :* [RequestModel](sam-property-function-requestmodel.md)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `RequestParameters`   <a name="sam-function-api-requestparameters"></a>
Configuration des paramètres de demande pour cette formule Api\$1Chemin\$1Méthode spécifique. Tous les noms de paramètres doivent commencer par `method.request` et doivent être limités à `method.request.header`, `method.request.querystring`, ou `method.request.path`.  
Une liste peut contenir à la fois des chaînes de noms de paramètres et [RequestParameter](sam-property-function-requestparameter.md)des objets. Pour les chaînes, les propriétés `Required` et `Caching` prendront par défaut la valeur `false`.  
*Type* : Liste de [String \$1 [RequestParameter](sam-property-function-requestparameter.md)]  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `RestApiId`   <a name="sam-function-api-restapiid"></a>
Identifiant d'une RestApi ressource, qui doit contenir une opération avec le chemin et la méthode donnés. Cela est généralement défini pour faire référence à une ressource [AWS::Serverless::Api](sam-resource-api.md), qui est définie dans ce modèle.  
Si vous ne définissez pas cette propriété, AWS SAM crée une [AWS::Serverless::Api](sam-resource-api.md) ressource par défaut à l'aide d'un `OpenApi` document généré. Cette ressource contient une union de tous les chemins et méthodes définis par `Api` dans le même modèle qui ne spécifient pas un `RestApiId`.  
Cela ne peut pas référencer une ressource [AWS::Serverless::Api](sam-resource-api.md) définie dans un autre modèle.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

`ResponseTransferMode`  <a name="sam-function-api-responsetransfermode"></a>
Mode de transfert de réponse pour l'intégration de la fonction Lambda. Définissez cette valeur `RESPONSE_STREAM` pour activer le streaming des réponses Lambda via API Gateway, ce qui permet à la fonction de renvoyer les réponses aux clients. Lorsqu'il est défini sur`RESPONSE_STREAM`, API Gateway utilise l'API Lambda InvokeWithResponseStreaming .  
*Type* : chaîne  
*Obligatoire* : non  
*Valeurs valides* : `BUFFERED` \$1 `RESPONSE_STREAM`  
*CloudFormation compatibilité* : Cette propriété est transmise directement à la [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integration.html#cfn-apigateway-method-integration-responsetransfermode](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integration.html#cfn-apigateway-method-integration-responsetransfermode)propriété d'un`AWS::ApiGateway::Method Integration`.

`TimeoutInMillis`  <a name="sam-function-api-timeoutinmillis"></a>
Délai d'attente personnalisé compris entre 50 et 29 000 millisecondes.  
Lorsque vous spécifiez cette propriété, cela AWS SAM modifie votre définition OpenAPI. La définition OpenAPI doit être spécifiée en ligne à l'aide de la propriété `DefinitionBody`. 
*Type* : entier  
*Obligatoire* : non  
*Par défaut* : 29 000 millisecondes ou 29 secondes  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

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

### Exemple de base
<a name="sam-property-function-api--examples--apievent"></a>

#### YAML
<a name="sam-property-function-api--examples--apievent--yaml"></a>

```
Events:
  ApiEvent:
    Type: Api
    Properties:
      Path: /path
      Method: get
      RequestParameters:
        - method.request.header.Authorization
        - method.request.querystring.keyword:
            Required: true
            Caching: false
```

# ApiFunctionAuth
<a name="sam-property-function-apifunctionauth"></a>

Configure l'autorisation au niveau de l'événement, pour une API, un chemin et une méthode spécifiques.

## Syntaxe
<a name="sam-property-function-apifunctionauth-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-apifunctionauth-syntax.yaml"></a>

```
  [ApiKeyRequired](#sam-function-apifunctionauth-apikeyrequired): Boolean
  [AuthorizationScopes](#sam-function-apifunctionauth-authorizationscopes): List
  [Authorizer](#sam-function-apifunctionauth-authorizer): String
  [InvokeRole](#sam-function-apifunctionauth-invokerole): String
  OverrideApiAuth: Boolean
  [ResourcePolicy](#sam-function-apifunctionauth-resourcepolicy): ResourcePolicyStatement
```

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

 `ApiKeyRequired`   <a name="sam-function-apifunctionauth-apikeyrequired"></a>
Nécessite une clé API pour cette API, ce chemin d'accès et cette méthode.  
*Type* : valeur booléenne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `AuthorizationScopes`   <a name="sam-function-apifunctionauth-authorizationscopes"></a>
Les étendues d'autorisation à appliquer à cette API, ce chemin d'accès et cette méthode.  
Les étendues que vous spécifiez remplaceront toutes les étendues appliquées par la propriété `DefaultAuthorizer` si vous l'avez spécifiée.  
*Type* : liste  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `Authorizer`   <a name="sam-function-apifunctionauth-authorizer"></a>
Le `Authorizer` pour une fonction spécifique.  
Si un mécanisme d'autorisation global est spécifié pour votre ressource `AWS::Serverless::Api`, vous pouvez remplacer le mécanisme d'autorisation en définissant `Authorizer` sur `NONE`. Pour obtenir un exemple, consultez [Remplacer un mécanisme d'autorisation global pour votre API REST Amazon API Gateway](#sam-property-function-apifunctionauth--examples--override).  
Si vous utilisez la propriété `DefinitionBody` d'une ressource `AWS::Serverless::Api` pour décrire votre API, vous devez utiliser `OverrideApiAuth` avec `Authorizer` pour remplacer votre mécanisme d'autorisation global. Pour plus d’informations, consultez `OverrideApiAuth`.
*Valeurs valides* : `AWS_IAM``NONE`, ou l'identifiant logique de tout autorisateur défini dans votre AWS SAM modèle.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `InvokeRole`   <a name="sam-function-apifunctionauth-invokerole"></a>
Spécifie le `InvokeRole` à utiliser pour l'autorisation `AWS_IAM`.  
*Type* : chaîne  
*Obligatoire* : non  
*Par défaut* : `CALLER_CREDENTIALS`  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.  
*Informations complémentaires* : `CALLER_CREDENTIALS` mappe avec `arn:aws:iam:::<user>/`, qui utilise les informations d'identification de l'appelant pour appeler le point de terminaison.

`OverrideApiAuth`  <a name="sam-function-apifunctionauth-overrideapiauth"></a>
Définissez-la sur `true` pour remplacer la configuration du mécanisme d'autorisation global de votre ressource `AWS::Serverless::Api`. Cette propriété n'est requise que si vous spécifiez un mécanisme d'autorisation global et que vous utilisez la propriété `DefinitionBody` d'une ressource `AWS::Serverless::Api` pour décrire votre API.  
Lorsque vous spécifiez `OverrideApiAuth` comme`true`, AWS SAM cela remplacera votre autorisateur global par toutes les valeurs fournies pour `ApiKeyRequired``Authorizer`, ou. `ResourcePolicy` C'est pourquoi au moins une de ces propriétés doit également être spécifiée lors de l'utilisation de `OverrideApiAuth`. Pour obtenir un exemple, consultez [Remplacer un autorisateur global lorsque DefinitionBody for est spécifié AWS::Serverless::Api](#sam-property-function-apifunctionauth--examples--override2).
*Type* : valeur booléenne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `ResourcePolicy`   <a name="sam-function-apifunctionauth-resourcepolicy"></a>
Configurez la stratégie de ressources pour ce chemin d'accès sur une API.  
*Type :* [ResourcePolicyStatement](sam-property-function-resourcepolicystatement.md)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

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

### Fonction-Auth (Autorisation fonction)
<a name="sam-property-function-apifunctionauth--examples--function-auth"></a>

L'exemple suivant spécifie l'autorisation au niveau de la fonction.

#### YAML
<a name="sam-property-function-apifunctionauth--examples--function-auth--yaml"></a>

```
Auth:
  ApiKeyRequired: true
  Authorizer: NONE
```

### Remplacer un mécanisme d'autorisation global pour votre API REST Amazon API Gateway
<a name="sam-property-function-apifunctionauth--examples--override"></a>

Vous pouvez spécifier un mécanisme d'autorisation global pour votre ressource `AWS::Serverless::Api`. Voici un exemple de configuration d'un mécanisme d'autorisation global par défaut :

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyApiWithLambdaRequestAuth:
    Type: AWS::Serverless::Api
    Properties:
      ...
      Auth:
        Authorizers:
          MyLambdaRequestAuth:
            FunctionArn: !GetAtt MyAuthFn.Arn
        DefaultAuthorizer: MyLambdaRequestAuth
```

Pour remplacer l'autorisateur par défaut pour votre AWS Lambda fonction, vous pouvez spécifier `Authorizer` comme. `NONE` Voici un exemple :

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  ...
  MyFn:
    Type: AWS::Serverless::Function
    Properties:
      ...
      Events:
        LambdaRequest:
          Type: Api
          Properties:
            RestApiId: !Ref MyApiWithLambdaRequestAuth
            Method: GET
            Auth:
              Authorizer: NONE
```

### Remplacer un autorisateur global lorsque DefinitionBody for est spécifié AWS::Serverless::Api
<a name="sam-property-function-apifunctionauth--examples--override2"></a>

Lorsque vous utilisez la propriété `DefinitionBody` pour décrire votre ressource `AWS::Serverless::Api`, la méthode de remplacement précédente ne fonctionne pas. Voici un exemple d'utilisation de la propriété `DefinitionBody` pour une ressource `AWS::Serverless::Api` :

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyApiWithLambdaRequestAuth:
    Type: AWS::Serverless::Api
    Properties:
      ...
      DefinitionBody:
        swagger: 2.0
        ...
        paths:
          /lambda-request:
            ...
      Auth:
        Authorizers:
          MyLambdaRequestAuth:
            FunctionArn: !GetAtt MyAuthFn.Arn
        DefaultAuthorizer: MyLambdaRequestAuth
```

Pour annuler le mécanisme d'autorisation global, utilisez la propriété `OverrideApiAuth`. Voici un exemple qui utilise `OverrideApiAuth` pour remplacer le mécanisme d'autorisation global par la valeur fournie pour `Authorizer` :

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyApiWithLambdaRequestAuth:
    Type: AWS::Serverless::Api
    Properties:
      ...
      DefinitionBody:
        swagger: 2-0
        ...
        paths:
          /lambda-request:
            ...
      Auth:
        Authorizers:
          MyLambdaRequestAuth:
            FunctionArn: !GetAtt MyAuthFn.Arn
        DefaultAuthorizer: MyLambdaRequestAuth
    
    MyAuthFn:
      Type: AWS::Serverless::Function
      ...
    
    MyFn:
      Type: AWS::Serverless::Function
        Properties:
          ...
          Events:
            LambdaRequest:
              Type: Api
              Properties:
                RestApiId: !Ref MyApiWithLambdaRequestAuth
                Method: GET
                Auth:
                  Authorizer: NONE
                  OverrideApiAuth: true
                Path: /lambda-token
```

# ResourcePolicyStatement
<a name="sam-property-function-resourcepolicystatement"></a>

Configure une stratégie de ressource pour toutes les méthodes et chemins d'accès d'une API. Pour plus d'informations sur les stratégies de ressources, consultez [Contrôle de l'accès à une API avec des stratégies de ressources API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-resource-policies.html) dans le *Guide du développeur API*.

## Syntaxe
<a name="sam-property-function-resourcepolicystatement-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-resourcepolicystatement-syntax.yaml"></a>

```
  [AwsAccountBlacklist](#sam-function-resourcepolicystatement-awsaccountblacklist): List
  [AwsAccountWhitelist](#sam-function-resourcepolicystatement-awsaccountwhitelist): List
  [CustomStatements](#sam-function-resourcepolicystatement-customstatements): List
  [IntrinsicVpcBlacklist](#sam-function-resourcepolicystatement-intrinsicvpcblacklist): List
  [IntrinsicVpcWhitelist](#sam-function-resourcepolicystatement-intrinsicvpcwhitelist): List
  [IntrinsicVpceBlacklist](#sam-function-resourcepolicystatement-intrinsicvpceblacklist): List
  [IntrinsicVpceWhitelist](#sam-function-resourcepolicystatement-intrinsicvpcewhitelist): List
  [IpRangeBlacklist](#sam-function-resourcepolicystatement-iprangeblacklist): List
  [IpRangeWhitelist](#sam-function-resourcepolicystatement-iprangewhitelist): List
  [SourceVpcBlacklist](#sam-function-resourcepolicystatement-sourcevpcblacklist): List
  [SourceVpcWhitelist](#sam-function-resourcepolicystatement-sourcevpcwhitelist): List
```

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

 `AwsAccountBlacklist`   <a name="sam-function-resourcepolicystatement-awsaccountblacklist"></a>
Les AWS comptes à bloquer.  
*Type* : liste de chaînes  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `AwsAccountWhitelist`   <a name="sam-function-resourcepolicystatement-awsaccountwhitelist"></a>
Les AWS comptes à autoriser. Pour obtenir un exemple d'utilisation de cette propriété, consultez la section Exemples en bas de cette page.  
*Type* : liste de chaînes  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `CustomStatements`   <a name="sam-function-resourcepolicystatement-customstatements"></a>
Une liste des instructions de stratégie de ressource personnalisées à appliquer à cette API. Pour obtenir un exemple d'utilisation de cette propriété, consultez la section Exemples en bas de cette page.  
*Type* : liste  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `IntrinsicVpcBlacklist`   <a name="sam-function-resourcepolicystatement-intrinsicvpcblacklist"></a>
La liste des clouds privés virtuels (VPCs) à bloquer, où chaque VPC est spécifié comme référence, telle qu'une [référence dynamique](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) ou une fonction `Ref` [intrinsèque](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html). Pour obtenir un exemple d'utilisation de cette propriété, consultez la section Exemples en bas de cette page.  
*Type* : liste  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `IntrinsicVpcWhitelist`   <a name="sam-function-resourcepolicystatement-intrinsicvpcwhitelist"></a>
La liste des VPCs à autoriser, où chaque VPC est spécifié comme référence, telle qu'une [référence dynamique](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) ou une fonction `Ref` [intrinsèque](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).  
*Type* : liste  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `IntrinsicVpceBlacklist`   <a name="sam-function-resourcepolicystatement-intrinsicvpceblacklist"></a>
Liste des points de terminaison VPC à bloquer, où chaque point de terminaison VPC est spécifié comme une référence telle qu'une [Référence dynamique](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) ou la [fonction intrinsèque](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) `Ref`.  
*Type* : liste  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `IntrinsicVpceWhitelist`   <a name="sam-function-resourcepolicystatement-intrinsicvpcewhitelist"></a>
Liste des points de terminaison VPC à autoriser, où chaque point de terminaison VPC est spécifié en tant que référence telle qu'une [Référence dynamique](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) ou la [fonction intrinsèque](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) `Ref`. Pour obtenir un exemple d'utilisation de cette propriété, consultez la section Exemples en bas de cette page.  
*Type* : liste  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `IpRangeBlacklist`   <a name="sam-function-resourcepolicystatement-iprangeblacklist"></a>
L'adresse IP ou les plages d'adresses à bloquer. Pour obtenir un exemple d'utilisation de cette propriété, consultez la section Exemples en bas de cette page.  
*Type* : liste  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `IpRangeWhitelist`   <a name="sam-function-resourcepolicystatement-iprangewhitelist"></a>
L'adresse IP ou les plages d'adresses à autoriser.  
*Type* : liste  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `SourceVpcBlacklist`   <a name="sam-function-resourcepolicystatement-sourcevpcblacklist"></a>
Les points de terminaison VPC ou VPC source à bloquer. Les noms de VPC source doivent commencer par `"vpc-"` et les noms de point de terminaison VPC source doivent commencer par `"vpce-"`. Pour obtenir un exemple d'utilisation de cette propriété, consultez la section Exemples en bas de cette page.  
*Type* : liste  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `SourceVpcWhitelist`   <a name="sam-function-resourcepolicystatement-sourcevpcwhitelist"></a>
Les points de terminaison VPC ou VPC source à autoriser. Les noms de VPC source doivent commencer par `"vpc-"` et les noms de point de terminaison VPC source doivent commencer par `"vpce-"`.  
*Type* : liste  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

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

### Exemples de stratégie basée sur les ressources
<a name="sam-property-function-resourcepolicystatement--examples--resource-policy-example"></a>

L'exemple suivant bloque deux adresses IP et un VPC source, et autorise un AWS compte.

#### YAML
<a name="sam-property-function-resourcepolicystatement--examples--resource-policy-example--yaml"></a>

```
Auth:
  ResourcePolicy:
    CustomStatements: [{
                         "Effect": "Allow",
                         "Principal": "*",
                         "Action": "execute-api:Invoke",
                         "Resource": "execute-api:/Prod/GET/pets",
                         "Condition": {
                           "IpAddress": {
                             "aws:SourceIp": "1.2.3.4"
                           }
                         }
                       }]
    IpRangeBlacklist:
      - "10.20.30.40"
      - "1.2.3.4"
    SourceVpcBlacklist:
      - "vpce-1a2b3c4d"
    AwsAccountWhitelist:
      - "111122223333"
    IntrinsicVpcBlacklist:
      - "{{resolve:ssm:SomeVPCReference:1}}" 
      - !Ref MyVPC
    IntrinsicVpceWhitelist:
      - "{{resolve:ssm:SomeVPCEReference:1}}" 
      - !Ref MyVPCE
```

# RequestModel
<a name="sam-property-function-requestmodel"></a>

Configure un modèle de demande pour une formule Api\$1Chemin\$1Méthode spécifique.

## Syntaxe
<a name="sam-property-function-requestmodel-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-requestmodel-syntax.yaml"></a>

```
  [Model](#sam-function-requestmodel-model): String
  [Required](#sam-function-requestmodel-required): Boolean
  [ValidateBody](#sam-function-requestmodel-validatebody): Boolean
  [ValidateParameters](#sam-function-requestmodel-validateparameters): Boolean
```

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

 `Model`   <a name="sam-function-requestmodel-model"></a>
Nom d'un modèle défini dans la propriété Modèles de la [AWS::Serverless::Api](sam-resource-api.md).  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `Required`   <a name="sam-function-requestmodel-required"></a>
Ajoute une `required` propriété dans la section des paramètres de la OpenApi définition pour le point de terminaison d'API donné.  
*Type* : valeur booléenne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `ValidateBody`   <a name="sam-function-requestmodel-validatebody"></a>
Indique si API Gateway utilise le `Model` pour valider le corps de la demande. Pour de plus amples informations, veuillez consulter [Activer la validation de demande de base pour une API sur API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html) dans le *Manuel du développeur API Gateway*.  
*Type* : valeur booléenne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `ValidateParameters`   <a name="sam-function-requestmodel-validateparameters"></a>
Spécifie si API Gateway utilise le `Model` pour valider les paramètres du chemin de la requête, les chaînes de requête et les en-têtes. Pour de plus amples informations, veuillez consulter [Activer la validation de demande de base pour une API sur API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html) dans le *Manuel du développeur API Gateway*.  
*Type* : valeur booléenne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

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

### Modèle de demande
<a name="sam-property-function-requestmodel--examples--request-model"></a>

Exemple de modèle de demande

#### YAML
<a name="sam-property-function-requestmodel--examples--request-model--yaml"></a>

```
RequestModel:
  Model: User
  Required: true
  ValidateBody: true
  ValidateParameters: true
```

# RequestParameter
<a name="sam-property-function-requestparameter"></a>

Configurez le paramètre de demande pour une formule Api\$1Chemin\$1Méthode spécifique.

La propriété `Required` ou `Caching` doit être spécifiée pour le paramètre de demande

## Syntaxe
<a name="sam-property-function-requestparameter-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-requestparameter-syntax.yaml"></a>

```
  [Caching](#sam-function-requestparameter-caching): Boolean
  [Required](#sam-function-requestparameter-required): Boolean
```

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

 `Caching`   <a name="sam-function-requestparameter-caching"></a>
Ajoute une `cacheKeyParameters` section à la OpenApi définition d'API Gateway  
*Type* : valeur booléenne  
*Obligatoire* : Conditionnelle  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `Required`   <a name="sam-function-requestparameter-required"></a>
Ce champ indique si un paramètre est nécessaire.  
*Type* : valeur booléenne  
*Obligatoire* : Conditionnelle  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

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

### Paramètre de demande
<a name="sam-property-function-requestparameter--examples--request-parameter"></a>

Exemple de définition des paramètres de demande

#### YAML
<a name="sam-property-function-requestparameter--examples--request-parameter--yaml"></a>

```
RequestParameters:
  - method.request.header.Authorization:
      Required: true
      Caching: true
```

# CloudWatchEvent
<a name="sam-property-function-cloudwatchevent"></a>

L'objet décrivant un type de source d'événement `CloudWatchEvent`.

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.

**Remarque importante** : [EventBridgeRule](sam-property-function-eventbridgerule.md) c'est le type de source d'événements préféré à utiliser, à la place de`CloudWatchEvent`. `EventBridgeRule`et `CloudWatchEvent` utilisez le même service, la même API et les mêmes CloudFormation ressources sous-jacents. Cependant, AWS SAM ajoutera la prise en charge des nouvelles fonctionnalités uniquement à`EventBridgeRule`.

## Syntaxe
<a name="sam-property-function-cloudwatchevent-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-cloudwatchevent-syntax.yaml"></a>

```
  [Enabled](#sam-function-cloudwatchevent-enabled): Boolean
  [EventBusName](#sam-function-cloudwatchevent-eventbusname): String
  [Input](#sam-function-cloudwatchevent-input): String
  [InputPath](#sam-function-cloudwatchevent-inputpath): String
  [Pattern](#sam-function-cloudwatchevent-pattern): [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)
  [State](#sam-function-cloudwatchevent-state): String
```

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

 `Enabled`   <a name="sam-function-cloudwatchevent-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`.

 `EventBusName`   <a name="sam-function-cloudwatchevent-eventbusname"></a>
Le bus d'événements à associer à cette règle. Si vous omettez cette propriété, AWS SAM utilise le bus d'événements par défaut.  
*Type* : chaîne  
*Obligatoire* : non  
*Par défaut* : bus d'événement par défaut  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[EventBusName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname)` propriété d'une `AWS::Events::Rule` ressource.

 `Input`   <a name="sam-function-cloudwatchevent-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.

 `InputPath`   <a name="sam-function-cloudwatchevent-inputpath"></a>
Lorsque vous ne voulez pas transmettre l'événement correspondant complet, utilisez la propriété `InputPath` pour décrire quelles parties de l'événement transmettre à la cible.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[InputPath](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputpath)` propriété d'une `AWS::Events::Rule Target` ressource.

 `Pattern`   <a name="sam-function-cloudwatchevent-pattern"></a>
Décrit les événements qui sont acheminés vers la cible spécifiée. Pour plus d'informations, consultez la section [Événements et modèles d'événements EventBridge dans](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) le *guide de EventBridge l'utilisateur Amazon*.  
*Type :* [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)` propriété d'une `AWS::Events::Rule` ressource.

 `State`   <a name="sam-function-cloudwatchevent-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-cloudwatchevent--examples"></a>

### CloudWatchEvent
<a name="sam-property-function-cloudwatchevent--examples--cloudwatchevent"></a>

Voici un exemple de type de source d'événement `CloudWatchEvent`.

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

```
CWEvent:
  Type: CloudWatchEvent
  Properties:
    Enabled: false
    Input: '{"Key": "Value"}'
    Pattern:
      detail:
        state:
          - running
```

# CloudWatchLogs
<a name="sam-property-function-cloudwatchlogs"></a>

L'objet décrivant un type de source d'événement `CloudWatchLogs`.

Cet événement génère une ressource [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html), puis précise un filtre d'abonnement et l'associe au groupe de journaux indiqué.

## Syntaxe
<a name="sam-property-function-cloudwatchlogs-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-cloudwatchlogs-syntax.yaml"></a>

```
  [FilterPattern](#sam-function-cloudwatchlogs-filterpattern): String
  [LogGroupName](#sam-function-cloudwatchlogs-loggroupname): String
```

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

 `FilterPattern`   <a name="sam-function-cloudwatchlogs-filterpattern"></a>
Les expressions de filtrage qui limitent ce qui est livré à la AWS ressource de destination. Pour plus d'informations sur la syntaxe de modèle de filtre, consultez [Syntaxe de filtre et de modèle](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[FilterPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-cwl-subscriptionfilter-filterpattern)` propriété d'une `AWS::Logs::SubscriptionFilter` ressource.

 `LogGroupName`   <a name="sam-function-cloudwatchlogs-loggroupname"></a>
Groupe de journaux auquel associer le filtre d'abonnement. Tous les événements de journal chargés dans ce groupe de journaux sont filtrés et transmis à la AWS ressource spécifiée si le modèle de filtre correspond aux événements du journal.  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[LogGroupName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-cwl-subscriptionfilter-loggroupname)` propriété d'une `AWS::Logs::SubscriptionFilter` ressource.

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

### Filtres d'abonnement dans les journaux CloudWatch Logs
<a name="sam-property-function-cloudwatchlogs--examples--cloudwatchlogs-subscription-filter"></a>

Exemple de filtres d'abonnement dans les journaux CloudWatch Logs

#### YAML
<a name="sam-property-function-cloudwatchlogs--examples--cloudwatchlogs-subscription-filter--yaml"></a>

```
CWLog:
  Type: CloudWatchLogs
  Properties:
    LogGroupName:
      Ref: CloudWatchLambdaLogsGroup
    FilterPattern: My pattern
```

# Cognito
<a name="sam-property-function-cognito"></a>

L'objet décrivant un type de source d'événement `Cognito`.

## Syntaxe
<a name="sam-property-function-cognito-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-cognito-syntax.yaml"></a>

```
  [Trigger](#sam-function-cognito-trigger): List
  [UserPool](#sam-function-cognito-userpool): String
```

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

 `Trigger`   <a name="sam-function-cognito-trigger"></a>
Informations relatives à la configuration des déclencheurs Lambda pour le nouveau pool d'utilisateurs.  
*Type* : liste  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[LambdaConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html)` propriété d'une `AWS::Cognito::UserPool` ressource.

 `UserPool`   <a name="sam-function-cognito-userpool"></a>
Référence à UserPool définie dans le même modèle  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

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

### Événement Cognito
<a name="sam-property-function-cognito--examples--cognito-event"></a>

Exemple d'événement Cognito

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

```
CognitoUserPoolPreSignup:
  Type: Cognito
  Properties:
    UserPool:
      Ref: MyCognitoUserPool
    Trigger: PreSignUp
```

# DocumentDB
<a name="sam-property-function-documentdb"></a>

L'objet décrivant un type de source d'événement `DocumentDB`. Pour plus d'informations, consultez la section [Utilisation AWS Lambda avec Amazon DocumentDB](https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html) dans le manuel du *AWS Lambda développeur*.

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

Pour déclarer cette entité dans votre AWS SAM modèle, utilisez la syntaxe suivante.

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

```
BatchSize: Integer
Cluster: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
CollectionName: String
DatabaseName: String
Enabled: Boolean
FilterCriteria: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
FullDocument: String
KmsKeyArn: String  
MaximumBatchingWindowInSeconds: Integer
SecretsManagerKmsKeyId: String
SourceAccessConfigurations: List
StartingPosition: String
StartingPositionTimestamp: Double
```

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

 `BatchSize`   <a name="sam-function-documentdb-batchsize"></a>
Nombre maximum d'éléments à récupérer dans un seul lot.  
*Type* : entier  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `Cluster`   <a name="sam-function-documentdb-cluster"></a>
Amazon Resource Name (ARN) du cluster Amazon DocumentDB.  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `CollectionName`   <a name="sam-function-documentdb-collectionname"></a>
Le nom de la collection à consommer dans la base de données. Si vous ne spécifiez pas de collection, Lambda consomme toutes les collections.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ CollectionName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-collectionname)` propriété d'un type de `AWS::Lambda::EventSourceMapping` `DocumentDBEventSourceConfig` données.

 `DatabaseName`   <a name="sam-function-documentdb-databasename"></a>
Le nom de la base de données à consommer dans le cluster Amazon DocumentDB.  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ DatabaseName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-databasename)` propriété d'un type de `AWS::Lambda::EventSourceMapping` `DocumentDBEventSourceConfig` données.

 `Enabled`   <a name="sam-function-documentdb-enabled"></a>
Si la valeur est `true`, le mappage de source d'événement est actif. Pour suspendre l'interrogation et l'appel, définissez ce paramètre sur `false`.  
*Type* : valeur booléenne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `FilterCriteria`   <a name="sam-function-documentdb-filtercriteria"></a>
Un objet qui définit les critères permettant de déterminer si Lambda doit traiter un événement. Pour de plus amples informations, veuillez consulter [le filtrage d'événements Lambda](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) dans le *Guide du développeur AWS Lambda *.  
*Type :* [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `FullDocument`   <a name="sam-function-documentdb-fulldocument"></a>
Détermine ce qu'Amazon DocumentDB envoie à votre flux d'événements lors des opérations de mise à jour des documents. S'il est défini sur `UpdateLookup`, Amazon DocumentDB envoie un delta décrivant les modifications, ainsi qu'une copie de l'intégralité du document. Dans le cas contraire, Amazon DocumentDB n'envoie qu'un document partiel contenant les modifications.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ FullDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-fulldocument)` propriété d'un type de `AWS::Lambda::EventSourceMapping` `DocumentDBEventSourceConfig` données.

 `KmsKeyArn`   <a name="sam-function-documentdb-kmskeyarn"></a>
Le nom de ressource Amazon (ARN) de la clé permettant de chiffrer les informations relatives à cet événement.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `MaximumBatchingWindowInSeconds`   <a name="sam-function-documentdb-maximumbatchingwindowinseconds"></a>
Intervalle de temps maximal (en secondes) pour collecter des enregistrements avant d’invoquer la fonction.  
*Type* : entier  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `SecretsManagerKmsKeyId`   <a name="sam-function-documentdb-secretsmanagerkmskeyid"></a>
L'identifiant de clé AWS Key Management Service (AWS KMS) d'une clé gérée par le client par AWS Secrets Manager. Requise lorsque vous utilisez une clé gérée par le client à partir de Secrets Manager avec un rôle d'exécution Lambda qui n'inclut pas l'autorisation `kms:Decrypt`.  
La valeur de cette propriété est un UUID. Par exemple: `1abc23d4-567f-8ab9-cde0-1fab234c5d67`.  
*Type* : chaîne  
*Obligatoire* : Conditionnelle  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `SourceAccessConfigurations`   <a name="sam-function-documentdb-sourceaccessconfigurations"></a>
Un tableau du protocole d'authentification ou de l'hôte virtuel. Spécifiez-le à l'aide du type de [SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html)données.  
Pour le type de source d'événement `DocumentDB`, le seul type de configuration valide est `BASIC_AUTH`.  
+ `BASIC_AUTH` – Le secret Secrets Manager qui stocke vos informations d'identification d'agent. Pour ce type, les informations d'identification doivent être au format suivant : `{"username": "your-username", "password": "your-password"}`. Un seul objet de type `BASIC_AUTH` est autorisé.
*Type* : liste  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `StartingPosition`   <a name="sam-function-documentdb-startingposition"></a>
Position de début de la lecture dans le flux.  
+ `AT_TIMESTAMP` : spécifier l'heure à partir de laquelle la lecture des enregistrements doit commencer.
+ `LATEST` : lire uniquement les nouveaux enregistrements.
+ `TRIM_HORIZON` : traiter tous les enregistrements disponibles.
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `StartingPositionTimestamp`   <a name="sam-function-documentdb-startingpositiontimestamp"></a>
L'heure à partir de laquelle commencer la lecture, en secondes au format horaire Unix. Définissez `StartingPositionTimestamp` lorsque `StartingPosition` est défini sur `AT_TIMESTAMP`.  
*Type* : double  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

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

### Source d'événement Amazon DocumentDB
<a name="sam-property-function-documentdb-examples-example1"></a>

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyFunction:
    Type: AWS::Serverless::Function
    Properties:
    ...
      Events:
        MyDDBEvent:
          Type: DocumentDB
          Properties:
            Cluster: "arn:aws:rds:us-west-2:123456789012:cluster:docdb-2023-01-01"
            BatchSize: 10
            MaximumBatchingWindowInSeconds: 5
            DatabaseName: "db1"
            CollectionName: "collection1"
            FullDocument: "UpdateLookup"
            SourceAccessConfigurations:
              - Type: BASIC_AUTH
                URI: "arn:aws:secretsmanager:us-west-2:123456789012:secret:doc-db"
```

# DynamoDB
<a name="sam-property-function-dynamodb"></a>

L'objet décrivant un type de source d'événement `DynamoDB`. *Pour plus d'informations, consultez la section [Utilisation AWS Lambda avec Amazon DynamoDB](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html) dans AWS Lambda le manuel du développeur.*

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

## Syntaxe
<a name="sam-property-function-dynamodb-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-dynamodb-syntax.yaml"></a>

```
  [BatchSize](#sam-function-dynamodb-batchsize): Integer
  [BisectBatchOnFunctionError](#sam-function-dynamodb-bisectbatchonfunctionerror): Boolean
  [DestinationConfig](#sam-function-dynamodb-destinationconfig): [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)
  [Enabled](#sam-function-dynamodb-enabled): Boolean
  [FilterCriteria](#sam-function-dynamodb-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
  [FunctionResponseTypes](#sam-function-dynamodb-functionresponsetypes): List
  KmsKeyArn: String          
  [MaximumBatchingWindowInSeconds](#sam-function-dynamodb-maximumbatchingwindowinseconds): Integer
  [MaximumRecordAgeInSeconds](#sam-function-dynamodb-maximumrecordageinseconds): Integer
  [MaximumRetryAttempts](#sam-function-dynamodb-maximumretryattempts): Integer
  [MetricsConfig](#sam-function-dynamodb-metricsconfig): [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)
  [ParallelizationFactor](#sam-function-dynamodb-parallelizationfactor): Integer
  [StartingPosition](#sam-function-dynamodb-startingposition): String
  StartingPositionTimestamp: Double
  [Stream](#sam-function-dynamodb-stream): String
  [TumblingWindowInSeconds](#sam-function-dynamodb-tumblingwindowinseconds): Integer
```

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

 `BatchSize`   <a name="sam-function-dynamodb-batchsize"></a>
Nombre maximum d'éléments à récupérer dans un seul lot.  
*Type* : entier  
*Obligatoire* : non  
*Par défaut *: 100  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.  
*Minimum *: `1`  
*Maximum *: `1000`

 `BisectBatchOnFunctionError`   <a name="sam-function-dynamodb-bisectbatchonfunctionerror"></a>
Si la fonction renvoie une erreur, fractionnez le lot en deux et recommencez.  
*Type* : valeur booléenne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[BisectBatchOnFunctionError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `DestinationConfig`   <a name="sam-function-dynamodb-destinationconfig"></a>
Une file d'attente Amazon Simple Queue Service (Amazon SQS) ou une rubrique de destination Amazon Simple Notification Service (Amazon SNS) pour les enregistrements ignorés.  
*Type :* [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `Enabled`   <a name="sam-function-dynamodb-enabled"></a>
Désactive le mappage de source d'événement pour suspendre l'interrogation et l'appel.  
*Type* : valeur booléenne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `FilterCriteria`   <a name="sam-function-dynamodb-filtercriteria"></a>
Objet qui définit les critères permettant de déterminer si Lambda doit traiter un événement. Pour de plus amples informations, veuillez consulter [AWS Lambda le filtrage d’événements](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) dans le *AWS Lambda Manuel du développeur*.  
*Type :* [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `FunctionResponseTypes`   <a name="sam-function-dynamodb-functionresponsetypes"></a>
Une liste des type de réponse actuellement appliquées au mappage de la source d'événement. Pour plus d'informations, veuillez consulter la rubrique [Signalement des échecs d'éléments par lot](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-batchfailurereporting) dans le *Guide du développeur AWS Lambda *.  
*Valeurs valides* : `ReportBatchItemFailures`  
*Type* : liste  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[FunctionResponseTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `KmsKeyArn`   <a name="sam-function-dynamodb-kmskeyarn"></a>
Le nom de ressource Amazon (ARN) de la clé permettant de chiffrer les informations relatives à cet événement.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `MaximumBatchingWindowInSeconds`   <a name="sam-function-dynamodb-maximumbatchingwindowinseconds"></a>
Intervalle de temps maximal (en secondes) pour collecter des enregistrements avant d’invoquer la fonction.  
*Type* : entier  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `MaximumRecordAgeInSeconds`   <a name="sam-function-dynamodb-maximumrecordageinseconds"></a>
L'âge maximal d'une demande que Lambda envoie à une fonction pour traitement.  
*Type* : entier  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[MaximumRecordAgeInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `MaximumRetryAttempts`   <a name="sam-function-dynamodb-maximumretryattempts"></a>
Nombre maximum de tentatives autorisées lorsque la fonction renvoie une erreur.  
*Type* : entier  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[MaximumRetryAttempts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `MetricsConfig`   <a name="sam-function-dynamodb-metricsconfig"></a>
Une configuration optionnelle pour obtenir des métriques améliorées pour les mappages de sources d'événements qui capturent chaque étape du traitement. Pour obtenir un exemple, consultez [MetricsConfig événement](#sam-property-function-dynamodb-example-metricsconfigevent).  
*Type :* [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `ParallelizationFactor`   <a name="sam-function-dynamodb-parallelizationfactor"></a>
Le nombre de lots à traiter simultanément à partir de chaque partition.  
*Type* : entier  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ParallelizationFactor](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-parallelizationfactor)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `StartingPosition`   <a name="sam-function-dynamodb-startingposition"></a>
Position de début de la lecture dans le flux.  
+ `AT_TIMESTAMP` : spécifier l'heure à partir de laquelle la lecture des enregistrements doit commencer.
+ `LATEST` : lire uniquement les nouveaux enregistrements.
+ `TRIM_HORIZON` : traiter tous les enregistrements disponibles.
*Valeurs valides* : `AT_TIMESTAMP` \$1 `LATEST` \$1 `TRIM_HORIZON`  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `StartingPositionTimestamp`   <a name="sam-function-dynamodb-startingpositiontimestamp"></a>
L'heure à partir de laquelle commencer la lecture, en secondes au format horaire Unix. Définissez `StartingPositionTimestamp` lorsque `StartingPosition` est défini sur `AT_TIMESTAMP`.  
*Type* : double  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `Stream`   <a name="sam-function-dynamodb-stream"></a>
L'ARN (Amazon Resource Name) du flux de DynamoDB.  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `TumblingWindowInSeconds`   <a name="sam-function-dynamodb-tumblingwindowinseconds"></a>
La durée d'une fenêtre de traitement en secondes. La plage valide est de 1 à 900 (15 minutes).  
Pour plus d'informations, consultez [Fenêtres bascules](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#streams-tumbling) dans le *Guide du développeur AWS Lambda *.  
*Type* : entier  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[TumblingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-tumblingwindowinseconds)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

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

### MetricsConfig événement
<a name="sam-property-function-dynamodb-example-metricsconfigevent"></a>

Voici un exemple de ressource qui utilise la `MetricsConfig` propriété pour capturer chaque étape du traitement pour ses mappages de sources d'événements.

```
Resources:
  FilteredEventsFunction:
    Type: AWS::Serverless::Function
    Properties:
      CodeUri: s3://sam-demo-bucket/metricsConfig.zip
      Handler: index.handler
      Runtime: nodejs16.x
      Events:
        KinesisStream:
          Type: Kinesis
          Properties:
            Stream: !GetAtt KinesisStream.Arn
            StartingPosition: LATEST
            MetricsConfig:
              Metrics:
              - EventCount
```

### Source d'événement DynamoDB pour une table DynamoDB existante
<a name="sam-property-function-dynamodb--examples--dynamodb-event-source-for-existing-dynamodb-table"></a>

Source d'événement DynamoDB pour une table DynamoDB qui existe déjà dans un compte. AWS 

#### YAML
<a name="sam-property-function-dynamodb--examples--dynamodb-event-source-for-existing-dynamodb-table--yaml"></a>

```
Events:
  DDBEvent:
    Type: DynamoDB
    Properties:
      Stream: arn:aws:dynamodb:us-east-1:123456789012:table/TestTable/stream/2016-08-11T21:21:33.291
      StartingPosition: TRIM_HORIZON
      BatchSize: 10
      Enabled: false
```

### Événement DynamoDB pour la table DynamoDB déclarée dans le modèle
<a name="sam-property-function-dynamodb--examples--dynamodb-event-for-dynamodb-table-declared-in-template"></a>

Événement DynamoDB pour une table DynamoDB déclarée dans le même fichier de modèle.

#### YAML
<a name="sam-property-function-dynamodb--examples--dynamodb-event-for-dynamodb-table-declared-in-template--yaml"></a>

```
Events:
  DDBEvent:
    Type: DynamoDB
    Properties:
      Stream: 
        !GetAtt MyDynamoDBTable.StreamArn   # This must be the name of a DynamoDB table declared in the same template file
      StartingPosition: TRIM_HORIZON
      BatchSize: 10
      Enabled: false
```

# EventBridgeRule
<a name="sam-property-function-eventbridgerule"></a>

L'objet décrivant un type de source d'`EventBridgeRule`événement, qui définit votre fonction sans serveur comme cible d'une EventBridge règle Amazon. 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 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. AWS SAM crée également une `AWS::Lambda::Permission` ressource, qui est nécessaire pour `EventBridgeRule` pouvoir appeler Lambda.

## Syntaxe
<a name="sam-property-function-eventbridgerule-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-eventbridgerule-syntax.yaml"></a>

```
  [DeadLetterConfig](#sam-function-eventbridgerule-deadletterconfig): DeadLetterConfig
  [EventBusName](#sam-function-eventbridgerule-eventbusname): String
  [Input](#sam-function-eventbridgerule-input): String
  [InputPath](#sam-function-eventbridgerule-inputpath): String
  InputTransformer: [InputTransformer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html)
  [Pattern](#sam-function-eventbridgerule-pattern): [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)
  [RetryPolicy](#sam-function-eventbridgerule-retrypolicy): [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)
  RuleName: String 
  State: String
  [Target](#sam-function-eventbridgerule-target): Target
```

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

 `DeadLetterConfig`   <a name="sam-function-eventbridgerule-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-deadletterconfig.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.

 `EventBusName`   <a name="sam-function-eventbridgerule-eventbusname"></a>
Le bus d'événements à associer à cette règle. Si vous omettez cette propriété, AWS SAM utilise le bus d'événements par défaut.  
*Type* : chaîne  
*Obligatoire* : non  
*Par défaut* : bus d'événement par défaut  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[EventBusName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname)` propriété d'une `AWS::Events::Rule` ressource.

 `Input`   <a name="sam-function-eventbridgerule-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.

 `InputPath`   <a name="sam-function-eventbridgerule-inputpath"></a>
Lorsque vous ne voulez pas transmettre l'événement correspondant complet, utilisez la propriété `InputPath` pour décrire quelles parties de l'événement transmettre à la cible.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[InputPath](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputpath)` propriété d'une `AWS::Events::Rule Target` ressource.

 `InputTransformer`   <a name="sam-function-eventbridgerule-inputtransformer"></a>
Paramètres qui vous permettent de fournir une entrée personnalisée à une cible en fonction de certaines données d'événement. Vous pouvez extraire une ou plusieurs paires clé-valeur à partir de l'événement, puis utiliser ces données pour envoyer l'entrée personnalisée à la cible. Pour plus d'informations, consultez la section [Transformation des EventBridge entrées Amazon](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-transform-target-input.html) *dans le guide de EventBridge l'utilisateur Amazon*.   
*Type :* [InputTransformer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputtransformer)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[InputTransformer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html)` propriété d'un type de `AWS::Events::Rule` `Target` données.

 `Pattern`   <a name="sam-function-eventbridgerule-pattern"></a>
Décrit les événements qui sont acheminés vers la cible spécifiée. Pour plus d'informations, consultez les [ EventBridgeévénements Amazon](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-events.html) et les [modèles EventBridge d'événements](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html) dans le *guide de EventBridge l'utilisateur Amazon*.  
*Type :* [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)` propriété d'une `AWS::Events::Rule` ressource.

 `RetryPolicy`   <a name="sam-function-eventbridgerule-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.

 `RuleName`   <a name="sam-function-eventbridgerule-rulename"></a>
Le nom de la 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.

 `State`   <a name="sam-function-eventbridgerule-state"></a>
État de la règle.  
*Valeurs acceptées* : `DISABLED` \$1 `ENABLED` \$1 `ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS`  
*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.

 `Target`   <a name="sam-function-eventbridgerule-target"></a>
La AWS ressource qui est EventBridge invoquée lorsqu'une règle est déclenchée. Vous pouvez utiliser cette propriété pour spécifier l'ID logique de la cible. Si cette propriété n'est pas spécifiée, AWS SAM génère l'ID logique de la cible.  
*Type* : [cible](sam-property-function-target.md)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est similaire à celle `[Targets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets)` d'une `AWS::Events::Rule` ressource. `Amazon EC2 RebootInstances API call`est un exemple de propriété cible. La version AWS SAM de cette propriété vous permet uniquement de spécifier l'ID logique d'une seule cible.

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

### EventBridgeRule
<a name="sam-property-function-eventbridgerule--examples--eventbridgerule"></a>

Voici un exemple de type de source d'événement `EventBridgeRule`.

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

```
EBRule:
  Type: EventBridgeRule
  Properties:
    Input: '{"Key": "Value"}'
    Pattern:
      detail:
        state:
          - terminated
    RetryPolicy:
      MaximumRetryAttempts: 5
      MaximumEventAgeInSeconds: 900
    DeadLetterConfig:
      Type: SQS
      QueueLogicalId: EBRuleDLQ
    Target:
      Id: MyTarget
```

# DeadLetterConfig
<a name="sam-property-function-deadletterconfig"></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-deadletterconfig-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-deadletterconfig-syntax.yaml"></a>

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

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

 `Arn`   <a name="sam-function-deadletterconfig-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-deadletterconfig-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-deadletterconfig-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-deadletterconfig--examples"></a>

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

DeadLetterConfig

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

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

# Target
<a name="sam-property-function-target"></a>

Configure la AWS ressource qui est EventBridge invoquée lorsqu'une règle est déclenchée.

## Syntaxe
<a name="sam-property-function-target-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-target-syntax.yaml"></a>

```
  [Id](#sam-function-target-id): String
```

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

 `Id`   <a name="sam-function-target-id"></a>
L'ID logique de la cible.  
La valeur de `Id` peut inclure des caractères alphanumériques, des points (`.`), des tirets (`-`) et des tirets du bas (`_`).  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[Id](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-id)` propriété du type de `AWS::Events::Rule` `Target` données.

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

### Cible
<a name="sam-property-function-target--examples--target"></a>

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

```
EBRule:
  Type: EventBridgeRule
  Properties:
    Target:
      Id: MyTarget
```

# HttpApi
<a name="sam-property-function-httpapi"></a>

L'objet décrivant une source d'événement avec type HttpApi.

Si une OpenApi définition du chemin et de la méthode spécifiés existe dans l'API, SAM ajoutera la section Intégration et sécurité Lambda (le cas échéant) pour vous.

Si aucune OpenApi définition pour le chemin et la méthode spécifiés n'existe dans l'API, SAM créera cette définition pour vous.

## Syntaxe
<a name="sam-property-function-httpapi-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-httpapi-syntax.yaml"></a>

```
  [ApiId](#sam-function-httpapi-apiid): String
  [Auth](#sam-function-httpapi-auth): HttpApiFunctionAuth
  [Method](#sam-function-httpapi-method): String
  [Path](#sam-function-httpapi-path): String
  [PayloadFormatVersion](#sam-function-httpapi-payloadformatversion): String
  [RouteSettings](#sam-function-httpapi-routesettings): [RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)
  [TimeoutInMillis](#sam-function-httpapi-timeoutinmillis): Integer
```

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

 `ApiId`   <a name="sam-function-httpapi-apiid"></a>
Identificateur d'une ressource [AWS::Serverless::HttpApi](sam-resource-httpapi.md) définie dans ce modèle.  
Si elle n'est pas définie, une [AWS::Serverless::HttpApi](sam-resource-httpapi.md) ressource par défaut est créée appelée à `ServerlessHttpApi` l'aide d'un OpenApi document généré contenant une union de tous les chemins et méthodes définis par les événements Api définis dans ce modèle qui ne spécifient pas de`ApiId`.  
Cela ne peut pas référencer une ressource [AWS::Serverless::HttpApi](sam-resource-httpapi.md) définie dans un autre modèle.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `Auth`   <a name="sam-function-httpapi-auth"></a>
Configuration d'authentification pour cette méthode Api\$1Chemin\$1Méthode spécifique.  
Utile pour remplacer la configuration d'autorisation du paramètre de `DefaultAuthorizer` de l'API sur un chemin d'accès individuel, lorsqu'aucun `DefaultAuthorizer` n'est spécifié.  
*Type :* [HttpApiFunctionAuth](sam-property-function-httpapifunctionauth.md)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `Method`   <a name="sam-function-httpapi-method"></a>
Méthode HTTP pour laquelle cette fonction est appelée.  
 \$1Si non`Path`and`Method`sont spécifiés, SAM créera un chemin d'API par défaut qui achemine toute requête qui ne mappe pas à un autre point de terminaison vers cette fonction Lambda. Seul un de ces chemins par défaut peut exister par API.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `Path`   <a name="sam-function-httpapi-path"></a>
Chemin d'accès d'URI pour lequel cette fonction est appelée. Doit commencer par `/`.  
Si aucun `Path` et `Method` ne sont spécifiés, SAM créera un chemin d'API par défaut qui acheminera toute demande qui ne mappe pas à un autre point de terminaison vers cette fonction Lambda. Seul un de ces chemins par défaut peut exister par API.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `PayloadFormatVersion`   <a name="sam-function-httpapi-payloadformatversion"></a>
Spécifie le format de la charge utile envoyée à une intégration.  
REMARQUE : PayloadFormatVersion nécessite que SAM modifie votre définition d'OpenAPI, de sorte que cela ne fonctionne qu'avec les éléments en ligne OpenApi définis dans la propriété. `DefinitionBody`  
*Type* : chaîne  
*Obligatoire* : non  
*Par défaut* : 2.0  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `RouteSettings`   <a name="sam-function-httpapi-routesettings"></a>
Les paramètres d'acheminement par acheminement pour cette API HTTP. Pour plus d'informations sur les paramètres d'itinéraire, consultez [AWS::ApiGatewayV2::Stage RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html)le *guide du développeur d'API Gateway*.  
Remarque : S' RouteSettings ils sont spécifiés à la fois dans la source de HttpApi ressource et dans la source d'événement, AWS SAM fusionnez-les avec les propriétés de la source d'événements prioritaires.  
*Type :* [RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)` propriété d'une `AWS::ApiGatewayV2::Stage` ressource.

 `TimeoutInMillis`   <a name="sam-function-httpapi-timeoutinmillis"></a>
Délai d'attente personnalisé compris entre 50 et 29 000 millisecondes.  
REMARQUE : TimeoutInMillis nécessite que SAM modifie votre définition d'OpenAPI, de sorte que cela ne fonctionne qu'avec les éléments en ligne OpenApi définis dans la propriété. `DefinitionBody`  
*Type* : entier  
*Obligatoire* : non  
*Par défaut *: 5000  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

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

### HttpApi Événement par défaut
<a name="sam-property-function-httpapi--examples--default-httpapi-event"></a>

HttpApi Evénement utilisant le chemin par défaut. Tous les chemins d‘accès et méthodes non mappés sur cette API seront acheminés vers ce point de terminaison.

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

```
Events:
  HttpApiEvent:
    Type: HttpApi
```

### HttpApi
<a name="sam-property-function-httpapi--examples--httpapi"></a>

HttpApi Evénement utilisant un chemin et une méthode spécifiques.

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

```
Events:
  HttpApiEvent:
    Type: HttpApi
    Properties:
      Path: /
      Method: GET
```

### HttpApi Autorisation
<a name="sam-property-function-httpapi--examples--httpapi-authorization"></a>

HttpApi Événement utilisant un autorisateur.

#### YAML
<a name="sam-property-function-httpapi--examples--httpapi-authorization--yaml"></a>

```
Events:
  HttpApiEvent:
    Type: HttpApi
    Properties:
      Path: /authenticated
      Method: GET
      Auth:
        Authorizer: OpenIdAuth
        AuthorizationScopes:
          - scope1
          - scope2
```

# HttpApiFunctionAuth
<a name="sam-property-function-httpapifunctionauth"></a>

Configure l'autorisation au niveau de l'événement.

Configurez l'autorisation pour une formule Api\$1Chemin\$1Méthode spécifique.

## Syntaxe
<a name="sam-property-function-httpapifunctionauth-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-httpapifunctionauth-syntax.yaml"></a>

```
  [AuthorizationScopes](#sam-function-httpapifunctionauth-authorizationscopes): List
  [Authorizer](#sam-function-httpapifunctionauth-authorizer): String
```

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

 `AuthorizationScopes`   <a name="sam-function-httpapifunctionauth-authorizationscopes"></a>
Les étendues d'autorisation à appliquer à cette API, ce chemin d'accès et cette méthode.  
Les portées répertoriées ici remplaceront toutes les portées appliquées par le `DefaultAuthorizer` s'il en existe un.  
*Type* : liste  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `Authorizer`   <a name="sam-function-httpapifunctionauth-authorizer"></a>
Le `Authorizer` pour une Fonction spécifique. Pour utiliser l'autorisation IAM, spécifiez `AWS_IAM` et spécifiez `true` pour `EnableIamAuthorizer` dans la section `Globals` de votre modèle.  
Si vous avez spécifié un mécanisme d'autorisation global sur l'API et que vous souhaitez rendre publique une fonction spécifique, remplacez en définissant `Authorizer` sur `NONE`.  
*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-httpapifunctionauth--examples"></a>

### Fonction-Auth (Autorisation fonction)
<a name="sam-property-function-httpapifunctionauth--examples--function-auth"></a>

Spécification de l'autorisation au niveau de la fonction

#### YAML
<a name="sam-property-function-httpapifunctionauth--examples--function-auth--yaml"></a>

```
Auth:
  Authorizer: OpenIdAuth
  AuthorizationScopes:
    - scope1
    - scope2
```

### autorisation IAM
<a name="sam-property-function-httpapifunctionauth--examples--iam-authorization"></a>

Spécifie l'autorisation IAM au niveau de l'événement. Pour utiliser l'autorisation `AWS_IAM` au niveau de l'événement, vous devez également spécifier `true` pour `EnableIamAuthorizer` dans la section `Globals` de votre modèle. Pour de plus amples informations, veuillez consulter [Section « Globales » du modèle AWS SAM](sam-specification-template-anatomy-globals.md).

#### YAML
<a name="sam-property-function-httpapifunctionauth--examples--iam-authorization--yaml"></a>

```
Globals:
  HttpApi:
    Auth:
      EnableIamAuthorizer: true

Resources:
  HttpApiFunctionWithIamAuth:
    Type: AWS::Serverless::Function
    Properties:
      Events:
        ApiEvent:
          Type: HttpApi
          Properties:
            Path: /iam-auth
            Method: GET
            Auth:
              Authorizer: AWS_IAM
      Handler: index.handler
      InlineCode: |
        def handler(event, context):
          return {'body': 'HttpApiFunctionWithIamAuth', 'statusCode': 200}
      Runtime: python3.9
```

# IoTRule
<a name="sam-property-function-iotrule"></a>

L'objet décrivant un type de source d'événement `IoTRule`.

Crée une [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-topicrule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-topicrule.html)ressource pour déclarer une AWS IoT règle. Pour plus d'informations, consultez la [documentation CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-topicrule.html).

## Syntaxe
<a name="sam-property-function-iotrule-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-iotrule-syntax.yaml"></a>

```
  [AwsIotSqlVersion](#sam-function-iotrule-awsiotsqlversion): String
  [Sql](#sam-function-iotrule-sql): String
```

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

 `AwsIotSqlVersion`   <a name="sam-function-iotrule-awsiotsqlversion"></a>
Version du moteur de règles SQL à utiliser lors de l'évaluation de la règle.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[AwsIotSqlVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-awsiotsqlversion)` propriété d'une `AWS::IoT::TopicRule TopicRulePayload` ressource.

 `Sql`   <a name="sam-function-iotrule-sql"></a>
Instruction SQL utilisée pour interroger la rubrique. Pour plus d'informations, consultez la [Référence SQL AWS IoT](https://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference) dans le *Guide du développeur AWS IoT *.  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[Sql](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-sql)` propriété d'une `AWS::IoT::TopicRule TopicRulePayload` ressource.

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

### Règle IOT
<a name="sam-property-function-iotrule--examples--iot-rule"></a>

Exemples de règle IOT

#### YAML
<a name="sam-property-function-iotrule--examples--iot-rule--yaml"></a>

```
IoTRule:
  Type: IoTRule
  Properties:
    Sql: SELECT * FROM 'topic/test'
```

# Kinesis
<a name="sam-property-function-kinesis"></a>

L'objet décrivant un type de source d'événement `Kinesis`. Pour plus d'informations, consultez la section [Utilisation AWS Lambda avec Amazon Kinesis](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html) dans le Guide du *AWS Lambda développeur*.

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

## Syntaxe
<a name="sam-property-function-kinesis-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-kinesis-syntax.yaml"></a>

```
  [BatchSize](#sam-function-kinesis-batchsize): Integer
  [BisectBatchOnFunctionError](#sam-function-kinesis-bisectbatchonfunctionerror): Boolean
  [DestinationConfig](#sam-function-kinesis-destinationconfig): [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)
  [Enabled](#sam-function-kinesis-enabled): Boolean
  [FilterCriteria](#sam-function-kinesis-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
  [FunctionResponseTypes](#sam-function-kinesis-functionresponsetypes): List
  KmsKeyArn: String          
  [MaximumBatchingWindowInSeconds](#sam-function-kinesis-maximumbatchingwindowinseconds): Integer
  [MaximumRecordAgeInSeconds](#sam-function-kinesis-maximumrecordageinseconds): Integer
  [MaximumRetryAttempts](#sam-function-kinesis-maximumretryattempts): Integer
  [MetricsConfig](#sam-function-kinesis-metricsconfig): [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)
  [ParallelizationFactor](#sam-function-kinesis-parallelizationfactor): Integer
  [StartingPosition](#sam-function-kinesis-startingposition): String
  StartingPositionTimestamp: Double
  [Stream](#sam-function-kinesis-stream): String
  [TumblingWindowInSeconds](#sam-function-kinesis-tumblingwindowinseconds): Integer
```

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

 `BatchSize`   <a name="sam-function-kinesis-batchsize"></a>
Nombre maximum d'éléments à récupérer dans un seul lot.  
*Type* : entier  
*Obligatoire* : non  
*Par défaut *: 100  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.  
*Minimum *: `1`  
*Maximum *: `10000`

 `BisectBatchOnFunctionError`   <a name="sam-function-kinesis-bisectbatchonfunctionerror"></a>
Si la fonction renvoie une erreur, fractionnez le lot en deux et recommencez.  
*Type* : valeur booléenne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[BisectBatchOnFunctionError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `DestinationConfig`   <a name="sam-function-kinesis-destinationconfig"></a>
Une file d'attente Amazon Simple Queue Service (Amazon SQS) ou une rubrique de destination Amazon Simple Notification Service (Amazon SNS) pour les enregistrements ignorés.  
*Type :* [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `Enabled`   <a name="sam-function-kinesis-enabled"></a>
Désactive le mappage de source d'événement pour suspendre l'interrogation et l'appel.  
*Type* : valeur booléenne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `FilterCriteria`   <a name="sam-function-kinesis-filtercriteria"></a>
Objet qui définit les critères permettant de déterminer si Lambda doit traiter un événement. Pour de plus amples informations, veuillez consulter [AWS Lambda le filtrage d’événements](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) dans le *AWS Lambda Manuel du développeur*.  
*Type :* [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `FunctionResponseTypes`   <a name="sam-function-kinesis-functionresponsetypes"></a>
Une liste des type de réponse actuellement appliquées au mappage de la source d'événement. Pour plus d'informations, veuillez consulter la rubrique [Signalement des échecs d'éléments par lot](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-batchfailurereporting) dans le *Guide du développeur AWS Lambda *.  
*Valeurs valides* : `ReportBatchItemFailures`  
*Type* : liste  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[FunctionResponseTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `KmsKeyArn`   <a name="sam-function-kinesis-kmskeyarn"></a>
Le nom de ressource Amazon (ARN) de la clé permettant de chiffrer les informations relatives à cet événement.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `MaximumBatchingWindowInSeconds`   <a name="sam-function-kinesis-maximumbatchingwindowinseconds"></a>
Intervalle de temps maximal (en secondes) pour collecter des enregistrements avant d’invoquer la fonction.  
*Type* : entier  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `MaximumRecordAgeInSeconds`   <a name="sam-function-kinesis-maximumrecordageinseconds"></a>
L'âge maximal d'une demande que Lambda envoie à une fonction pour traitement.  
*Type* : entier  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[MaximumRecordAgeInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `MaximumRetryAttempts`   <a name="sam-function-kinesis-maximumretryattempts"></a>
Nombre maximum de tentatives autorisées lorsque la fonction renvoie une erreur.  
*Type* : entier  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[MaximumRetryAttempts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `MetricsConfig`   <a name="sam-function-kinesis-metricsconfig"></a>
Une configuration optionnelle pour obtenir des métriques améliorées pour les mappages de sources d'événements qui capturent chaque étape du traitement. Pour obtenir un exemple, consultez [MetricsConfig événement](sam-property-function-dynamodb.md#sam-property-function-dynamodb-example-metricsconfigevent).  
*Type :* [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `ParallelizationFactor`   <a name="sam-function-kinesis-parallelizationfactor"></a>
Le nombre de lots à traiter simultanément à partir de chaque partition.  
*Type* : entier  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ParallelizationFactor](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-parallelizationfactor)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `StartingPosition`   <a name="sam-function-kinesis-startingposition"></a>
Position de début de la lecture dans le flux.  
+ `AT_TIMESTAMP` : spécifier l'heure à partir de laquelle la lecture des enregistrements doit commencer.
+ `LATEST` : lire uniquement les nouveaux enregistrements.
+ `TRIM_HORIZON` : traiter tous les enregistrements disponibles.
*Valeurs valides* : `AT_TIMESTAMP` \$1 `LATEST` \$1 `TRIM_HORIZON`  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `StartingPositionTimestamp`   <a name="sam-function-kinesis-startingpositiontimestamp"></a>
L'heure à partir de laquelle commencer la lecture, en secondes au format horaire Unix. Définissez `StartingPositionTimestamp` lorsque `StartingPosition` est défini sur `AT_TIMESTAMP`.  
*Type* : double  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `Stream`   <a name="sam-function-kinesis-stream"></a>
L'Amazon Resource Name (ARN) du flux de données ou d'un consommateur de flux.  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `TumblingWindowInSeconds`   <a name="sam-function-kinesis-tumblingwindowinseconds"></a>
La durée d'une fenêtre de traitement en secondes. La plage valide est de 1 à 900 (15 minutes).  
Pour plus d'informations, consultez [Fenêtres bascules](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#streams-tumbling) dans le *Guide du développeur AWS Lambda *.  
*Type* : entier  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[TumblingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-tumblingwindowinseconds)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

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

### MetricsConfig événement
<a name="sam-property-function-kinesis-example-metricsconfigevent"></a>

Voici un exemple de ressource qui utilise la `MetricsConfig` propriété pour capturer chaque étape du traitement pour ses mappages de sources d'événements.

```
Resources:
  FilteredEventsFunction:
    Type: AWS::Serverless::Function
    Properties:
      CodeUri: s3://sam-demo-bucket/metricsConfig.zip
      Handler: index.handler
      Runtime: nodejs16.x
      Events:
        KinesisStream:
          Type: Kinesis
          Properties:
            Stream: !GetAtt KinesisStream.Arn
            StartingPosition: LATEST
            MetricsConfig:
              Metrics:
              - EventCount
```

### Source de l'événement Kinesis
<a name="sam-property-function-kinesis--examples--kinesis-event-source"></a>

Voici un exemple de source d'événement Kinesis.

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

```
Events:
  KinesisEvent:
    Type: Kinesis
    Properties:
      Stream: arn:aws:kinesis:us-east-1:123456789012:stream/my-stream
      StartingPosition: TRIM_HORIZON
      BatchSize: 10
      Enabled: false
      FilterCriteria: 
        Filters: 
          - Pattern: '{"key": ["val1", "val2"]}'
```

# MQ
<a name="sam-property-function-mq"></a>

L'objet décrivant un type de source d'événement `MQ`. Pour plus d'informations, consultez [Utilisation AWS Lambda avec Amazon MQ](https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html) dans le *Guide du développeur AWS Lambda *.

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

**Note**  
Pour avoir une file d'attente Amazon MQ dans un cloud privé virtuel (VPC) qui se connecte à une fonction Lambda dans un réseau public, le rôle d'exécution de votre fonction doit inclure les autorisations suivantes :   
`ec2:CreateNetworkInterface`
`ec2:DeleteNetworkInterface`
`ec2:DescribeNetworkInterfaces`
`ec2:DescribeSecurityGroups`
`ec2:DescribeSubnets`
`ec2:DescribeVpcs`
Pour plus d'informations, consultez [Autorisations de rôle d'exécution](https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#events-mq-permissions) dans le *Guide du développeur AWS Lambda *.

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

Pour déclarer cette entité dans votre AWS SAM modèle, utilisez la syntaxe suivante.

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

```
  [BatchSize](#sam-function-mq-batchsize): Integer
  [Broker](#sam-function-mq-broker): String
  DynamicPolicyName: Boolean
  [Enabled](#sam-function-mq-enabled): Boolean
  [FilterCriteria](#sam-function-mq-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
  KmsKeyArn: String 
  [MaximumBatchingWindowInSeconds](#sam-function-mq-maximumbatchingwindowinseconds): Integer
  [Queues](#sam-function-mq-queues): List
  [SecretsManagerKmsKeyId](#sam-function-mq-secretsmanagerkmskeyid): String
  [SourceAccessConfigurations](#sam-function-mq-sourceaccessconfigurations): List
```

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

 `BatchSize`   <a name="sam-function-mq-batchsize"></a>
Nombre maximum d'éléments à récupérer dans un seul lot.  
*Type* : entier  
*Obligatoire* : non  
*Par défaut *: 100  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.  
*Minimum *: `1`  
*Maximum *: `10000`

 `Broker`   <a name="sam-function-mq-broker"></a>
Amazon Resource Name (ARN) de l'agent Amazon MQ.  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `DynamicPolicyName`   <a name="sam-function-mq-dynamicpolicyname"></a>
Par défaut, le nom de la politique Gestion des identités et des accès AWS (IAM) est `SamAutoGeneratedAMQPolicy` destiné à la rétrocompatibilité. Spécifiez `true` pour utiliser un nom généré automatiquement pour votre politique IAM. Ce nom inclura l'ID logique de la source d'événements Amazon MQ.  
Lorsque vous utilisez plus d'une source d'événements Amazon MQ, spécifiez la valeur `true` pour éviter la duplication des noms de politique IAM.
*Type* : valeur booléenne  
*Obligatoire* : non  
*Par défaut* : `false`  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `Enabled`   <a name="sam-function-mq-enabled"></a>
Si la valeur est `true`, le mappage de source d'événement est actif. Pour suspendre l'interrogation et l'appel, définissez ce paramètre sur `false`.  
*Type* : valeur booléenne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `FilterCriteria`   <a name="sam-function-mq-filtercriteria"></a>
Objet qui définit les critères permettant de déterminer si Lambda doit traiter un événement. Pour de plus amples informations, veuillez consulter [AWS Lambda le filtrage d’événements](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) dans le *AWS Lambda Manuel du développeur*.  
*Type :* [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `KmsKeyArn`   <a name="sam-function-mq-kmskeyarn"></a>
Le nom de ressource Amazon (ARN) de la clé permettant de chiffrer les informations relatives à cet événement.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `MaximumBatchingWindowInSeconds`   <a name="sam-function-mq-maximumbatchingwindowinseconds"></a>
Intervalle de temps maximal (en secondes) pour collecter des enregistrements avant d’invoquer la fonction.  
*Type* : entier  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `Queues`   <a name="sam-function-mq-queues"></a>
Le nom de la file d'attente de destination de l'agent Amazon MQ à consommer.  
*Type* : liste  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[Queues](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-queues)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `SecretsManagerKmsKeyId`   <a name="sam-function-mq-secretsmanagerkmskeyid"></a>
L'identifiant de clé AWS Key Management Service (AWS KMS) d'une clé gérée par le client provenant de AWS Secrets Manager. Requise lorsque vous utilisez une clé gérée par le client à partir de Secrets Manager avec un rôle d'exécution Lambda qui n'inclut pas l'autorisation `kms:Decrypt`.  
La valeur de cette propriété est un UUID. Par exemple: `1abc23d4-567f-8ab9-cde0-1fab234c5d67`.  
*Type* : chaîne  
*Obligatoire* : Conditionnelle  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `SourceAccessConfigurations`   <a name="sam-function-mq-sourceaccessconfigurations"></a>
Un tableau du protocole d'authentification ou de l'hôte virtuel. Spécifiez-le à l'aide du type de [SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html)données.  
Pour le type de source d'événement `MQ`, les seuls types de configuration valides sont `BASIC_AUTH` et `VIRTUAL_HOST`.  
+ **`BASIC_AUTH`** – Le secret Secrets Manager qui stocke vos informations d'identification d'agent. Pour ce type, les informations d'identification doivent être au format suivant : `{"username": "your-username", "password": "your-password"}`. Un seul objet de type `BASIC_AUTH` est autorisé.
+ **`VIRTUAL_HOST`** – Le nom de l'hôte virtuel dans votre agent RabbitMQ. Lambda utilisera cet hôte RabbitMQ comme source d'événement. Un seul objet de type `VIRTUAL_HOST` est autorisé.
*Type* : liste  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

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

### Source d'événement Amazon MQ
<a name="sam-property-function-mq--examples--amazon-mq-event-source"></a>

Voici un exemple de type de source d'événement `MQ` pour un agent Amazon MQ.

#### YAML
<a name="sam-property-function-mq--examples--amazon-mq-event-source--yaml"></a>

```
Events:
  MQEvent:
    Type: MQ
    Properties:
      Broker: arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9
      Queues: List of queues
      SourceAccessConfigurations:
        - Type: BASIC_AUTH
          URI: arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName
      BatchSize: 200
      Enabled: true
```

# MSK
<a name="sam-property-function-msk"></a>

L'objet décrivant un type de source d'événement `MSK`. Pour plus d'informations, consultez la section [Utilisation AWS Lambda avec Amazon MSK](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html) dans le *manuel du AWS Lambda développeur*.

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

Pour utiliser Schema Registry, vous devez définir des autorisations de rôle IAM spécifiques pour votre fonction. Voir [Configuration complète avec des rôles IAM](#sam-property-function-msk-example-complete) pour un exemple de configuration requise.

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

Pour déclarer cette entité dans votre AWS SAM modèle, utilisez la syntaxe suivante.

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

```
  [BatchSize](#sam-function-msk-batchsize): Integer
  [BisectBatchOnFunctionError](#sam-function-msk-bisectbatchonfunctionerror): Boolean
  [ConsumerGroupId](#sam-function-msk-consumergroupid): String
  DestinationConfig: [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html)
  [Enabled](#sam-function-msk-enabled): Boolean
  [FilterCriteria](#sam-function-msk-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
  [FunctionResponseTypes](#sam-function-msk-functionresponsetypes): List
  KmsKeyArn: String
  [MaximumBatchingWindowInSeconds](#sam-function-msk-maximumbatchingwindowinseconds): Integer
  [MaximumRecordAgeInSeconds](#sam-function-msk-maximumrecordageinseconds): Integer
  [MaximumRetryAttempts](#sam-function-msk-maximumretryattempts): Integer
  [LoggingConfig](#sam-function-msk-loggingconfig): [LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-loggingconfig.html)
  [MetricsConfig](#sam-function-msk-metricsconfig): [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig.html)
  [ProvisionedPollerConfig](#sam-function-msk-provisionedpollerconfig): [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)
  [SchemaRegistryConfig](#sam-function-msk-schemaregistryconfig): [SchemaRegistryConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-schemaregistryconfig.html)
  SourceAccessConfigurations: [SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations)
  [StartingPosition](#sam-function-msk-startingposition): String
  StartingPositionTimestamp: Double
  [Stream](#sam-function-msk-stream): String
  [Topics](#sam-function-msk-topics): List
```

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

 `BatchSize`   <a name="sam-function-msk-batchsize"></a>
Nombre maximal d’enregistrements dans chaque lot que Lambda extrait de votre flux ou file d’attente et envoie à votre fonction. Lambda transmet tous les enregistrements du lot à la fonction en un seul appel, dans la limite de charge utile pour une invocation synchrone (6 Mo).  
*Par défaut *: 100  
*Plage valide* : valeur minimale de 1. Valeur maximale de 10 000.  
*Type* : entier  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `BisectBatchOnFunctionError`   <a name="sam-function-msk-bisectbatchonfunctionerror"></a>
Si la fonction renvoie une erreur, fractionnez le lot en deux et recommencez.  
*Type* : valeur booléenne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[BisectBatchOnFunctionError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `ConsumerGroupId`   <a name="sam-function-msk-consumergroupid"></a>
Chaîne qui configure la façon dont les événements seront lus à partir des rubriques Kafka.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[AmazonManagedKafkaConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `DestinationConfig`   <a name="sam-function-msk-destinationconfig"></a>
Objet de configuration qui spécifie la destination d'un événement après son traitement par Lambda.  
Utilisez cette propriété pour spécifier la destination des invocations ayant échoués à partir de la source d'événements Amazon MSK.  
*Type :* [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `Enabled`   <a name="sam-function-msk-enabled"></a>
Désactive le mappage de source d'événement pour suspendre l'interrogation et l'appel.  
*Type* : valeur booléenne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `FilterCriteria`   <a name="sam-function-msk-filtercriteria"></a>
Objet qui définit les critères permettant de déterminer si Lambda doit traiter un événement. Pour de plus amples informations, veuillez consulter [AWS Lambda le filtrage d’événements](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) dans le *AWS Lambda Manuel du développeur*.  
*Type :* [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `FunctionResponseTypes`   <a name="sam-function-msk-functionresponsetypes"></a>
Une liste des type de réponse actuellement appliquées au mappage de la source d'événement. Pour plus d'informations, veuillez consulter la rubrique [Signalement des échecs d'éléments par lot](https://docs.aws.amazon.com/lambda/latest/dg/kafka-retry-configurations.html) dans le *Guide du développeur AWS Lambda *.  
*Valeurs valides* : `ReportBatchItemFailures`  
*Type* : liste  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[FunctionResponseTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `KmsKeyArn`   <a name="sam-function-msk-kmskeyarn"></a>
Le nom de ressource Amazon (ARN) de la clé permettant de chiffrer les informations relatives à cet événement.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `MaximumBatchingWindowInSeconds`   <a name="sam-function-msk-maximumbatchingwindowinseconds"></a>
Intervalle de temps maximal (en secondes) pour collecter des enregistrements avant d’invoquer la fonction.  
*Type* : entier  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `MaximumRecordAgeInSeconds`   <a name="sam-function-msk-maximumrecordageinseconds"></a>
L'âge maximal d'une demande que Lambda envoie à une fonction pour traitement.  
*Type* : entier  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[MaximumRecordAgeInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `MaximumRetryAttempts`   <a name="sam-function-msk-maximumretryattempts"></a>
Nombre maximum de tentatives autorisées lorsque la fonction renvoie une erreur.  
*Type* : entier  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[MaximumRetryAttempts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `LoggingConfig`   <a name="sam-function-msk-loggingconfig"></a>
Objet de configuration qui spécifie la configuration de journalisation pour le mappage des sources d'événements.  
*Type :* [LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-loggingconfig.html)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-loggingconfig.html)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `MetricsConfig`   <a name="sam-function-msk-metricsconfig"></a>
Objet de configuration qui spécifie la configuration des métriques pour le mappage des sources d'événements.  
*Type :* [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig.html)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig.html)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `ProvisionedPollerConfig`   <a name="sam-function-msk-provisionedpollerconfig"></a>
Configuration pour augmenter le nombre de sondeurs utilisés pour calculer les mappages de sources d'événements. Cette configuration permet un minimum de 1 sondeur et un maximum de 2 000 sondeurs. Pour un exemple, reportez-vous à[ProvisionedPollerConfig exemple](#sam-property-function-msk-example-provisionedpollerconfig).  
*Type :* [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

`SchemaRegistryConfig`  <a name="sam-function-msk-schemaregistryconfig"></a>
Configuration pour l'utilisation d'un registre de schémas avec la source d'événements Kafka.  
Cette fonctionnalité doit `ProvisionedPollerConfig` être configurée.
*Type* : SchemaRegistryConfig  
*Obligatoire* : non  
*CloudFormation compatibilité :* cette propriété est transmise directement à la `[AmazonManagedKafkaEventSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `SourceAccessConfigurations`   <a name="sam-function-msk-sourceaccessconfigurations"></a>
Tableau du protocole d’authentification, composants VPC ou hôte virtuel pour sécuriser et définir votre source d’événement.  
*Valeurs valides* : `CLIENT_CERTIFICATE_TLS_AUTH`  
*Type* : liste de propriétés [SourceAccessConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html)  
*Obligatoire* : non  
*CloudFormation compatibilité :* cette propriété fait partie de la [AmazonManagedKafkaEventSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig)propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `StartingPosition`   <a name="sam-function-msk-startingposition"></a>
Position de début de la lecture dans le flux.  
+ `AT_TIMESTAMP` : spécifier l'heure à partir de laquelle la lecture des enregistrements doit commencer.
+ `LATEST` : lire uniquement les nouveaux enregistrements.
+ `TRIM_HORIZON` : traiter tous les enregistrements disponibles.
*Valeurs valides* : `AT_TIMESTAMP` \$1 `LATEST` \$1 `TRIM_HORIZON`  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `StartingPositionTimestamp`   <a name="sam-function-msk-startingpositiontimestamp"></a>
L'heure à partir de laquelle commencer la lecture, en secondes au format horaire Unix. Définissez `StartingPositionTimestamp` lorsque `StartingPosition` est défini sur `AT_TIMESTAMP`.  
*Type* : double  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `Stream`   <a name="sam-function-msk-stream"></a>
L'Amazon Resource Name (ARN) du flux de données ou d'un consommateur de flux.  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `Topics`   <a name="sam-function-msk-topics"></a>
Nom de la rubrique Kafka.  
*Type* : liste  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[Topics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-topics)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

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

### Configuration complète avec des rôles IAM
<a name="sam-property-function-msk-example-complete"></a>

L'exemple suivant montre une configuration complète, y compris la configuration de rôle IAM requise pour utiliser Schema Registry :

```
Parameters:
  PreCreatedSubnetOne:
    Type: String
  PreCreatedSubnetTwo:
    Type: String
  MskClusterName4:
    Type: String

Resources:
  MyLambdaExecutionRole:
    Type: AWS::IAM::Role
    Properties:
      AssumeRolePolicyDocument:
        Version: '2012-10-17		 	 	 '
        Statement:
        - Action: [sts:AssumeRole]
          Effect: Allow
          Principal:
            Service: [lambda.amazonaws.com]
      Policies:
      - PolicyName: KafkaClusterPermissions
        PolicyDocument:
          Statement:
          - Action: [kafka:DescribeClusterV2, kafka:GetBootstrapBrokers]
            Effect: Allow
            Resource: 'arn:aws:kafka:us-east-1:123456789012:cluster/*'
      - PolicyName: KafkaAuthPolicy
        PolicyDocument:
          Statement:
          - Action: [secretsmanager:GetSecretValue, kms:Decrypt]
            Effect: "Allow"
            Resource: ['arn:aws:secretsmanager:us-west-2:123456789012:secret:kafkaSecret-******',
                        'arn:aws:kms:us-west-2:123456789012:key/keyId']
      - PolicyName: ENIPolicy
        PolicyDocument:
          Statement:
          - Action: [ec2:CreateNetworkInterface,
              ec2:DescribeNetworkInterfaces, ec2:DescribeVpcs, ec2:DeleteNetworkInterface,
              ec2:DescribeSubnets, ec2:DescribeSecurityGroups]
            Effect: Allow
            Resource: '*'
      - PolicyName: SchemaRegistryPolicy
        PolicyDocument:
          Statement:
          - Action: [glue:GetRegistry]
            Effect: Allow
            Resource: 'arn:aws:glue:{region}:{account-id}:registry/{registry-name}'
      - PolicyName: SchemaVersionsPolicy
        PolicyDocument:
          Statement:
          - Action: [glue:GetSchemaVersions]
            Effect: Allow
            Resource: '*'
      ManagedPolicyArns:
      - !Sub arn:${AWS::Partition}:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole
      Tags:
      - {Value: SAM, Key: lambda:createdBy}

  MyMskCluster:
    Type: AWS::MSK::Cluster
    Properties:
      BrokerNodeGroupInfo:
        ClientSubnets:
        - Ref: PreCreatedSubnetOne
        - Ref: PreCreatedSubnetTwo
        InstanceType: kafka.t3.small
        StorageInfo:
          EBSStorageInfo:
            VolumeSize: 1
      ClusterName:
        Ref: MskClusterName4
      KafkaVersion: 3.8.x
      NumberOfBrokerNodes: 2

  MyMskStreamProcessor:
    Type: AWS::Serverless::Function
    Properties:
      Runtime: nodejs18.x
      Handler: index.handler
      CodeUri: ${codeuri}
      Role:
        Fn::GetAtt: [MyLambdaExecutionRole, Arn]
      Events:
        MyMskEvent:
          Type: MSK
          Properties:
            StartingPosition: LATEST
            Stream:
              Ref: MyMskCluster
            SourceAccessConfigurations:
            - Type: SASL_SCRAM_512_AUTH
              URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-path/my-secret-name-1a2b3c
            Topics:
            - SchemaRegistryTestTopic
            ProvisionedPollerConfig:
              MinimumPollers: 1
            SchemaRegistryConfig:
              AccessConfigs:
              - Type: BASIC_AUTH
                URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-path/my-secret-name-1a2b3c
              SchemaValidationConfigs:
              - Attribute: KEY
              EventRecordFormat: JSON
              SchemaRegistryURI: !Sub arn:${AWS::Partition}:glue:us-west-2:123456789012:registry/myregistry
```

### ProvisionedPollerConfig exemple
<a name="sam-property-function-msk-example-provisionedpollerconfig"></a>

```
ProvisionedPollerConfig:
  MinimumPollers: 1
  MaximumPollers: 200
```

### Exemple Amazon MSK pour un cluster existant
<a name="sam-property-function-msk--examples--amazon-msk-example-for-existing-cluster"></a>

Voici un exemple de type de source d'événement `MSK` pour un cluster Amazon MSK qui existe déjà dans un Compte AWS.

#### YAML
<a name="sam-property-function-msk--examples--amazon-msk-example-for-existing-cluster--yaml"></a>

```
Events:
  MSKEvent:
    Type: MSK
    Properties:
      StartingPosition: LATEST
      Stream: arn:aws:kafka:us-east-1:012345678012:cluster/exampleClusterName/abcdefab-1234-abcd-5678-cdef0123ab01-2
      Topics:
        - MyTopic
```

### Exemple Amazon MSK pour un cluster déclaré dans le même modèle
<a name="sam-property-function-msk--examples--amazon-msk-example-for-cluster-declared-in-same-template"></a>

Voici un exemple de type de source d'événement `MSK` pour un cluster Amazon MSK déclaré dans le même fichier modèle.

#### YAML
<a name="sam-property-function-msk--examples--amazon-msk-example-for-cluster-declared-in-same-template--yaml"></a>

```
Events:
  MSKEvent:
    Type: MSK
    Properties:
      StartingPosition: LATEST
      Stream:
        Ref: MyMskCluster   # This must be the name of an MSK cluster declared in the same template file
      Topics:
        - MyTopic
```

#### Source d'événements MSK avec registre de schémas
<a name="sam-property-function-msk-example-schemaregistry"></a>

Voici un exemple de type de source d'`MSK`événement configuré avec un registre de schémas.

```
Events:
  MSKEvent:
    Type: MSK
    Properties:
      StartingPosition: LATEST
      Stream:
        Ref: MyMskCluster
      Topics:
        - SchemaRegistryTestTopic
      ProvisionedPollerConfig:
        MinimumPollers: 1
      SchemaRegistryConfig:
        SchemaRegistryURI: !Sub arn:${AWS::Partition}:glue:us-west-2:123456789012:registry/myregistry
        EventRecordFormat: JSON
        SchemaValidationConfigs:
          - Attribute: KEY
          - Attribute: VALUE
```

#### Source d'événements MSK avec registre de schémas Confluent
<a name="sam-property-function-msk-example-schemaregistry-confluent"></a>

Voici un exemple de type de source d'`MSK`événement configuré avec un registre de schémas Confluent.

```
Events:
  MSKEvent:
    Type: MSK
    Properties:
      StartingPosition: LATEST
      Stream:
        Ref: MyMskCluster
      Topics:
        - SchemaRegistryTestTopic
      ProvisionedPollerConfig:
        MinimumPollers: 1
      SchemaRegistryConfig:
        SchemaRegistryURI: https://my-schema-registry.confluent.cloud
        AccessConfigs:
          - Type: BASIC_AUTH
            URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-secret
        EventRecordFormat: JSON
        SchemaValidationConfigs:
          - Attribute: KEY
          - Attribute: VALUE
```

# S3
<a name="sam-property-function-s3"></a>

L'objet décrivant un type de source d'événement `S3`.

## Syntaxe
<a name="sam-property-function-s3-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-s3-syntax.yaml"></a>

```
  [Bucket](#sam-function-s3-bucket): String
  [Events](#sam-function-s3-events): String | List
  [Filter](#sam-function-s3-filter): [NotificationFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html)
```

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

 `Bucket`   <a name="sam-function-s3-bucket"></a>
Nom du compartiment S3. Ce compartiment doit exister dans le même modèle.  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est similaire à celle `[BucketName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-name)` d'une `AWS::S3::Bucket` ressource. Ce champ est obligatoire dans SAM. Ce champ accepte uniquement une référence au compartiment S3 créé dans ce modèle

 `Events`   <a name="sam-function-s3-events"></a>
L'événement de compartiment Amazon S3 pour lequel appeler la fonction Lambda. Consultez [Types d'événements pris en charge par Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html#supported-notification-event-types) pour obtenir la liste des valeurs valides.  
*Type* : chaîne \$1 liste  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[Event](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-lambdaconfig.html#cfn-s3-bucket-notificationconfig-lambdaconfig-event)` propriété du type de `AWS::S3::Bucket` `LambdaConfiguration` données.

 `Filter`   <a name="sam-function-s3-filter"></a>
Les règles de filtrage qui déterminent quels objets Amazon S3 appellent la fonction Lambda. Pour en savoir plus sur le filtrage par nom de clé Amazon S3, consultez [Configuration des notifications d'événement Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) dans le *Guide de l'utilisateur Amazon Simple Storage Service*.  
*Type :* [NotificationFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[Filter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html)` propriété du type de `AWS::S3::Bucket` `LambdaConfiguration` données.

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

### Événement S3
<a name="sam-property-function-s3--examples--s3-event"></a>

Exemple d'événement S3.

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

```
Events:
  S3Event:
    Type: S3
    Properties:
      Bucket:
        Ref: ImagesBucket     # This must be the name of an S3 bucket declared in the same template file
      Events: s3:ObjectCreated:*
      Filter:
        S3Key:
          Rules:
          - Name: prefix      # or "suffix"
            Value: value      # The value to search for in the S3 object key names
```

# 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
```

# ScheduleV2
<a name="sam-property-function-schedulev2"></a>

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

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

## Syntaxe
<a name="sam-property-function-schedulev2-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-schedulev2-syntax.yaml"></a>

```
[DeadLetterConfig](#sam-function-schedulev2-deadletterconfig): DeadLetterConfig
[Description](#sam-function-schedulev2-description): String
[EndDate](#sam-function-schedulev2-enddate): String
[FlexibleTimeWindow](#sam-function-schedulev2-flexibletimewindow): FlexibleTimeWindow
[GroupName](#sam-function-schedulev2-groupname): String
[Input](#sam-function-schedulev2-input): String
[KmsKeyArn](#sam-function-schedulev2-kmskeyarn): String
[Name](#sam-function-schedulev2-name): String
OmitName: Boolean
[PermissionsBoundary](#sam-function-schedulev2-permissionsboundary): String
[RetryPolicy](#sam-function-schedulev2-retrypolicy): RetryPolicy
[RoleArn](#sam-function-schedulev2-rolearn): String
[ScheduleExpression](#sam-function-schedulev2-schedule): String
[ScheduleExpressionTimezone](#sam-function-schedulev2-scheduleexpressiontimezone): String
[StartDate](#sam-function-schedulev2-startdate): String
[State](#sam-function-schedulev2-state): String
```

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

 `DeadLetterConfig`   <a name="sam-function-schedulev2-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 [section Configuration d'une file d'attente de lettres mortes pour le EventBridge planificateur dans le guide de l'utilisateur du EventBridge planificateur](https://docs.aws.amazon.com/scheduler/latest/UserGuide/configuring-schedule-dlq.html).*  
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::Scheduler::Schedule` `Target` données. `[DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-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-schedulev2-description"></a>
Description de la planification.  
*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-scheduler-schedule.html#cfn-scheduler-schedule-description)` propriété d'une `AWS::Scheduler::Schedule` ressource.

 `EndDate`   <a name="sam-function-schedulev2-enddate"></a>
Date, au format UTC, avant laquelle la planification 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  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[EndDate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-enddate)` propriété d'une `AWS::Scheduler::Schedule` ressource.

 `FlexibleTimeWindow`   <a name="sam-function-schedulev2-flexibletimewindow"></a>
Permet de configurer une fenêtre dans laquelle une planification peut être appelée.  
*Type :* [FlexibleTimeWindow](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-flexibletimewindow)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[FlexibleTimeWindow](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-flexibletimewindow)` propriété d'une `AWS::Scheduler::Schedule` ressource.

 `GroupName`   <a name="sam-function-schedulev2-groupname"></a>
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  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[GroupName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-groupname)` propriété d'une `AWS::Scheduler::Schedule` ressource.

 `Input`   <a name="sam-function-schedulev2-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-scheduler-schedule-target.html#cfn-scheduler-schedule-target-input)` propriété d'une `AWS::Scheduler::Schedule Target` ressource.

 `KmsKeyArn`   <a name="sam-function-schedulev2-kmskeyarn"></a>
ARN d'une clé KMS utilisée pour chiffrer les données client.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-kmskeyarn)` propriété d'une `AWS::Scheduler::Schedule` ressource.

 `Name`   <a name="sam-function-schedulev2-name"></a>
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  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-name)` propriété d'une `AWS::Scheduler::Schedule` ressource.

`OmitName`  <a name="sam-function-schedulev2-omitname"></a>
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` pour CloudFormation générer un identifiant physique unique et utilisez-le plutôt pour le nom du calendrier.  
*Type* : valeur booléenne  
*Obligatoire* : non  
*Par défaut* : `false`  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `PermissionsBoundary`   <a name="sam-function-schedulev2-permissionsboundary"></a>
ARN de la politique utilisée pour définir la limite d'autorisations du rôle.  
S'il `PermissionsBoundary` est défini, les mêmes limites AWS SAM seront appliquées au rôle IAM cible du calendrier du planificateur.
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[PermissionsBoundary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-permissionsboundary)` propriété d'une `AWS::IAM::Role` ressource.

 `RetryPolicy`   <a name="sam-function-schedulev2-retrypolicy"></a>
Objet **RetryPolicy** qui inclut des informations sur les paramètres de politique de nouvelle tentative.  
*Type :* [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-retrypolicy)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-retrypolicy)` propriété du type de `AWS::Scheduler::Schedule` `Target` données.

 `RoleArn`   <a name="sam-function-schedulev2-rolearn"></a>
L'ARN du rôle IAM que le EventBridge planificateur utilisera pour la cible lorsque le calendrier est invoqué.  
*Type :* [RoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[RoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn)` propriété du type de `AWS::Scheduler::Schedule` `Target` données.

 `ScheduleExpression`   <a name="sam-function-schedulev2-scheduleexpression"></a>
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  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ScheduleExpression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-scheduleexpression)` propriété d'une `AWS::Scheduler::Schedule` ressource.

 `ScheduleExpressionTimezone`   <a name="sam-function-schedulev2-scheduleexpressiontimezone"></a>
Fuseau horaire dans lequel l'expression de planification est évaluée.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ScheduleExpressionTimezone](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-scheduleexpressiontimezone)` propriété d'une `AWS::Scheduler::Schedule` ressource.

 `StartDate`   <a name="sam-function-schedulev2-startdate"></a>
Date, au format UTC, après laquelle la planification peut commencer à appeler 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  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[StartDate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-startdate)` propriété d'une `AWS::Scheduler::Schedule` ressource.

 `State`   <a name="sam-function-schedulev2-state"></a>
État de la planification du planificateur.  
*Valeurs acceptées :* `DISABLED | ENABLED`  
*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-scheduler-schedule.html#cfn-scheduler-schedule-state)` propriété d'une `AWS::Scheduler::Schedule` ressource.

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

### Exemple de base de définition d'une ressource ScheduleV2
<a name="sam-property-function-schedulev2--examples--example1"></a>

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

# SelfManagedKafka
<a name="sam-property-function-selfmanagedkafka"></a>

L'objet décrivant un type de source d'événement `SelfManagedKafka`. Pour plus d'informations, consultez la section [Utilisation AWS Lambda avec Apache Kafka autogéré](https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html) dans le Guide du *AWS Lambda développeur*.

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

Pour utiliser Schema Registry, vous devez définir des autorisations de rôle IAM spécifiques pour votre fonction. Voir [Configuration complète avec des rôles IAM](sam-property-function-msk.md#sam-property-function-msk-example-complete) pour un exemple de configuration requise.

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

Pour déclarer cette entité dans votre AWS SAM modèle, utilisez la syntaxe suivante.

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

```
  [BatchSize](#sam-function-selfmanagedkafka-batchsize): Integer
  [BisectBatchOnFunctionError](#sam-function-selfmanagedkafka-bisectbatchonfunctionerror): Boolean
  [ConsumerGroupId](#sam-function-selfmanagedkafka-consumergroupid): String
  DestinationConfig: [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html)
  [Enabled](#sam-function-selfmanagedkafka-enabled): Boolean
  [FilterCriteria](#sam-function-selfmanagedkafka-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
  [KafkaBootstrapServers](#sam-function-selfmanagedkafka-kafkabootstrapservers): List
  [FunctionResponseTypes](#sam-function-selfmanagedkafka-functionresponsetypes): List
  KmsKeyArn: String
  [LoggingConfig](#sam-function-selfmanagedkafka-loggingconfig): LoggingConfig
  [MaximumRecordAgeInSeconds](#sam-function-selfmanagedkafka-maximumrecordageinseconds): Integer
  [MaximumRetryAttempts](#sam-function-selfmanagedkafka-maximumretryattempts): Integer
  [MetricsConfig](#sam-function-selfmanagedkafka-metricsconfig): MetricsConfig
  [ProvisionedPollerConfig](#sam-function-selfmanagedkafka-provisionedpollerconfig): [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)
  [SchemaRegistryConfig](#sam-function-selfmanagedkafka-schemaregistryconfig): [SchemaRegistryConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-schemaregistryconfig.html)
  [SourceAccessConfigurations](#sam-function-selfmanagedkafka-sourceaccessconfigurations): [SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations)
  StartingPosition: String
  StartingPositionTimestamp: Double
  [Topics](#sam-function-selfmanagedkafka-topics): List
```

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

 `BatchSize`   <a name="sam-function-selfmanagedkafka-batchsize"></a>
Nombre maximal d’enregistrements dans chaque lot que Lambda extrait de votre flux et envoie à votre fonction.  
*Type* : entier  
*Obligatoire* : non  
*Par défaut *: 100  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.  
*Minimum *: `1`  
*Maximum *: `10000`

 `BisectBatchOnFunctionError`   <a name="sam-function-selfmanagedkafka-bisectbatchonfunctionerror"></a>
Si la fonction renvoie une erreur, fractionnez le lot en deux et recommencez.  
*Type* : valeur booléenne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[BisectBatchOnFunctionError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `ConsumerGroupId`   <a name="sam-function-selfmanagedkafka-consumergroupid"></a>
Chaîne qui configure la façon dont les événements seront lus à partir des rubriques Kafka.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[SelfManagedKafkaEventSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `DestinationConfig`   <a name="sam-function-selfmanagedkafka-destinationconfig"></a>
Objet de configuration qui spécifie la destination d'un événement après son traitement par Lambda.  
Utilisez cette propriété pour spécifier la destination des invocations échouées de la source d'événements Kafka autogérée.  
*Type :* [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `Enabled`   <a name="sam-function-selfmanagedkafka-enabled"></a>
Désactive le mappage de source d'événement pour suspendre l'interrogation et l'appel.  
*Type* : valeur booléenne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `FilterCriteria`   <a name="sam-function-selfmanagedkafka-filtercriteria"></a>
Objet qui définit les critères permettant de déterminer si Lambda doit traiter un événement. Pour de plus amples informations, veuillez consulter [AWS Lambda le filtrage d’événements](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) dans le *AWS Lambda Manuel du développeur*.  
*Type :* [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-filtercriteria)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `KafkaBootstrapServers`   <a name="sam-function-selfmanagedkafka-kafkabootstrapservers"></a>
La liste des serveurs d’amorçage pour vos agents Kafka. Inclure le port, par exemple `broker.example.com:xxxx`  
*Type* : liste  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `FunctionResponseTypes`   <a name="sam-function-selfmanagedkafka-functionresponsetypes"></a>
Une liste des type de réponse actuellement appliquées au mappage de la source d'événement. Pour plus d'informations, veuillez consulter la rubrique [Signalement des échecs d'éléments par lot](https://docs.aws.amazon.com/lambda/latest/dg/kafka-retry-configurations.html) dans le *Guide du développeur AWS Lambda *.  
*Valeurs valides* : `ReportBatchItemFailures`  
*Type* : liste  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[FunctionResponseTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `KmsKeyArn`   <a name="sam-function-selfmanagedkafka-kmskeyarn"></a>
Le nom de ressource Amazon (ARN) de la clé permettant de chiffrer les informations relatives à cet événement.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `LoggingConfig`   <a name="sam-function-selfmanagedkafka-loggingconfig"></a>
La configuration de journalisation de votre source d'événements.  
*Type :* [LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-loggingconfig)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-loggingconfig)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `MaximumRecordAgeInSeconds`   <a name="sam-function-selfmanagedkafka-maximumrecordageinseconds"></a>
L'âge maximal d'une demande que Lambda envoie à une fonction pour traitement.  
*Type* : entier  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[MaximumRecordAgeInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `MetricsConfig`   <a name="sam-function-selfmanagedkafka-metricsconfig"></a>
La configuration des métriques pour votre source d'événements.  
*Type :* [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-metricsconfig)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `MaximumRetryAttempts`   <a name="sam-function-selfmanagedkafka-maximumretryattempts"></a>
Nombre maximum de tentatives autorisées lorsque la fonction renvoie une erreur.  
*Type* : entier  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[MaximumRetryAttempts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `ProvisionedPollerConfig`   <a name="sam-function-selfmanagedkafka-provisionedpollerconfig"></a>
Configuration pour augmenter le nombre de sondeurs utilisés pour calculer les mappages de sources d'événements. Cette configuration permet un minimum de 1 sondeur et un maximum de 2 000 sondeurs. Pour un exemple, reportez-vous à [ProvisionedPollerConfig exemple](#sam-property-function-selfmanagedkafka-example-provisionedpollerconfig)  
*Type :* [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-provisionedpollerconfig)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

`SchemaRegistryConfig`  <a name="sam-function-selfmanagedkafka-schemaregistryconfig"></a>
Configuration pour l'utilisation d'un registre de schémas avec la source d'événements Kafka autogérée.  
Cette fonctionnalité doit `ProvisionedPollerConfig` être configurée.
*Type :* [SchemaRegistryConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-schemaregistryconfig)  
*Obligatoire* : non  
*CloudFormation compatibilité :* cette propriété est transmise directement à la `[SelfManagedKafkaEventSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `SourceAccessConfigurations`   <a name="sam-function-selfmanagedkafka-sourceaccessconfigurations"></a>
Tableau du protocole d’authentification, composants VPC ou hôte virtuel pour sécuriser et définir votre source d’événement.  
*Valeurs valides* : `BASIC_AUTH | CLIENT_CERTIFICATE_TLS_AUTH | SASL_SCRAM_256_AUTH | SASL_SCRAM_512_AUTH | SERVER_ROOT_CA_CERTIFICATE`  
*Type* : liste de propriétés [SourceAccessConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration)  
*Obligatoire* : oui  
*CloudFormation compatibilité :* cette propriété fait partie de la `[SelfManagedKafkaEventSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `StartingPosition`   <a name="sam-function-selfmanagedkafka-startingposition"></a>
Position de début de la lecture dans le flux.  
+ `AT_TIMESTAMP` : spécifier l'heure à partir de laquelle la lecture des enregistrements doit commencer.
+ `LATEST` : lire uniquement les nouveaux enregistrements.
+ `TRIM_HORIZON` : traiter tous les enregistrements disponibles.
*Valeurs valides* : `AT_TIMESTAMP` \$1 `LATEST` \$1 `TRIM_HORIZON`  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `StartingPositionTimestamp`   <a name="sam-function-selfmanagedkafka-startingpositiontimestamp"></a>
L'heure à partir de laquelle commencer la lecture, en secondes au format horaire Unix. Définissez `StartingPositionTimestamp` lorsque `StartingPosition` est défini sur `AT_TIMESTAMP`.  
*Type* : double  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `Topics`   <a name="sam-function-selfmanagedkafka-topics"></a>
Nom de la rubrique Kafka.  
*Type* : liste  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[Topics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-topics)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

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

### Configuration complète avec des rôles IAM
<a name="sam-property-function-selfmanagedkafka-example-complete"></a>

L'exemple suivant montre une configuration complète, y compris la configuration de rôle IAM requise pour utiliser Schema Registry :

```
Parameters:
  PreCreatedSubnetOne:
    Type: String
  PreCreatedSubnetTwo:
    Type: String

Resources:
  MyLambdaExecutionRole:
    Type: AWS::IAM::Role
    Properties:
      AssumeRolePolicyDocument:
        Version: '2012-10-17		 	 	 '
        Statement:
        - Action: [sts:AssumeRole]
          Effect: Allow
          Principal:
            Service: [lambda.amazonaws.com]
      Policies:
      - PolicyName: KafkaAuthPolicy
        PolicyDocument:
          Statement:
          - Action: [secretsmanager:GetSecretValue, kms:Decrypt]
            Effect: "Allow"
            Resource: ['arn:aws:secretsmanager:us-west-2:123456789012:secret:kafkaSecret-******',
                        'arn:aws:kms:us-west-2:123456789012:key/keyId']
      - PolicyName: ENIPolicy
        PolicyDocument:
          Statement:
          - Action: [ec2:CreateNetworkInterface,
              ec2:DescribeNetworkInterfaces, ec2:DescribeVpcs, ec2:DeleteNetworkInterface,
              ec2:DescribeSubnets, ec2:DescribeSecurityGroups]
            Effect: Allow
            Resource: '*'
      - PolicyName: SchemaRegistryPolicy
        PolicyDocument:
          Statement:
          - Action: [glue:GetRegistry]
            Effect: Allow
            Resource: 'arn:aws:glue:{region}:{account-id}:registry/{registry-name}'
      - PolicyName: SchemaVersionsPolicy
        PolicyDocument:
          Statement:
          - Action: [glue:GetSchemaVersions]
            Effect: Allow
            Resource: '*'
      ManagedPolicyArns:
      - !Sub arn:${AWS::Partition}:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole
      Tags:
      - {Value: SAM, Key: lambda:createdBy}

  MyKafkaProcessor:
    Type: AWS::Serverless::Function
    Properties:
      Runtime: nodejs18.x
      Handler: index.handler
      CodeUri: ${codeuri}
      Role:
        Fn::GetAtt: [MyLambdaExecutionRole, Arn]
      Events:
        SelfManagedKafkaEvent:
          Type: SelfManagedKafka
          Properties:
            KafkaBootstrapServers:
              - my-kafka-broker-1:9092
              - my-kafka-broker-2:9092
            Topics:
              - SchemaRegistryTestTopic
            StartingPosition: LATEST
            SourceAccessConfigurations:
              - Type: VPC_SUBNET
                URI: subnet:subnet-12345678
              - Type: VPC_SECURITY_GROUP
                URI: security_group:sg-12345678
              - Type: BASIC_AUTH
                URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-path/my-secret-name-1a2b3c
            ProvisionedPollerConfig:
              MinimumPollers: 1
            SchemaRegistryConfig:
              AccessConfigs:
              - Type: BASIC_AUTH
                URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-path/my-secret-name-1a2b3c
              SchemaValidationConfigs:
              - Attribute: KEY
              EventRecordFormat: JSON
              SchemaRegistryURI: !Sub arn:${AWS::Partition}:glue:us-west-2:123456789012:registry/myregistry
```

### ProvisionedPollerConfig exemple
<a name="sam-property-function-selfmanagedkafka-example-provisionedpollerconfig"></a>

```
ProvisionedPollerConfig:
  MinimumPollers: 1
  MaximumPollers: 200
```

### Source d’événements Kafka autogéré
<a name="sam-property-function-selfmanagedkafka--examples--self-managed-kafka-event-source"></a>

Voici un exemple de type de source d'événement `SelfManagedKafka`.

#### YAML
<a name="sam-property-function-selfmanagedkafka--examples--self-managed-kafka-event-source--yaml"></a>

```
Events:
  SelfManagedKafkaEvent:
    Type: SelfManagedKafka
    Properties:
      BatchSize: 1000
      Enabled: true
      KafkaBootstrapServers:
        - abc.xyz.com:xxxx
      SourceAccessConfigurations:
        -  Type: BASIC_AUTH
           URI: arn:aws:secretsmanager:us-west-2:123456789012:secret:my-path/my-secret-name-1a2b3c
      Topics:
        - MyKafkaTopic
```

### Source d'événements Kafka autogérée avec registre de schémas AWS Glue
<a name="sam-property-function-selfmanagedkafka-example-schemaregistry"></a>

Voici un exemple de type de source d'`SelfManagedKafka`événement configuré avec AWS Glue Schema Registry.

```
Events:
  SelfManagedKafkaEvent:
    Type: SelfManagedKafka
    Properties:
      KafkaBootstrapServers:
        - abc.xyz.com:9092
      Topics:
        - SchemaRegistryTestTopic
      StartingPosition: LATEST
      ProvisionedPollerConfig:
        MinimumPollers: 1
      SchemaRegistryConfig:
        SchemaRegistryURI: !Sub arn:${AWS::Partition}:glue:us-west-2:123456789012:registry/myregistry
        EventRecordFormat: JSON
        SchemaValidationConfigs:
          - Attribute: KEY
          - Attribute: VALUE
      SourceAccessConfigurations:
        - Type: VPC_SUBNET
          URI: subnet:subnet-12345678
        - Type: VPC_SECURITY_GROUP
          URI: security_group:sg-12345678
```

### Source d'événements Kafka autogérée avec registre de schémas Confluent
<a name="sam-property-function-selfmanagedkafka-example-schemaregistry-confluent"></a>

Voici un exemple de type de source d'`SelfManagedKafka`événement configuré avec Confluent Schema Registry.

```
Events:
  SelfManagedKafkaEvent:
    Type: SelfManagedKafka
    Properties:
      KafkaBootstrapServers:
        - abc.xyz.com:9092
      Topics:
        - SchemaRegistryTestTopic
      StartingPosition: LATEST
      ProvisionedPollerConfig:
        MinimumPollers: 1
      SchemaRegistryConfig:
        SchemaRegistryURI: https://my-schema-registry.confluent.cloud
        AccessConfigs:
          - Type: BASIC_AUTH
            URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-secret
        EventRecordFormat: JSON
        SchemaValidationConfigs:
          - Attribute: KEY
          - Attribute: VALUE
      SourceAccessConfigurations:
        - Type: VPC_SUBNET
          URI: subnet:subnet-12345678
        - Type: VPC_SECURITY_GROUP
          URI: security_group:sg-12345678
        - Type: BASIC_AUTH
          URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:kafka-secret
```

# SNS
<a name="sam-property-function-sns"></a>

L'objet décrivant un type de source d'événement `SNS`.

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

## Syntaxe
<a name="sam-property-function-sns-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-sns-syntax.yaml"></a>

```
  [FilterPolicy](#sam-function-sns-filterpolicy): [SnsFilterPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicy)
  FilterPolicyScope: String
  RedrivePolicy: Json
  [Region](#sam-function-sns-region): String
  [SqsSubscription](#sam-function-sns-sqssubscription): Boolean | SqsSubscriptionObject
  [Topic](#sam-function-sns-topic): String
```

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

 `FilterPolicy`   <a name="sam-function-sns-filterpolicy"></a>
Politique de filtre JSON attribuée à l’abonnement. Pour plus d'informations, consultez [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html)le manuel Amazon Simple Notification Service API Reference.  
*Type :* [SnsFilterPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicy)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[FilterPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicy)` propriété d'une `AWS::SNS::Subscription` ressource.

 `FilterPolicyScope`   <a name="sam-function-sns-filterpolicyscope"></a>
Cet attribut vous permet de choisir l'étendue du filtrage en utilisant l'un des types de valeurs de chaîne suivants :  
+ `MessageAttributes` : le filtre est appliqué aux attributs du message.
+ `MessageBody` : le filtre est appliqué sur le corps du message.
*Type* : chaîne  
*Obligatoire* : non  
*Par défaut* : `MessageAttributes`  
*CloudFormation compatibilité* : cette propriété est transmise directement à la ` [ FilterPolicyScope](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicyscope)` propriété d'une `AWS::SNS::Subscription` ressource.

 `RedrivePolicy`   <a name="sam-function-sns-redrivepolicy"></a>
Lorsque ce paramètre est spécifié, envoie des messages non livrables à la file d'attente de lettres mortes Amazon SQS spécifiée. Les messages qui ne peuvent pas être remis en raison d'erreurs client (par exemple, lorsque le point de terminaison abonné est inaccessible) ou d'erreurs de serveur (par exemple, lorsque le service qui alimente le point de terminaison abonné devient indisponible) sont conservés dans la file d'attente des lettres mortes pour une analyse ou un retraitement ultérieurs.  
Pour de plus amples informations sur la stratégie de redirection et les files d'attente de lettres mortes, veuillez consulter [Files d'attente de lettres mortes Amazon SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) dans le *Manuel du développeur Amazon Simple Queue Service*.  
*Type* : Json  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ RedrivePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-redrivepolicy)` propriété d'une `AWS::SNS::Subscription` ressource.

 `Region`   <a name="sam-function-sns-region"></a>
Pour les abonnements entre régions, la région dans laquelle le topic réside.  
Si aucune région n'est spécifiée, CloudFormation utilise la région de l'appelant par défaut.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[Region](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-region)` propriété d'une `AWS::SNS::Subscription` ressource.

 `SqsSubscription`   <a name="sam-function-sns-sqssubscription"></a>
Définissez cette propriété sur VRAI ou spécifiez `SqsSubscriptionObject` pour activer le traitement par lots des notifications de rubrique SNS dans une file d'attente SQS. Le fait de définir cette propriété sur `true` crée une nouvelle file d'attente SQS, alors que la spécification d'un `SqsSubscriptionObject` utilise une file d'attente SQS existante.  
*Type* : Booléen \$1 [SqsSubscriptionObject](sam-property-function-sqssubscriptionobject.md)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `Topic`   <a name="sam-function-sns-topic"></a>
ARN de la rubrique à laquelle s'abonner.  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[TopicArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#topicarn)` propriété d'une `AWS::SNS::Subscription` ressource.

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

### Exemple de source d'événement SNS
<a name="sam-property-function-sns--examples--sns-event-source-example"></a>

Exemple de source d'événement SNS

#### YAML
<a name="sam-property-function-sns--examples--sns-event-source-example--yaml"></a>

```
Events:
  SNSEvent:
    Type: SNS
    Properties:
      Topic: arn:aws:sns:us-east-1:123456789012:my_topic
      SqsSubscription: true
      FilterPolicy:
        store:
          - example_corp
        price_usd:
          - numeric:
              - ">="
              - 100
```

# SqsSubscriptionObject
<a name="sam-property-function-sqssubscriptionobject"></a>

Spécifiez une option de file d'attente SQS existante pour l'événement SNS

## Syntaxe
<a name="sam-property-function-sqssubscriptionobject-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-sqssubscriptionobject-syntax.yaml"></a>

```
  [BatchSize](#sam-function-sqssubscriptionobject-batchsize): String
  [Enabled](#sam-function-sqssubscriptionobject-enabled): Boolean
  [QueueArn](#sam-function-sqssubscriptionobject-queuearn): String
  [QueuePolicyLogicalId](#sam-function-sqssubscriptionobject-queuepolicylogicalid): String
  [QueueUrl](#sam-function-sqssubscriptionobject-queueurl): String
```

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

 `BatchSize`   <a name="sam-function-sqssubscriptionobject-batchsize"></a>
Le nombre maximal d'éléments à récupérer dans un seul lot pour la file d'attente SQS.  
*Type* : chaîne  
*Obligatoire* : non  
*Par défaut* : 10  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `Enabled`   <a name="sam-function-sqssubscriptionobject-enabled"></a>
Désactive le mappage de source d'événement SQS pour suspendre l'interrogation et l'appel.  
*Type* : valeur booléenne  
*Obligatoire* : non  
*Valeur par défaut* : VRAI  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `QueueArn`   <a name="sam-function-sqssubscriptionobject-queuearn"></a>
Spécifiez un arn de file d'attente SQS existant.  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `QueuePolicyLogicalId`   <a name="sam-function-sqssubscriptionobject-queuepolicylogicalid"></a>
Donnez un nom LogicalID personnalisé à la [AWS::SQS::QueuePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html)ressource.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `QueueUrl`   <a name="sam-function-sqssubscriptionobject-queueurl"></a>
Spécifiez l'URL de la file d'attente associée à la propriété `QueueArn`.  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

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

### Événement SQS existant pour SNS
<a name="sam-property-function-sqssubscriptionobject--examples--existing-sqs-for-sns-event"></a>

Exemple d'ajout d'une file d'attente SQS existante pour l'abonnement à une rubrique SNS.

#### YAML
<a name="sam-property-function-sqssubscriptionobject--examples--existing-sqs-for-sns-event--yaml"></a>

```
QueuePolicyLogicalId: CustomQueuePolicyLogicalId
QueueArn:
  Fn::GetAtt: MyCustomQueue.Arn
QueueUrl:
  Ref: MyCustomQueue
BatchSize: 5
```

# SQS
<a name="sam-property-function-sqs"></a>

L'objet décrivant un type de source d'événement `SQS`. Pour plus d'informations, consultez la section [Utilisation AWS Lambda avec Amazon SQS](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html) dans le manuel du *AWS Lambda développeur*.

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

## Syntaxe
<a name="sam-property-function-sqs-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-sqs-syntax.yaml"></a>

```
  [BatchSize](#sam-function-sqs-batchsize): Integer
  [Enabled](#sam-function-sqs-enabled): Boolean
  [FilterCriteria](#sam-function-sqs-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
  [FunctionResponseTypes](#sam-function-sqs-functionresponsetypes): List
  KmsKeyArn: String
  [MaximumBatchingWindowInSeconds](#sam-function-sqs-maximumbatchingwindowinseconds): Integer
  [MetricsConfig](#sam-function-sqs-metricsconfig): [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)
  [ProvisionedPollerConfig](#sam-function-sqs-provisionedpollerconfig): [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)
  [Queue](#sam-function-sqs-queue): String
  ScalingConfig: [ScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-scalingconfig.html)
```

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

 `BatchSize`   <a name="sam-function-sqs-batchsize"></a>
Nombre maximum d'éléments à récupérer dans un seul lot.  
*Type* : entier  
*Obligatoire* : non  
*Par défaut* : 10  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.  
*Minimum *: `1`  
*Maximum *: `10000`

 `Enabled`   <a name="sam-function-sqs-enabled"></a>
Désactive le mappage de source d'événement pour suspendre l'interrogation et l'appel.  
*Type* : valeur booléenne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `FilterCriteria`   <a name="sam-function-sqs-filtercriteria"></a>
Objet qui définit les critères permettant de déterminer si Lambda doit traiter un événement. Pour de plus amples informations, veuillez consulter [AWS Lambda le filtrage d’événements](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) dans le *AWS Lambda Manuel du développeur*.  
*Type :* [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `FunctionResponseTypes`   <a name="sam-function-sqs-functionresponsetypes"></a>
 Une liste des type de réponse actuellement appliquées au mappage de la source d'événement. Pour plus d'informations, veuillez consulter la rubrique [Signalement des échecs d'éléments par lot](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#services-sqs-batchfailurereporting) dans le *Guide du développeur AWS Lambda *.   
 *Valeurs valides* : `ReportBatchItemFailures`   
 *Type* : liste   
 *Obligatoire* : non   
 *CloudFormation compatibilité* : cette propriété est transmise directement à la `[FunctionResponseTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource. 

 `KmsKeyArn`   <a name="sam-function-sqs-kmskeyarn"></a>
Le nom de ressource Amazon (ARN) de la clé permettant de chiffrer les informations relatives à cet événement.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `MaximumBatchingWindowInSeconds`   <a name="sam-function-sqs-maximumbatchingwindowinseconds"></a>
L'intervalle de temps maximal (en secondes) pour collecter des enregistrements avant d'appeler la fonction.  
*Type* : entier  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `MetricsConfig`   <a name="sam-function-sqs-metricsconfig"></a>
Une configuration optionnelle permettant d'obtenir des métriques améliorées pour les mappages de sources d'événements qui capturent chaque étape du traitement. Pour obtenir un exemple, consultez [MetricsConfig événement](sam-property-function-dynamodb.md#sam-property-function-dynamodb-example-metricsconfigevent).  
*Type :* [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `ProvisionedPollerConfig`   <a name="sam-function-sqs-provisionedpollerconfig"></a>
Configuration pour augmenter le nombre de sondeurs utilisés pour calculer les mappages de sources d'événements. Cette configuration permet un minimum de 2 sondeurs et un maximum de 2 000 sondeurs. Pour un exemple, reportez-vous à[ProvisionedPollerConfig exemple](#sam-property-function-sqs-example-provisionedpollerconfig).  
*Type :* [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `Queue`   <a name="sam-function-sqs-queue"></a>
L'ARN de la file d'attente.  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `ScalingConfig`   <a name="sam-function-sqs-scalingconfig"></a>
Mise à l'échelle de la configuration des observateurs SQS pour contrôler le taux d'appels et définir le nombre maximal d'appels simultanés.  
*Type :* `[ScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-scalingconfig.html)`  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ ScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-scalingconfig.html)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

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

### MetricsConfig événement
<a name="sam-property-function-sqs-example-metricsconfigevent"></a>

Voici un exemple de ressource qui utilise la `MetricsConfig` propriété pour capturer chaque étape du traitement pour ses mappages de sources d'événements.

```
Resources:
  FilteredEventsFunction:
    Type: AWS::Serverless::Function
    Properties:
      CodeUri: s3://sam-demo-bucket/metricsConfig.zip
      Handler: index.handler
      Runtime: nodejs16.x
      Events:
        KinesisStream:
          Type: Kinesis
          Properties:
            Stream: !GetAtt KinesisStream.Arn
            StartingPosition: LATEST
            MetricsConfig:
              Metrics:
              - EventCount
```

### Événement SQS de base
<a name="sam-property-function-sqs--examples--sqs-event"></a>

```
Events:
  SQSEvent:
    Type: SQS
    Properties:
      Queue: arn:aws:sqs:us-west-2:012345678901:my-queue
      BatchSize: 10
      Enabled: false
      FilterCriteria:
        Filters:
          - Pattern: '{"key": ["val1", "val2"]}'
```

### Configurer des rapports partiels par lots pour votre file d'attente SQS
<a name="sam-property-function-sqs--examples--sqs-partial-batch"></a>

```
Events:
  SQSEvent:
    Type: SQS
    Properties:
      Enabled: true
      FunctionResponseTypes:
        - ReportBatchItemFailures
      Queue: !GetAtt MySqsQueue.Arn
      BatchSize: 10
```

### Fonction Lambda avec un événement SQS pour lequel la mise à l'échelle est configurée
<a name="sam-property-function-sqs--examples--sqs-event-scaling"></a>

```
MyFunction:
  Type: AWS::Serverless::Function
  Properties:
    ...
    Events:
      MySQSEvent:
        Type: SQS
        Properties:
          ...
          ScalingConfig:
            MaximumConcurrency: 10
```

### ProvisionedPollerConfig exemple
<a name="sam-property-function-sqs-example-provisionedpollerconfig"></a>

```
MyFunction:
  Type: AWS::Serverless::Function
  Properties:
    Handler: index.handler
    Runtime: nodejs18.x
    Timeout: 30
    Events:
      SQSEvent:
        Type: SQS
        Properties:
          Queue: !GetAtt MyQueue.Arn
          BatchSize: 10
          Enabled: True
          ProvisionedPollerConfig:
            MaximumPollers: 300
            MinimumPollers: 10
```

# FunctionCode
<a name="sam-property-function-functioncode"></a>

[Package de déploiement](https://docs.aws.amazon.com/lambda/latest/dg/deployment-package-v2.html) d'une fonction Lambda.

## Syntaxe
<a name="sam-property-function-functioncode-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-functioncode-syntax.yaml"></a>

```
  [Bucket](#sam-function-functioncode-bucket): String
  [Key](#sam-function-functioncode-key): String
  [Version](#sam-function-functioncode-version): String
```

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

 `Bucket`   <a name="sam-function-functioncode-bucket"></a>
Un compartiment Amazon S3 dans la même AWS région que votre fonction.  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[S3Bucket](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3bucket)` propriété du type de `AWS::Lambda::Function` `Code` données.

 `Key`   <a name="sam-function-functioncode-key"></a>
Clé Amazon S3 du package de déploiement.  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[S3Key](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3key)` propriété du type de `AWS::Lambda::Function` `Code` données.

 `Version`   <a name="sam-function-functioncode-version"></a>
Pour les objets versionnés, la version de l’objet de package de déploiement à utiliser.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[S3ObjectVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3objectversion)` propriété du type de `AWS::Lambda::Function` `Code` données.

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

### FunctionCode
<a name="sam-property-function-functioncode--examples--functioncode"></a>

`CodeUri`: exemple de code de fonction

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

```
CodeUri:
  Bucket: sam-s3-demo-bucket-name
  Key: mykey-name
  Version: 121212
```

# FunctionUrlConfig
<a name="sam-property-function-functionurlconfig"></a>

Crée une URL de AWS Lambda fonction avec les paramètres de configuration spécifiés. Une URL de la fonction Lambda est un point de terminaison HTTPS que vous pouvez utiliser pour appeler votre fonction.

Par défaut, l'URL de la fonction que vous avez créée utilise la version `$LATEST` de votre fonction Lambda. Si vous spécifiez un `AutoPublishAlias` pour votre fonction Lambda, le point de terminaison se connecte à l'alias de fonction spécifié.

Pour plus d'informations, consultez la section [Fonction Lambda URLs](https://docs.aws.amazon.com/lambda/latest/dg/lambda-urls.html) dans le Guide du *AWS Lambda développeur*.

## Syntaxe
<a name="sam-property-function-functionurlconfig-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-functionurlconfig-syntax.yaml"></a>

```
[AuthType](#sam-function-functionurlconfig-authtype): String
[Cors](#sam-function-functionurlconfig-cors): [Cors](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-url-cors.html)
[InvokeMode](#sam-function-functionurlconfig-invokemode): String
```

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

 `AuthType`   <a name="sam-function-functionurlconfig-authtype"></a>
Le type d'autorisation pour votre URL de fonction. Pour utiliser Gestion des identités et des accès AWS (IAM) pour autoriser les demandes, définissez sur. `AWS_IAM` Pour un accès ouvert, définissez la valeur sur `NONE`.  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[AuthType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-authtype)` propriété d'une `AWS::Lambda::Url` ressource.

 `Cors`   <a name="sam-function-functionurlconfig-cors"></a>
Les paramètres du partage de ressources cross-origin (CORS) pour l’URL de votre fonction.  
*Type* : [Cors](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-url-cors.html)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[Cors](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-url-cors.html)` propriété d'une `AWS::Lambda::Url` ressource.

 `InvokeMode`  <a name="sam-function-functionurlconfig-invokemode"></a>
Mode selon lequel votre URL de la fonction sera appelée. Pour que votre fonction renvoie la réponse une fois l'appel terminé, définissez la valeur sur `BUFFERED`. Pour que votre fonction diffuse la réponse, définissez la valeur sur `RESPONSE_STREAM`. La valeur par défaut est `BUFFERED`.  
*Valeurs valides* : `BUFFERED` ou `RESPONSE_STREAM`  
*Type* : chaîne  
*Obligatoire* : non  
*AWS CloudFormation compatibilité* : cette propriété est transmise directement à la [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-invokemode](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-invokemode)propriété d'une `AWS::Lambda::Url` ressource.

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

### URL de fonction
<a name="sam-property-function-functionurlconfig--examples--function-url"></a>

L'exemple suivant crée une fonction Lambda avec une URL de la fonction. L'URL de fonction utilise l'autorisation IAM.

#### YAML
<a name="sam-property-function-functionurlconfig--examples--function-url--yaml"></a>

```
HelloWorldFunction:
  Type: AWS::Serverless::Function
  Properties:
    CodeUri: hello_world/
    Handler: index.handler
    Runtime: nodejs20.x
    FunctionUrlConfig:
      AuthType: AWS_IAM
      InvokeMode: RESPONSE_STREAM

Outputs:
  MyFunctionUrlEndpoint:
      Description: "My Lambda Function URL Endpoint"
      Value:
        Fn::GetAtt: HelloWorldFunctionUrl.FunctionUrl
```

# CapacityProviderConfig
<a name="sam-property-function-capacityproviderconfig"></a>

Configure le fournisseur de capacité auquel les versions publiées de la fonction seront associées. Cela permet à la fonction de s'exécuter sur des EC2 instances appartenant au client et gérées par Lambda.

**Note**  
Cette configuration détermine le type de calcul d'une fonction et doit être spécifiée lors du premier déploiement de la fonction. Il est impossible de l'ajouter ou de le supprimer une fois que la ressource fonctionnelle a été créée.

## Syntaxe
<a name="sam-property-function-capacityproviderconfig-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-capacityproviderconfig-syntax.yaml"></a>

```
[Arn](#sam-function-capacityproviderconfig-arn): String
[ExecutionEnvironmentMemoryGiBPerVCpu](#sam-function-capacityproviderconfig-executionenvironmentmemorygibpervcpu): Float
[PerExecutionEnvironmentMaxConcurrency](#sam-function-capacityproviderconfig-perexecutionenvironmentmaxconcurrency): Integer
```

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

 `Arn`   <a name="sam-function-capacityproviderconfig-arn"></a>
L'ARN du fournisseur de capacité à utiliser pour cette fonction.  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est propre à SAM.

 `ExecutionEnvironmentMemoryGiBPerVCpu`   <a name="sam-function-capacityproviderconfig-executionenvironmentmemorygibpervcpu"></a>
Rapport entre la mémoire (en GiB) et le vCPU pour chaque environnement d'exécution.  
Le ratio de mémoire par processeur ne peut pas dépasser la mémoire totale de la fonction de 2048 Mo. Les memory-to-CPU ratios pris en charge sont de 2 Go, 4 Go ou 8 Go par processeur.
*Type* : flotteur  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ExecutionEnvironmentMemoryGiBPerVCpu](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-lambdamanagedinstancescapacityproviderconfig)` propriété d'une `AWS::Lambda::Function` ressource.

 `PerExecutionEnvironmentMaxConcurrency`   <a name="sam-function-capacityproviderconfig-perexecutionenvironmentmaxconcurrency"></a>
Nombre maximal d'exécutions simultanées par environnement d'exécution (sandbox).  
*Type* : entier  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[PerExecutionEnvironmentMaxConcurrency](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-lambdamanagedinstancescapacityproviderconfig)` propriété d'une `AWS::Lambda::Function` ressource.

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

### Configuration du fournisseur de capacité
<a name="sam-property-function-capacityproviderconfig-examples-basic"></a>

L'exemple suivant montre une configuration de fournisseur de capacité qui fait référence à une ressource de fournisseur de capacité.

```
CapacityProviderConfig:
  Arn: !GetAtt MyCapacityProvider.Arn
  ExecutionEnvironmentMemoryGiBPerVCpu: 4.0
  PerExecutionEnvironmentMaxConcurrency: 100
```

# FunctionScalingConfig
<a name="sam-property-function-functionscalingconfig"></a>

Configure le comportement de dimensionnement pour les versions de fonctions Lambda, en contrôlant le nombre d'environnements d'exécution (sandboxes) pouvant être créés. Cette configuration s'applique à la fois à \$1LATEST.PUBLISHED et aux versions de fonctions numériques.

## Syntaxe
<a name="sam-property-function-functionscalingconfig-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-functionscalingconfig-syntax.yaml"></a>

```
[MinExecutionEnvironments](#sam-function-functionscalingconfig-minexecutionenvironments): Integer
[MaxExecutionEnvironments](#sam-function-functionscalingconfig-maxexecutionenvironments): Integer
```

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

 `MinExecutionEnvironments`   <a name="sam-function-functionscalingconfig-minexecutionenvironments"></a>
Le nombre minimal d'environnements d'exécution à gérer pour la version de la fonction.  
*Type* : entier  
*Obligatoire* : non  
*Par défaut* : `3`  
*Minimum *: `0`  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[MinExecutionEnvironments](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionscalingconfig-minexecutionenvironments)` propriété d'une `AWS::Lambda::Function` ressource.

 `MaxExecutionEnvironments`   <a name="sam-function-functionscalingconfig-maxexecutionenvironments"></a>
Nombre maximal d'environnements d'exécution pouvant être créés pour la version de la fonction.  
*Type* : entier  
*Obligatoire* : non  
*Par défaut* : `3`  
*Minimum *: `0`  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[MaxExecutionEnvironments](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionscalingconfig-maxexecutionenvironments)` propriété d'une `AWS::Lambda::Function` ressource.

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

### Configuration du dimensionnement des fonctions
<a name="sam-property-function-functionscalingconfig-examples-basic"></a>

L'exemple suivant montre une configuration de dimensionnement des fonctions avec des environnements d'exécution minimale et maximale.

```
FunctionScalingConfig:
  MinExecutionEnvironments: 5
  MaxExecutionEnvironments: 100
```