-
Notifications
You must be signed in to change notification settings - Fork 3.9k
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: elaborate that crossZoneEnabled property cannot be changed for ALB in ELBv2. #29893
docs: elaborate that crossZoneEnabled property cannot be changed for ALB in ELBv2. #29893
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
9f19d1c
to
c2766ec
Compare
✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
I would suggest we fix here as well: aws-cdk/packages/aws-cdk-lib/aws-elasticloadbalancingv2/lib/shared/base-load-balancer.ts Line 246 in c2766ec
Because the L2 |
@@ -51,7 +51,7 @@ export interface BaseLoadBalancerProps { | |||
/** | |||
* Indicates whether cross-zone load balancing is enabled. | |||
* | |||
* @default - false for Network Load Balancers and true for Application Load Balancers. | |||
* @default - false for Network Load Balancers and true for Application Load Balancers (this cannot be changed). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@aaythapa In #29866 (comment) and #29866 (comment), it is mentioned that the crossZone
could be disabled at Target Group
level per docs and it already works per example. However, it cannot be changed at ALB level per docs.
Both Target Group level and ALB level are different scopes. :)
This PR is only to make it clear in LoadBalancer docs that it cannot be changed at ALB level. @pahud is coming up with consolidated PR for some additional change (in addition to change in this PR).
NOTE: I'm unsure what will happen in CloudFormation deployment if we enforce crossZone
to false
, when service itself doesn't support disabling it at ALB level (will it fail or will it ignore it).
Closing this PR in favor of #29907. |
Issue #29866
Closes #29866.
Reason for this change
Per below documentation:
With Application Load Balancers, cross-zone load balancing is always turned on at the load balancer level, and cannot be turned off.
. It also specifies,For target groups, the default is to use the load balancer setting, but you can override the default by explicitly turning cross-zone load balancing off at the target group level.
load_balancing.cross_zone.enabled
thatIndicates whether cross-zone load balancing is enabled. The possible values are true and false. The default for Network Load Balancers and Gateway Load Balancers is false. The default for Application Load Balancers is true, and cannot be changed.
.So for Application Load Balancer, cross-zone load balancing is always turned on at the load balancer level, and cannot be turned off.
Description of changes
Elaborate API documentation for ELBv2 that
crossZoneEnabled
property cannot be changed forALB
in ELBv2.Description of how you validated changes
N/A
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license