DocumentDB

L'oggetto che descrive un tipo di sorgente di eventiDocumentDB. Per ulteriori informazioni, consulta Using AWS Lambda with Amazon DocumentDB nella AWS Lambda Developer Guide.

Sintassi

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

YAML

BatchSize: Integer
Cluster: String
CollectionName: String
DatabaseName: String
Enabled: Boolean
FilterCriteria: FilterCriteria
FullDocument: String
KmsKeyArn: String  
MaximumBatchingWindowInSeconds: Integer
SecretsManagerKmsKeyId: String
SourceAccessConfigurations: List
StartingPosition: String
StartingPositionTimestamp: Double

Proprietà

BatchSize

Il numero massimo di elementi da recuperare in un singolo batch.

Tipo: integer

Required: No

AWS CloudFormation compatibilità: questa proprietà viene passata direttamente alla BatchSize proprietà di una AWS::Lambda::EventSourceMapping risorsa.

Cluster

L'Amazon Resource Name (ARN) del cluster Amazon DocumentDB.

Tipo: Stringa

Campo obbligatorio: sì

AWS CloudFormation compatibilità: questa proprietà viene passata direttamente alla EventSourceArn proprietà di una AWS::Lambda::EventSourceMapping risorsa.

CollectionName

Il nome della raccolta da utilizzare all'interno del database. Se non specifichi una raccolta, Lambda utilizza tutte le raccolte.

Tipo: Stringa

Required: No

AWS CloudFormation compatibilità: questa proprietà viene passata direttamente alla CollectionName proprietà di un tipo di AWS::Lambda::EventSourceMapping DocumentDBEventSourceConfig dati.

DatabaseName

Il nome del database da utilizzare all'interno del cluster Amazon DocumentDB.

Tipo: Stringa

Campo obbligatorio: sì

AWS CloudFormation compatibilità: questa proprietà viene passata direttamente alla DatabaseName proprietà di un tipo di AWS::Lambda::EventSourceMapping DocumentDBEventSourceConfig dati.

Enabled

Setrue, la mappatura della fonte dell'evento è attiva. Per mettere in pausa il polling e la chiamata, imposta su. false

Tipo: Booleano

Required: No

AWS CloudFormation compatibilità: questa proprietà viene passata direttamente alla Enabled proprietà di una risorsa. AWS::Lambda::EventSourceMapping

FilterCriteria

Un oggetto che definisce i criteri che determinano se Lambda deve elaborare un evento. Per ulteriori informazioni, consulta Filtraggio degli eventi Lambda nella Developer Guide.AWS Lambda

Tipo: FilterCriteria

Required: No

AWS CloudFormation compatibilità: questa proprietà viene passata direttamente alla FilterCriteria proprietà di una AWS::Lambda::EventSourceMapping risorsa.

FullDocument

Determina ciò che Amazon DocumentDB invia al tuo flusso di eventi durante le operazioni di aggiornamento dei documenti. Se impostato suUpdateLookup, 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

Required: No

AWS CloudFormation compatibilità: questa proprietà viene passata direttamente alla FullDocument proprietà di un tipo di AWS::Lambda::EventSourceMapping DocumentDBEventSourceConfig dati.

KmsKeyArn

L'Amazon Resource Name (ARN) della chiave per crittografare le informazioni relative a questo evento.

Tipo: Stringa

Required: No

AWS CloudFormation compatibilità: questa proprietà viene passata direttamente alla KmsKeyArn proprietà di una AWS::Lambda::EventSourceMapping risorsa.

MaximumBatchingWindowInSeconds

Il tempo massimo in secondi per la raccolta dei record prima di richiamare la funzione.

Tipo: integer

Required: No

AWS CloudFormation compatibilità: questa proprietà viene passata direttamente alla MaximumBatchingWindowInSeconds proprietà di una AWS::Lambda::EventSourceMapping risorsa.

SecretsManagerKmsKeyId

L'ID chiave AWS Key Management Service (AWS KMS) di una chiave gestita dal cliente da 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:Decryptautorizzazione.

Il valore di questa proprietà è unUUID. Ad esempio: 1abc23d4-567f-8ab9-cde0-1fab234c5d67.

Tipo: Stringa

Required: Conditional

AWS CloudFormation compatibilità: questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

SourceAccessConfigurations

Una matrice del protocollo di autenticazione o dell'host virtuale. Specificalo utilizzando il tipo di SourceAccessConfigurationsdati.

Per il tipo di origine dell'DocumentDBevento, 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 tipoBASIC_AUTH.

Tipo: Elenco

Campo obbligatorio: sì

AWS CloudFormation compatibilità: questa proprietà viene passata direttamente alla SourceAccessConfigurations proprietà di una AWS::Lambda::EventSourceMapping risorsa.

StartingPosition

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

Campo obbligatorio: sì

AWS CloudFormation compatibilità: questa proprietà viene passata direttamente alla StartingPosition proprietà di una AWS::Lambda::EventSourceMapping risorsa.

StartingPositionTimestamp

L'ora da cui iniziare a leggere, in secondi di tempo Unix. Definisce StartingPositionTimestamp quando StartingPosition è specificato comeAT_TIMESTAMP.

Tipo: double

Required: No

AWS CloudFormation compatibilità: questa proprietà viene passata direttamente alla StartingPositionTimestamp proprietà di una AWS::Lambda::EventSourceMapping risorsa.

Esempi

Fonte di eventi Amazon DocumentDB

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"