(DynamoEventSourceProps): Need to update the AWS documentation #33744
Labels
@aws-cdk/aws-lambda-event-sources
documentation
This is a problem with documentation.
needs-triage
This issue or PR still needs to be triaged.
Describe the issue
Please update the AWS documentation for CDK DynamoEventSourceProps. The current documentation could be clearer about implementing filters for DynamoDB event sources.
The current recommended approach is indeed to use FilterCriteria rather than the raw filter patterns. Here's an example on implementation of filters for DynamoDB event sources using CDK v2:
The FilterCriteria class provides a more type-safe and maintainable way to define filters.
Please update the documentation to reflect:
{ [string]: any }[]
type notationThe documentation is unclear which leads to lot of search and clicking various links to understand how the filter works.
Links
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda_event_sources.DynamoEventSourceProps.html
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda_event_sources.DynamoEventSource.html
https://docs.aws.amazon.com/lambda/latest/dg/with-ddb-filtering.html#filtering-ddb
The text was updated successfully, but these errors were encountered: