Skip to content

Commit

Permalink
chore: document ELBv2 'open' property more clearly (aws#6810)
Browse files Browse the repository at this point in the history
Avoid confusion about the default value.

Fixes aws#6694.
  • Loading branch information
rix0rrr authored Mar 19, 2020
1 parent 4c1e030 commit cc6b0cd
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions packages/@aws-cdk/aws-elasticloadbalancingv2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,13 @@ const lb = new elbv2.ApplicationLoadBalancer(this, 'LB', {
});

// Add a listener and open up the load balancer's security group
// to the world. 'open' is the default, set this to 'false'
// and use `listener.connections` if you want to be selective
// about who can access the listener.
// to the world.
const listener = lb.addListener('Listener', {
port: 80,

// 'open: true' is the default, you can leave it out if you want. Set it
// to 'false' and use `listener.connections` if you want to be selective
// about who can access the load balancer.
open: true,
});

Expand Down

0 comments on commit cc6b0cd

Please sign in to comment.