DocumentDB

Das Objekt, das einen DocumentDB Ereignisquellentyp beschreibt. Weitere Informationen finden Sie unter Using AWS Lambda with Amazon DocumentDB im AWS Lambda Developer Guide.

Syntax

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer AWS SAM Vorlage zu deklarieren.

YAML

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

Eigenschaften

BatchSize

Gibt die maximale Anzahl der Elemente an, die in einem einzigen Stapel zurückzugeben werden.

Typ: Ganzzahl

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die BatchSize Eigenschaft einer AWS::Lambda::EventSourceMapping Ressource übergeben.

Cluster

Der Amazon-Ressourcenname (ARN) des Amazon DocumentDB-Clusters.

Typ: Zeichenfolge

Erforderlich: Ja

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die EventSourceArn Eigenschaft einer AWS::Lambda::EventSourceMapping Ressource übergeben.

CollectionName

Der Name der Sammlung, die in der Datenbank verwendet werden soll. Wenn Sie keine Sammlung angeben, verbraucht Lambda alle Sammlungen.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die CollectionName Eigenschaft eines AWS::Lambda::EventSourceMapping DocumentDBEventSourceConfig Datentyps übergeben.

DatabaseName

Der Name der Datenbank, die innerhalb des Amazon DocumentDB-Clusters verwendet werden soll.

Typ: Zeichenfolge

Erforderlich: Ja

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die DatabaseName Eigenschaft eines AWS::Lambda::EventSourceMapping DocumentDBEventSourceConfig Datentyps übergeben.

Enabled

Fallstrue, ist die Zuordnung der Ereignisquelle aktiv. Um die Abfrage und den Aufruf zu unterbrechen, legen Sie den Wert auf fest. false

Typ: Boolesch

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die Enabled Eigenschaft einer AWS::Lambda::EventSourceMapping Ressource übergeben.

FilterCriteria

Ein Objekt, das die Kriterien definiert, die bestimmen, ob Lambda ein Ereignis verarbeiten soll. Weitere Informationen finden Sie unter Lambda-Ereignisfilterung im AWS Lambda Developer Guide.

Typ: FilterCriteria

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die FilterCriteria Eigenschaft einer AWS::Lambda::EventSourceMapping Ressource übergeben.

FullDocument

Legt fest, was Amazon DocumentDB bei Dokumentaktualisierungen an Ihren Event-Stream sendet. Wenn auf gesetztUpdateLookup, sendet Amazon DocumentDB ein Delta, das die Änderungen beschreibt, zusammen mit einer Kopie des gesamten Dokuments. Andernfalls sendet Amazon DocumentDB nur einen Teil des Dokuments, das die Änderungen enthält.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die FullDocument Eigenschaft eines AWS::Lambda::EventSourceMapping DocumentDBEventSourceConfig Datentyps übergeben.

MaximumBatchingWindowInSeconds

Die maximale Zeitspanne zur Erfassung von Datensätzen vor dem Aufruf der Funktion in Sekunden.

Typ: Ganzzahl

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die MaximumBatchingWindowInSeconds Eigenschaft einer AWS::Lambda::EventSourceMapping Ressource übergeben.

SecretsManagerKmsKeyId

Die AWS Key Management Service (AWS KMS) Schlüssel-ID eines vom Kunden verwalteten Schlüssels von AWS Secrets Manager. Erforderlich, wenn Sie einen vom Kunden verwalteten Schlüssel von Secrets Manager mit einer Lambda-Ausführungsrolle verwenden, die die kms:Decrypt Berechtigung nicht enthält.

Der Wert dieser Eigenschaft ist eine UUID. Beispiel: 1abc23d4-567f-8ab9-cde0-1fab234c5d67.

Typ: Zeichenfolge

Required: Conditional

AWS CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein AWS CloudFormation Äquivalent.

SourceAccessConfigurations

Ein Array des Authentifizierungsprotokolls oder des virtuellen Hosts. Geben Sie dies mithilfe des SourceAccessConfigurationsDatentyps an.

Für den Typ der DocumentDB Ereignisquelle ist der einzig gültige KonfigurationstypBASIC_AUTH.

• BASIC_AUTH— Das Secrets Manager Manager-Geheimnis, in dem Ihre Broker-Anmeldeinformationen gespeichert werden. Für diesen Typ müssen die Anmeldeinformationen das folgende Format haben:{"username": "your-username", "password": "your-password"}. Nur ein Objekt des Typs BASIC_AUTH ist zulässig.

Typ: Liste

Erforderlich: Ja

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die SourceAccessConfigurations Eigenschaft einer AWS::Lambda::EventSourceMapping Ressource übergeben.

StartingPosition

Die Position im Stream, an der mit dem Lesen begonnen wird.

• AT_TIMESTAMP— Geben Sie einen Zeitpunkt an, ab dem mit dem Lesen von Datensätzen begonnen werden soll.

• LATEST— Nur neue Datensätze lesen.

• TRIM_HORIZON— Verarbeitet alle verfügbaren Datensätze.

Typ: Zeichenfolge

Erforderlich: Ja

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die StartingPosition Eigenschaft einer AWS::Lambda::EventSourceMapping Ressource übergeben.

StartingPositionTimestamp

Die Zeit, ab der mit dem Lesen begonnen werden soll, in Unix-Zeitsekunden. DefiniertStartingPositionTimestamp, wann als angegeben StartingPosition istAT_TIMESTAMP.

Type: Double

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die StartingPositionTimestamp Eigenschaft einer AWS::Lambda::EventSourceMapping Ressource übergeben.

Beispiele

Amazon DocumentDB DocumentDB-Ereignisquelle

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"