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_guardduty: interface CFNTaggingProperty status property has incorrect documentation #30930

Open
tlindsay42 opened this issue Jul 23, 2024 · 1 comment
Labels
@aws-cdk/aws-guardduty Related to Amazon Guard Duty bug This issue is a bug. documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p3

Comments

@tlindsay42
Copy link
Member

Describe the issue

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_guardduty.CfnMalwareProtectionPlan.CFNTaggingProperty.html lists the value of status as a string and the example shows a value of status, but the valid values in the GuardDuty API Reference and boto3 docs are ENABLED | DISABLED.

Links

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_guardduty.CfnMalwareProtectionPlan.CFNTaggingProperty.html

@tlindsay42 tlindsay42 added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Jul 23, 2024
@github-actions github-actions bot added the @aws-cdk/aws-guardduty Related to Amazon Guard Duty label Jul 23, 2024
@khushail khushail added the investigating This issue is being investigated and/or work is in progress to resolve the issue. label Jul 23, 2024
@khushail khushail self-assigned this Jul 23, 2024
@khushail khushail removed the needs-triage This issue or PR still needs to be triaged. label Jul 23, 2024
@khushail
Copy link
Contributor

Hey @tlindsay42 , thanks for reporting this.
The CDK docs are based on Cloudformation docs and I can see that in the Cloudformation docs that its defined as string although No example has been given and in the CDK Python docs, the example given needs correction. I would mark this issue for consideration and improvement but There is feedback button on top of the page , you can submit your feedback on docs improvement as well.

@khushail khushail added p3 effort/small Small work item – less than a day of effort and removed investigating This issue is being investigated and/or work is in progress to resolve the issue. labels Jul 23, 2024
@khushail khushail removed their assignment Jul 23, 2024
@moelasmar moelasmar added the bug This issue is a bug. label Aug 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/aws-guardduty Related to Amazon Guard Duty bug This issue is a bug. documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p3
Projects
None yet
Development

No branches or pull requests

3 participants