Skip to content
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

(aws-cdk-lib.aws_elasticloadbalancingv2): The documentation for the instead function is incorrect. #25748

Closed
kikusu opened this issue May 26, 2023 · 4 comments · Fixed by #25762
Labels
aws-cdk-lib Related to the aws-cdk-lib package documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p2

Comments

@kikusu
Copy link

kikusu commented May 26, 2023

Describe the issue

On aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationTargetGroup#metricRequestCountPerTarget
it says Use ``ApplicationTargetGroup.metrics.ipv6RequestCount`` instead,
but I think it is a mistake for Use ``ApplicationTargetGroup.metrics.requestCountPerTarget`` instead

Links

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationTargetGroup.html#metricwbrrequestwbrcountwbrperwbrtargetpropsspan-classapi-icon-api-icon-deprecated-titlethis-api-element-is-deprecated-its-use-is-not-recommended%EF%B8%8Fspan

* @deprecated Use ``ApplicationTargetGroup.metrics.ipv6RequestCount`` instead

@kikusu kikusu added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels May 26, 2023
@github-actions github-actions bot added the aws-cdk-lib Related to the aws-cdk-lib package label May 26, 2023
@khushail
Copy link
Contributor

Hi @kikusu ,thanks for mentioning this bug in the documentation. This should be fixed as I can see in the docs, should be replaced with ApplicationTargetGroup.metrics.requestCountPerTarget.

@khushail khushail added p2 effort/small Small work item – less than a day of effort and removed needs-triage This issue or PR still needs to be triaged. labels May 26, 2023
@Zishanwang1992
Copy link
Contributor

I plan to make a quick fix if no one takes this issue.

@github-actions
Copy link

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

1 similar comment
@github-actions
Copy link

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
aws-cdk-lib Related to the aws-cdk-lib package documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p2
Projects
None yet
3 participants