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

aws-cdk-lib: Possibly incorrect default value spec in type-doc for stickinessCookieDuration for ApplicationTargetGroup #29725

Closed
exalted opened this issue Apr 4, 2024 · 3 comments · Fixed by #29726
Labels
aws-cdk-lib Related to the aws-cdk-lib package bug This issue is a bug. effort/small Small work item – less than a day of effort p2

Comments

@exalted
Copy link
Contributor

exalted commented Apr 4, 2024

Describe the bug

I believe this type-doc that claims the default value to be "1 days" is not accurate.

Following the code path, I think, the behavior rather is that, if stickinessCookieDuration wasn't set, then the stickiness is not enabled; and if it is defined it must be between 1 second and 7 days (604800 seconds) —this last bit is correctly specified in the type-doc.

Expected Behavior

See issue description

Current Behavior

See issue description

Reproduction Steps

See issue description

Possible Solution

No response

Additional Information/Context

No response

CDK CLI Version

2.125.0 (build 5e3c3c6)

Framework Version

No response

Node.js Version

node v18.19.1

OS

macOS 14.4.1 (23E224)

Language

TypeScript

Language Version

No response

Other information

No response

@exalted exalted added bug This issue is a bug. needs-triage This issue or PR still needs to be triaged. labels Apr 4, 2024
@github-actions github-actions bot added the aws-cdk-lib Related to the aws-cdk-lib package label Apr 4, 2024
@khushail
Copy link
Contributor

khushail commented Apr 4, 2024

@exalted , thanks for reporting it.

Thanks @msambol for submitting a PR!

@khushail khushail added p2 effort/small Small work item – less than a day of effort and removed needs-triage This issue or PR still needs to be triaged. labels Apr 4, 2024
@mergify mergify bot closed this as completed in #29726 Apr 4, 2024
mergify bot pushed a commit that referenced this issue Apr 4, 2024
By default, stickiness is disabled. The duration _is_ one day if stickiness is enabled,
but we don't surface that option to users. If `stickinessCookieDuration` is not 
supplied, stickiness will not be enabled so the 1 day default doesn't make sense here.

Closes #29725.

----

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

github-actions bot commented Apr 4, 2024

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

@aws-cdk-automation
Copy link
Collaborator

Comments on closed issues and PRs are hard for our team to see. If you need help, please open a new issue that references this one.

@aws aws locked as resolved and limited conversation to collaborators Jul 25, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
aws-cdk-lib Related to the aws-cdk-lib package bug This issue is a bug. effort/small Small work item – less than a day of effort p2
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants