aws-cdk-lib.aws_lambda.CfnEventSourceMapping.DocumentDBEventSourceConfigProperty

interface DocumentDBEventSourceConfigProperty

LanguageType name
.NETAmazon.CDK.AWS.Lambda.CfnEventSourceMapping.DocumentDBEventSourceConfigProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awslambda#CfnEventSourceMapping_DocumentDBEventSourceConfigProperty
Javasoftware.amazon.awscdk.services.lambda.CfnEventSourceMapping.DocumentDBEventSourceConfigProperty
Pythonaws_cdk.aws_lambda.CfnEventSourceMapping.DocumentDBEventSourceConfigProperty
TypeScript aws-cdk-lib » aws_lambda » CfnEventSourceMapping » DocumentDBEventSourceConfigProperty

Specific configuration settings for a DocumentDB event source.

Example

// 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

NameTypeDescription
collectionName?stringThe name of the collection to consume within the database.
databaseName?stringThe name of the database to consume within the DocumentDB cluster.
fullDocument?stringDetermines what DocumentDB sends to your event stream during document update operations.

collectionName?

Type: string (optional)

The name of the collection to consume within the database.

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


databaseName?

Type: string (optional)

The name of the database to consume within the DocumentDB cluster.


fullDocument?

Type: string (optional)

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.