Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(lambda-event-source): improve docstring in KinesisEventSourceProps #29582

Merged
merged 10 commits into from
Mar 27, 2024
Merged

docs(lambda-event-source): improve docstring in KinesisEventSourceProps #29582

Changes from 4 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
9258b17
fix docstring
roger-zhangg Mar 21, 2024
9ecafc8
Merge branch 'aws:main' into gh-27321-docstring
roger-zhangg Mar 22, 2024
357b0ac
fix default for retryAttempts
roger-zhangg Mar 22, 2024
c09c8fc
Merge branch 'main' into gh-27321-docstring
roger-zhangg Mar 22, 2024
726ee6b
fix lint
roger-zhangg Mar 22, 2024
18eec54
Merge branch 'gh-27321-docstring' of github.com:roger-zhangg/aws-cdk …
roger-zhangg Mar 22, 2024
5950f3f
address luca suggestion
roger-zhangg Mar 26, 2024
7f732d5
Merge branch 'main' into gh-27321-docstring
roger-zhangg Mar 26, 2024
6901a7e
Merge branch 'gh-27321-docstring' of github.com:roger-zhangg/aws-cdk …
roger-zhangg Mar 26, 2024
588f574
Merge branch 'main' into gh-27321-docstring
mergify[bot] Mar 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions packages/aws-cdk-lib/aws-lambda-event-sources/lib/stream.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,9 @@ export interface StreamEventSourceProps extends BaseStreamEventSourceProps {
* * Minimum value of 60 seconds
* * Maximum value of 7 days
*
* @default - the retention period configured on the stream
* @default -1
* sets the maximum age to infinite. When infinite, Lambda never discards old records.
* The retention period configured on the stream now decides max age for records.
*/
readonly maxRecordAge?: Duration;

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

Expand Down
Loading