Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

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

L'oggetto che descrive un tipo di origine `DocumentDB` dell'evento. Per ulteriori informazioni, consulta [Using AWS Lambda with Amazon DocumentDB](https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html) nella *AWS Lambda Developer* Guide.

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

Per dichiarare questa entità nel tuo AWS SAM modello, usa la seguente sintassi.

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

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

 `BatchSize`   <a name="sam-function-documentdb-batchsize"></a>
Il numero massimo di elementi da recuperare in un singolo batch.  
*Tipo*: integer  
*Obbligatorio:* no  
*CloudFormation compatibilità*: questa proprietà viene passata direttamente alla `[ BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` proprietà di una `AWS::Lambda::EventSourceMapping` risorsa.

 `Cluster`   <a name="sam-function-documentdb-cluster"></a>
L'Amazon Resource Name (ARN) del cluster Amazon DocumentDB.  
▬*Tipo:* stringa  
*Obbligatorio:* sì  
*CloudFormation compatibilità*: questa proprietà viene passata direttamente alla `[ EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` proprietà di una `AWS::Lambda::EventSourceMapping` risorsa.

 `CollectionName`   <a name="sam-function-documentdb-collectionname"></a>
Il nome della raccolta da utilizzare all'interno del database. Se non specifichi una raccolta, Lambda utilizza tutte le raccolte.  
▬*Tipo:* stringa  
*Obbligatorio:* no  
*CloudFormation compatibilità*: questa proprietà viene passata direttamente alla `[ CollectionName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-collectionname)` proprietà di un tipo di `AWS::Lambda::EventSourceMapping` `DocumentDBEventSourceConfig` dati.

 `DatabaseName`   <a name="sam-function-documentdb-databasename"></a>
Il nome del database da utilizzare all'interno del cluster Amazon DocumentDB.  
▬*Tipo:* stringa  
*Obbligatorio:* sì  
*CloudFormation compatibilità*: questa proprietà viene passata direttamente alla `[ DatabaseName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-databasename)` proprietà di un tipo di `AWS::Lambda::EventSourceMapping` `DocumentDBEventSourceConfig` dati.

 `Enabled`   <a name="sam-function-documentdb-enabled"></a>
Se`true`, la mappatura della fonte dell'evento è attiva. Per mettere in pausa il polling e la chiamata, imposta su. `false`  
*Tipo*: Booleano  
*Obbligatorio:* no  
*CloudFormation compatibilità*: questa proprietà viene passata direttamente alla `[ Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` proprietà di una risorsa. `AWS::Lambda::EventSourceMapping`

 `FilterCriteria`   <a name="sam-function-documentdb-filtercriteria"></a>
Un oggetto che definisce i criteri che determinano se Lambda deve elaborare un evento. *Per ulteriori informazioni, consulta [Filtraggio degli eventi Lambda](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) nella Developer Guide.AWS Lambda *  
*Tipo:* [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Obbligatorio:* no  
*CloudFormation compatibilità*: questa proprietà viene passata direttamente alla `[ FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` proprietà di una `AWS::Lambda::EventSourceMapping` risorsa.

 `FullDocument`   <a name="sam-function-documentdb-fulldocument"></a>
Determina cosa invia Amazon DocumentDB al tuo flusso di eventi durante le operazioni di aggiornamento dei documenti. Se impostato su`UpdateLookup`, Amazon DocumentDB invia un delta che descrive le modifiche, insieme a una copia dell'intero documento. Altrimenti, Amazon DocumentDB invia solo un documento parziale contenente le modifiche.  
▬*Tipo:* stringa  
*Obbligatorio:* no  
*CloudFormation compatibilità*: questa proprietà viene passata direttamente alla `[ FullDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-fulldocument)` proprietà di un tipo di `AWS::Lambda::EventSourceMapping` `DocumentDBEventSourceConfig` dati.

 `KmsKeyArn`   <a name="sam-function-documentdb-kmskeyarn"></a>
L'Amazon Resource Name (ARN) della chiave per crittografare le informazioni relative a questo evento.  
▬*Tipo:* stringa  
*Obbligatorio:* no  
*CloudFormation compatibilità*: questa proprietà viene passata direttamente alla `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` proprietà di una `AWS::Lambda::EventSourceMapping` risorsa.

 `MaximumBatchingWindowInSeconds`   <a name="sam-function-documentdb-maximumbatchingwindowinseconds"></a>
Il tempo massimo in secondi per la raccolta dei record prima di richiamare la funzione.  
*Tipo*: integer  
*Obbligatorio:* no  
*CloudFormation compatibilità*: questa proprietà viene passata direttamente alla `[ MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` proprietà di una `AWS::Lambda::EventSourceMapping` risorsa.

 `SecretsManagerKmsKeyId`   <a name="sam-function-documentdb-secretsmanagerkmskeyid"></a>
L'ID chiave AWS Key Management Service (AWS KMS) di una chiave gestita dal cliente di AWS Secrets Manager. Richiesto quando si utilizza una chiave gestita dal cliente di Secrets Manager con un ruolo di esecuzione Lambda che non include l'`kms:Decrypt`autorizzazione.  
Il valore di questa proprietà è un UUID. Ad esempio: `1abc23d4-567f-8ab9-cde0-1fab234c5d67`.  
▬*Tipo:* stringa  
*Required*: Conditional  
*CloudFormation compatibilità*: questa proprietà è unica AWS SAM e non ha un CloudFormation equivalente.

 `SourceAccessConfigurations`   <a name="sam-function-documentdb-sourceaccessconfigurations"></a>
Una matrice del protocollo di autenticazione o dell'host virtuale. Specificalo utilizzando il tipo di [SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html)dati.  
Per il tipo di origine dell'`DocumentDB`evento, l'unico tipo di configurazione valido è`BASIC_AUTH`.  
+ `BASIC_AUTH`— Il segreto di Secrets Manager che memorizza le credenziali del broker. Per questo tipo, la credenziale deve essere nel seguente formato:. `{"username": "your-username", "password": "your-password"}` È consentito un solo oggetto di tipo`BASIC_AUTH`.
Tipo: elenco  
*Obbligatorio:* sì  
*CloudFormation compatibilità*: questa proprietà viene passata direttamente alla `[ SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations)` proprietà di una `AWS::Lambda::EventSourceMapping` risorsa.

 `StartingPosition`   <a name="sam-function-documentdb-startingposition"></a>
La posizione in un flusso da cui iniziare la lettura.  
+ `AT_TIMESTAMP`— Specificare l'ora a partire dalla quale iniziare a leggere i record.
+ `LATEST`— Leggi solo i nuovi record.
+ `TRIM_HORIZON`— Elabora tutti i record disponibili.
▬*Tipo:* stringa  
*Obbligatorio:* sì  
*CloudFormation compatibilità*: questa proprietà viene passata direttamente alla `[ StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)` proprietà di una `AWS::Lambda::EventSourceMapping` risorsa.

 `StartingPositionTimestamp`   <a name="sam-function-documentdb-startingpositiontimestamp"></a>
L'ora da cui iniziare a leggere, in secondi di tempo Unix. Definisce `StartingPositionTimestamp` quando `StartingPosition` è specificato come`AT_TIMESTAMP`.  
*Tipo:* numero a doppia precisione  
*Obbligatorio:* no  
*CloudFormation compatibilità*: questa proprietà viene passata direttamente alla `[ StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)` proprietà di una `AWS::Lambda::EventSourceMapping` risorsa.

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

### Fonte di eventi 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"
```