Skip to content

Commit

Permalink
docs(elasticloadbalancingv2): update confusing AddNetworkTargets port…
Browse files Browse the repository at this point in the history
… description (#30208)

### Reason for this change

The existing `port` description can be confusing as `listener` could easily be mistaken as a reference to a Load Balancers `listener` and imply that the value should match.

Additionally, "traffic" seems more semtantically correct for an NLB than "requests".

### Description of changes

Updated the `port` description on `AddNetworkTargetsProps`  to match the one used in the `ApplicationTargetGroup` as that uses less ambigous language.

### Checklist
- [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
domestic-fennec authored Sep 4, 2024
1 parent d0f9688 commit ee04fff
Showing 1 changed file with 1 addition and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ export interface AddNetworkActionProps {
*/
export interface AddNetworkTargetsProps {
/**
* The port on which the listener listens for requests.
* The port on which the target receives traffic.
*
* @default Determined from protocol if known
*/
Expand Down

0 comments on commit ee04fff

Please sign in to comment.