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

[roger-zhangg]

Issue # (if applicable)

Closes #27321

Reason for this change

Our customer found maxRecordAge can't be set to -1 Due to limitation of cdk.Duration. However, it's not obvious in the docstring that the default value of maxRecordAge is already -1. Our customer can simply leave this prop empty to set it to -1.

So, This PR improves the docstring to make default value more apparent.

See more discussion in the ticket.

Description of changes

Improve docstring of maxRecordAge and retryAttempts in KinesisEventSourceProps in aws-lambda-event-source

Description of how you validated changes

Checklist

• My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

---

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

[aws-cdk-automation]

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

[lpizzinidev]

Thanks 👍
Left some suggestions, feel free to improve it further.

Note that I don't think this will solve #27321 completely as we still won't be able to update the maxRecordAge value for existing KinesisEventSource resources, eg:

1. User creates KinesisEventSource specifying maxRecordAge to some value

new KinesisEventSource(stream, {
  ...
  maxRecordAge: cdk.Duration.seconds(100),
});

2. User updates stack and removes maxRecordAge from declared KinesisEventSource:

new KinesisEventSource(stream, {
  ...
  maxRecordAge: undefined,
});

I think that the maxRecordAge will remain at 100 seconds (please correct me if I'm wrong).
Ie, we need a way to specify maxRecordAge: -1 to support all use cases. 

[roger-zhangg]

Hi @lpizzinidev Thanks for the review and pointing out the update use case. However, I couldn't reproduce what you mentioned there.

Steps:

• I created a stack with maxRecordAge: cdk.Duration.seconds(100),
• I can see maxRecordAge is set to 100 in Lambda console.
• I updated stack by removing maxRecordAge prop.
• I can see maxRecordAge is set to -1 in Lambda console.

If this is not the case on your end, could you help to share your step to reproduce this issue? Thanks.

[lpizzinidev]

Hi @roger-zhangg ✋
My assumption was wrong then, thanks for taking the time and running the scenario!
If you can please go ahead and update the documentation as suggested (feel free to improve it further of course) then this will be good to go for me 👍

[roger-zhangg]

Hi @TheRealAmazonKendra @lpizzinidev Thanks for the suggestions and I'd like to get your review on this so we can move forward.

[scanlonp]

Thanks for this docs improvement; the wording is super clear.

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

[aws-cdk-automation]

AWS CodeBuild CI Report

• CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
• Commit ID: 588f574
• Result: SUCCEEDED
• Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).