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.

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
12 changes: 10 additions & 2 deletions packages/aws-cdk-lib/aws-lambda-event-sources/lib/stream.ts
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,11 @@ export interface StreamEventSourceProps extends BaseStreamEventSourceProps {
* * Minimum value of 60 seconds
* * Maximum value of 7 days
*
roger-zhangg marked this conversation as resolved.
Show resolved Hide resolved
* @default - the retention period configured on the stream
* The default value is -1, which sets the maximum age to infinite.
* When the value is set to infinite, Lambda never discards old records.
* Record are valid until it expires in the event source.
*
* @default -1
*/
readonly maxRecordAge?: Duration;

Expand All @@ -73,7 +77,11 @@ export interface StreamEventSourceProps extends BaseStreamEventSourceProps {
* * Minimum value of 0
* * Maximum value of 10000
*
roger-zhangg marked this conversation as resolved.
Show resolved Hide resolved
* @default - retry until the record expires
* The default value is -1, which sets the maximum number of retries to infinite.
* When MaximumRetryAttempts is infinite, Lambda retries failed records until
* the record expires in the event source.
*
* @default -1
*/
readonly retryAttempts?: number;

Expand Down