Skip to content
v2.273.0

DocumentDBEventSourceConfigProperty Struct ​

Specific configuration settings for a DocumentDB event source.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lambda as lambda } from 'aws-cdk-lib';
const documentDBEventSourceConfigProperty: lambda.CfnEventSourceMapping.DocumentDBEventSourceConfigProperty = {
  collectionName: 'collectionName',
  databaseName: 'databaseName',
  fullDocument: 'fullDocument',
};

Properties ​

collectionNamestringcollection_namestrcollectionNameStringCollectionNamestringCollectionName*string#
The name of the collection to consume within the database.

If you do not specify a collection, Lambda consumes all collections.

databaseNamestringdatabase_namestrdatabaseNameStringDatabaseNamestringDatabaseName*string#
The name of the database to consume within the DocumentDB cluster.
fullDocumentstringfull_documentstrfullDocumentStringFullDocumentstringFullDocument*string#
Determines what DocumentDB sends to your event stream during document update operations.

If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes.