Skip to content
v2.277.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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_lambda as lambda_

document_db_event_source_config_property = lambda.CfnEventSourceMapping.DocumentDBEventSourceConfigProperty(
    collection_name="collectionName",
    database_name="databaseName",
    full_document="fullDocument"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.lambda.*;

DocumentDBEventSourceConfigProperty documentDBEventSourceConfigProperty = DocumentDBEventSourceConfigProperty.builder()
        .collectionName("collectionName")
        .databaseName("databaseName")
        .fullDocument("fullDocument")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Lambda;

var documentDBEventSourceConfigProperty = new DocumentDBEventSourceConfigProperty {
    CollectionName = "collectionName",
    DatabaseName = "databaseName",
    FullDocument = "fullDocument"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

documentDBEventSourceConfigProperty := &DocumentDBEventSourceConfigProperty{
	CollectionName: jsii.String("collectionName"),
	DatabaseName: jsii.String("databaseName"),
	FullDocument: jsii.String("fullDocument"),
}

Properties ​

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

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

databaseNameoptionalstringdatabase_nameoptionalstrdatabaseNameoptionalStringDatabaseNameoptionalstringDatabaseNameoptional*string #
The name of the database to consume within the DocumentDB cluster.
fullDocumentoptionalstringfull_documentoptionalstrfullDocumentoptionalStringFullDocumentoptionalstringFullDocumentoptional*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.