From 20379eb1f6d51079fe1bbfb4b03f372dec4cce2c Mon Sep 17 00:00:00 2001 From: Kaizen Conroy Date: Fri, 9 Sep 2022 10:26:28 -0400 Subject: [PATCH] docs(lambda-event-sources): document different defaults for different stream sources --- packages/@aws-cdk/aws-lambda-event-sources/lib/stream.ts | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/packages/@aws-cdk/aws-lambda-event-sources/lib/stream.ts b/packages/@aws-cdk/aws-lambda-event-sources/lib/stream.ts index e8f7f2a40de3e..7a597c13813f4 100644 --- a/packages/@aws-cdk/aws-lambda-event-sources/lib/stream.ts +++ b/packages/@aws-cdk/aws-lambda-event-sources/lib/stream.ts @@ -28,9 +28,11 @@ export interface BaseStreamEventSourceProps{ /** * The maximum amount of time to gather records before invoking the function. - * Maximum of Duration.minutes(5) + * Maximum of Duration.minutes(5). * - * @default Duration.seconds(0) + * @see https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#invocation-eventsourcemapping-batching + * + * @default - Duration.seconds(0) for Kinesis, DynamoDB, and SQS event sources, Duration.millis(500) for MSK, self-managed Kafka, and Amazon MQ. */ readonly maxBatchingWindow?: Duration;