Skip to content

docs(elasticloadbalancingv2): set proper default for stickiness#29726

Merged
mergify[bot] merged 2 commits intoaws:mainfrom
msambol:29725
Apr 4, 2024
Merged

docs(elasticloadbalancingv2): set proper default for stickiness#29726
mergify[bot] merged 2 commits intoaws:mainfrom
msambol:29725

Conversation

@msambol
Copy link
Copy Markdown
Contributor

@msambol msambol commented 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

@github-actions github-actions bot added the distinguished-contributor [Pilot] contributed 50+ PRs to the CDK label Apr 4, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team April 4, 2024 16:37
@github-actions github-actions bot added bug This issue is a bug. p2 labels Apr 4, 2024
Copy link
Copy Markdown
Contributor

@nmussy nmussy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, matches the behavior:

if (props.stickinessCookieDuration) {
this.enableCookieStickiness(props.stickinessCookieDuration, props.stickinessCookieName);
} else {
this.setAttribute('stickiness.enabled', 'false');
}

@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Apr 4, 2024
@TheRealAmazonKendra
Copy link
Copy Markdown
Contributor

I die on the inside a little every time I see this https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-elasticloadbalancingv2/lib/alb/application-target-group.ts#L73

   * Note: `stickinessCookieName` parameter depends on the presence of `stickinessCookieDuration` parameter.
   * If `stickinessCookieDuration` is not set, `stickinessCookieName` will be omitted.

But, that's not your change. Yours is good. Thanks for fixing that. I'm going to rename this a docs change for better clarity on what was updated.

@TheRealAmazonKendra TheRealAmazonKendra changed the title chore(elasticloadbalancingv2): set proper default for stickiness docs(elasticloadbalancingv2): set proper default for stickiness Apr 4, 2024
@aws-cdk-automation aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Apr 4, 2024
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Apr 4, 2024

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
Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

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

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

@mergify mergify bot merged commit 069013e into aws:main Apr 4, 2024
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Apr 4, 2024

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
Copy link
Copy Markdown
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

bug This issue is a bug. distinguished-contributor [Pilot] contributed 50+ PRs to the CDK p2

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

4 participants