aws / aws-cdk

The AWS Cloud Development Kit is a framework for defining cloud infrastructure in code
https://aws.amazon.com/cdk
Apache License 2.0
11.5k stars 3.84k forks source link

aws_guardduty: interface CFNTaggingProperty status property has incorrect documentation #30930

Open tlindsay42 opened 1 month ago

tlindsay42 commented 1 month ago

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

khushail commented 1 month ago

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.