Skip to content

docs(elasticloadbalancingv2): clarify the behavior of the open listener property#19019

Merged
mergify[bot] merged 2 commits intoaws:masterfrom
corymhall:corymhall/elbv2-listener-docs
Feb 17, 2022
Merged

docs(elasticloadbalancingv2): clarify the behavior of the open listener property#19019
mergify[bot] merged 2 commits intoaws:masterfrom
corymhall:corymhall/elbv2-listener-docs

Conversation

@corymhall
Copy link
Copy Markdown
Contributor

The documentation for the open property leads to some confusion on the
actual behavior. Setting open to true will not open up the listener
since listeners do not have security groups. It will instead open up the
load balancer on the listener port.

There is a bug report #6281 that says this property should be moved to
the load balancer, but I think the current behavior is the intended
behavior and that the current documentation just makes it confusing.
The intention of this property is to give an easy way to add a security
group rule to the load balancer security group that allows anyone to
access the load balancer on the port of the listener. If we were to move
this property to the load balancer it would become more cumbersome
because we would have to also provide the port that we want to allow
traffic on (load balancers do not have a port).

closes #6281


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

…ener property

The documentation for the `open` property leads to some confusion on the
actual behavior. Setting `open` to `true` will not open up the listener
since listeners do not have security groups. It will instead open up the
load balancer on the listener port.

There is a bug report #6281 that says this property should be moved to
the load balancer, but I think the current behavior is the intended
behavior and that the current documentation just makes it confusing.
The intention of this property is to give an easy way to add a security
group rule to the load balancer security group that allows anyone to
access the load balancer on the port of the listener. If we were to move
this property to the load balancer it would become more cumbersome
because we would have to also provide the port that we want to allow
traffic on (load balancers do not have a port).

closes #6281
@gitpod-io
Copy link
Copy Markdown

gitpod-io bot commented Feb 17, 2022

@corymhall corymhall requested a review from a team February 17, 2022 14:38
@github-actions github-actions bot added the @aws-cdk/aws-elasticloadbalancingv2 Related to Amazon Elastic Load Balancing V2 label Feb 17, 2022
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Feb 17, 2022
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Feb 17, 2022

Thank you for contributing! Your pull request will be updated from master 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: AutoBuildProject89A8053A-LhjRyN9kxr8o
  • Commit ID: 679ce5b
  • 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 c289e8a into aws:master Feb 17, 2022
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Feb 17, 2022

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

TikiTDO pushed a commit to TikiTDO/aws-cdk that referenced this pull request Feb 21, 2022
…ener property (aws#19019)

The documentation for the `open` property leads to some confusion on the
actual behavior. Setting `open` to `true` will not open up the listener
since listeners do not have security groups. It will instead open up the
load balancer on the listener port.

There is a bug report aws#6281 that says this property should be moved to
the load balancer, but I think the current behavior is the intended
behavior and that the current documentation just makes it confusing.
The intention of this property is to give an easy way to add a security
group rule to the load balancer security group that allows anyone to
access the load balancer on the port of the listener. If we were to move
this property to the load balancer it would become more cumbersome
because we would have to also provide the port that we want to allow
traffic on (load balancers do not have a port).

closes aws#6281


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

@aws-cdk/aws-elasticloadbalancingv2 Related to Amazon Elastic Load Balancing V2 contribution/core This is a PR that came from AWS.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

elbv2: open property should be on LoadBalancer, not on Listener.

3 participants