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.

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