aws / aws/aws-cdk

aws_guardduty: interface CFNTaggingProperty status property has incorrect documentation

Open
#30,930 2 comments 1 reaction 0 assignees View on GitHub
@aws-cdk/aws-guardduty bug documentation effort/small p3
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
2d 3h
Merged PRs (30d)
83

Description

### 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](https://docs.aws.amazon.com/guardduty/latest/APIReference/API_MalwareProtectionPlanTaggingAction.html) and [boto3 docs](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/guardduty/client/create_malware_protection_plan.html) are `ENABLED` | `DISABLED`.

### Links

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

Contributor guide

Open the contributing guide

Research direction

Start with the linked AWS CDK API documentation entry for CfnMalwareProtectionPlan.CFNTaggingProperty and compare its status description and example with the linked GuardDuty API Reference and boto3 documentation. Done means the generated documentation identifies ENABLED and DISABLED as the valid values and no longer presents status as the example value.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, typescript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.