docs(lambda-event-source): improve docstring in KinesisEventSourceProps#29582
docs(lambda-event-source): improve docstring in KinesisEventSourceProps#29582mergify[bot] merged 10 commits intoaws:mainfrom
Conversation
aws-cdk-automation
left a comment
There was a problem hiding this comment.
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.
maxRecordAge in KinesisEventSourcePropsmaxRecordAge in KinesisEventSourceProps
maxRecordAge in KinesisEventSourcePropsmaxRecordAge in KinesisEventSourceProps
maxRecordAge in KinesisEventSourceProps✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
lpizzinidev
left a comment
There was a problem hiding this comment.
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:
- User creates
KinesisEventSourcespecifyingmaxRecordAgeto some value
new KinesisEventSource(stream, {
...
maxRecordAge: cdk.Duration.seconds(100),
});- User updates stack and removes
maxRecordAgefrom declaredKinesisEventSource:
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.
|
Hi @lpizzinidev Thanks for the review and pointing out the update use case. However, I couldn't reproduce what you mentioned there. Steps:
If this is not the case on your end, could you help to share your step to reproduce this issue? Thanks. |
|
Hi @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
left a comment
There was a problem hiding this comment.
Thanks for this docs improvement; the wording is super clear.
|
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 CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
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). |
Issue # (if applicable)
Closes #27321
Reason for this change
Our customer found
maxRecordAgecan't be set to-1Due to limitation ofcdk.Duration. However, it's not obvious in the docstring that the default value ofmaxRecordAgeis 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
maxRecordAgeandretryAttemptsinKinesisEventSourcePropsinaws-lambda-event-sourceDescription of how you validated changes
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license