Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

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

El objeto que describe un tipo de fuente de evento `DocumentDB`. Para obtener más información, consulte [Uso AWS Lambda con Amazon DocumentDB](https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html) en la Guía para *AWS Lambda desarrolladores*.

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

Para declarar esta entidad en la AWS SAM plantilla, utilice la siguiente sintaxis.

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

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

 `BatchSize`   <a name="sam-function-documentdb-batchsize"></a>
El número máximo de elementos que se recuperan en un único lote.  
*Tipo*: entero  
*Obligatorio*: no  
*CloudFormation compatibilidad*: esta propiedad se pasa directamente a la `[ BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` propiedad de un `AWS::Lambda::EventSourceMapping` recurso.

 `Cluster`   <a name="sam-function-documentdb-cluster"></a>
El nombre de recurso de Amazon (ARN) del clúster de Amazon DocumentDB.  
*Tipo:* cadena  
*Obligatorio*: sí  
*CloudFormation compatibilidad*: esta propiedad se pasa directamente a la `[ EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` propiedad de un `AWS::Lambda::EventSourceMapping` recurso.

 `CollectionName`   <a name="sam-function-documentdb-collectionname"></a>
El nombre de la colección a consumir dentro de la base de datos. Si no especifica ninguna colección, Lambda consume todas las colecciones.  
*Tipo:* cadena  
*Obligatorio*: no  
*CloudFormation compatibilidad*: esta propiedad se pasa directamente a la `[ CollectionName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-collectionname)` propiedad de un tipo de `AWS::Lambda::EventSourceMapping` `DocumentDBEventSourceConfig` datos.

 `DatabaseName`   <a name="sam-function-documentdb-databasename"></a>
El nombre de la base de datos a consumir dentro del clúster de Amazon DocumentDB.  
*Tipo:* cadena  
*Obligatorio*: sí  
*CloudFormation compatibilidad*: esta propiedad se pasa directamente a la `[ DatabaseName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-databasename)` propiedad de un tipo de `AWS::Lambda::EventSourceMapping` `DocumentDBEventSourceConfig` datos.

 `Enabled`   <a name="sam-function-documentdb-enabled"></a>
Si es `true`, la asignación de orígenes de eventos está activa. Establézcalo en `false` para poner en pausa el sondeo y la invocación.  
*Tipo*: Booleano  
*Obligatorio*: no  
*CloudFormation compatibilidad*: esta propiedad se pasa directamente a la `[ Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` propiedad de un `AWS::Lambda::EventSourceMapping` recurso.

 `FilterCriteria`   <a name="sam-function-documentdb-filtercriteria"></a>
Un objeto que define los criterios que determinan si Lambda debe procesar un evento o no. Para obtener más información, consulta [Filtrado de eventos de Lambda](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) en la *Guía para desarrolladores de AWS Lambda *.  
*Tipo:* [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Obligatorio*: no  
*CloudFormation compatibilidad*: esta propiedad se pasa directamente a la `[ FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` propiedad de un `AWS::Lambda::EventSourceMapping` recurso.

 `FullDocument`   <a name="sam-function-documentdb-fulldocument"></a>
Determina lo que Amazon DocumentDB envía al flujo de eventos durante las operaciones de actualización del documento. Si se establece en `UpdateLookup`, Amazon DocumentDB envía un delta que describe los cambios, junto con una copia del documento completo. De lo contrario, Amazon DocumentDB envía solo un documento parcial que contiene los cambios.  
*Tipo:* cadena  
*Obligatorio*: no  
*CloudFormation compatibilidad*: esta propiedad se pasa directamente a la `[ FullDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-fulldocument)` propiedad de un tipo de `AWS::Lambda::EventSourceMapping` `DocumentDBEventSourceConfig` datos.

 `KmsKeyArn`   <a name="sam-function-documentdb-kmskeyarn"></a>
El nombre de recurso de Amazon (ARN) de la clave de que se utilizará para cifrar la información de este evento.  
*Tipo:* cadena  
*Obligatorio*: no  
*CloudFormation compatibilidad*: esta propiedad se pasa directamente a la `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` propiedad de un `AWS::Lambda::EventSourceMapping` recurso.

 `MaximumBatchingWindowInSeconds`   <a name="sam-function-documentdb-maximumbatchingwindowinseconds"></a>
La cantidad de tiempo máxima para recopilar registros antes de invocar la función, en segundos.  
*Tipo*: Entero  
*Obligatorio*: no  
*CloudFormation compatibilidad*: esta propiedad se pasa directamente a la `[ MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` propiedad de un `AWS::Lambda::EventSourceMapping` recurso.

 `SecretsManagerKmsKeyId`   <a name="sam-function-documentdb-secretsmanagerkmskeyid"></a>
El identificador de clave AWS Key Management Service (AWS KMS) de una clave gestionada por el cliente de AWS Secrets Manager. Se requiere cuando se utiliza una clave gestionada por el cliente de Secrets Manager con un rol de ejecución de Lambda que no incluye el permiso `kms:Decrypt`.  
El valor de esta propiedad es un UUID. Por ejemplo: `1abc23d4-567f-8ab9-cde0-1fab234c5d67`.  
*Tipo:* cadena  
*Obligatorio*: condicional  
*CloudFormation compatibilidad*: esta propiedad es exclusiva AWS SAM y no tiene un CloudFormation equivalente.

 `SourceAccessConfigurations`   <a name="sam-function-documentdb-sourceaccessconfigurations"></a>
Matriz del protocolo de autenticación o del host virtual. Especifique esto mediante el tipo [SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html)de datos.  
Para el tipo de origen del evento `DocumentDB`, el único tipo de configuración válido es `BASIC_AUTH`  
+ `BASIC_AUTH`: el secreto de Secrets Manager que almacena las credenciales del agente. Para este tipo, la credencial debe tener el siguiente formato: `{"username": "your-username", "password": "your-password"}`. Solo se permite un objeto de tipo `BASIC_AUTH`.
*Tipo*: lista  
*Obligatorio*: sí  
*CloudFormation compatibilidad*: esta propiedad se pasa directamente a la `[ SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations)` propiedad de un `AWS::Lambda::EventSourceMapping` recurso.

 `StartingPosition`   <a name="sam-function-documentdb-startingposition"></a>
La posición en el flujo donde comienza la lectura.  
+ `AT_TIMESTAMP`: especifique el tiempo a partir del cual comenzar la lectura de registros.
+ `LATEST`: registros nuevos de solo lectura.
+ `TRIM_HORIZON`: procese todos los registros disponibles.
*Tipo:* cadena  
*Obligatorio*: sí  
*CloudFormation compatibilidad*: esta propiedad se pasa directamente a la `[ StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)` propiedad de un `AWS::Lambda::EventSourceMapping` recurso.

 `StartingPositionTimestamp`   <a name="sam-function-documentdb-startingpositiontimestamp"></a>
El tiempo a partir del cual comenzar la lectura, en segundos de tiempo Unix. Defina `StartingPositionTimestamp` cuando `StartingPosition` se especifica como `AT_TIMESTAMP`.  
*Tipo*: Doble  
*Obligatorio*: no  
*CloudFormation compatibilidad*: esta propiedad se pasa directamente a la `[ StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)` propiedad de un `AWS::Lambda::EventSourceMapping` recurso.

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

### Origen de eventos de 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"
```