Skip to content

Commit

Permalink
fix(lambda-event-sources): incorrect documented defaults for stream t…
Browse files Browse the repository at this point in the history
…ypes

The defaults documented for `maxRecordAge` and `retryAttempts`
properties for event sources that are 'stream' type were documented
incorrectly.

The implementation falls back to the defaults provided by
CloudFormation.

fixes #13908
  • Loading branch information
Niranjan Jayakar committed May 6, 2021
1 parent 0c1acc3 commit 4adcc0d
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions packages/@aws-cdk/aws-lambda-event-sources/lib/stream.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ export interface StreamEventSourceProps {
* * Minimum value of 60 seconds
* * Maximum value of 7 days
*
* @default Duration.days(7)
* @default - the record is available for processing until it expires
*/
readonly maxRecordAge?: Duration;

Expand All @@ -51,7 +51,7 @@ export interface StreamEventSourceProps {
* * Minimum value of 0
* * Maximum value of 10000
*
* @default 10000
* @default - retry until the record expires
*/
readonly retryAttempts?: number;

Expand Down

0 comments on commit 4adcc0d

Please sign in to comment.