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 (#14562)

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


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
Niranjan Jayakar committed May 12, 2021
1 parent 8a9f6bb commit 0ea24e9
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 retention period configured on the stream
*/
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 0ea24e9

Please sign in to comment.