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

CfnInsightRule: Name restrictions are not documented #27327

Closed
madsid opened this issue Sep 27, 2023 · 3 comments
Closed

CfnInsightRule: Name restrictions are not documented #27327

madsid opened this issue Sep 27, 2023 · 3 comments
Labels
@aws-cdk/aws-cloudwatch Related to Amazon CloudWatch documentation This is a problem with documentation. effort/small Small work item – less than a day of effort needs-cfn This issue is waiting on changes to CloudFormation before it can be addressed. p2

Comments

@madsid
Copy link

madsid commented Sep 27, 2023

Describe the issue

Rule name has a restriction INVALID_RULE_NAME: RuleName “<Redacted>” does not match the pattern: [A-Za-z0-9][A-Za-z0-9\-\_\.]{0,126}[A-Za-z0-9] (Service: AmazonCloudWatch; Status Code: 400; Error Code: InvalidParameterValue. This should have been documented in the CfnInsightRuleProps props type or description

Links

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch.CfnInsightRule.html
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch.CfnInsightRuleProps.html

@madsid madsid added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Sep 27, 2023
@github-actions github-actions bot added the @aws-cdk/aws-cloudwatch Related to Amazon CloudWatch label Sep 27, 2023
@khushail
Copy link
Contributor

khushail commented Sep 28, 2023

Hi @madsid , thanks for reporting this.

@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 Sep 28, 2023
@peterwoodworth peterwoodworth added the needs-cfn This issue is waiting on changes to CloudFormation before it can be addressed. label Sep 28, 2023
@peterwoodworth
Copy link
Contributor

Our docs are sourced from CloudFormation, who likely source from the service. The best way to create tickets to improve that documentation is to use the feedback buttons at the bottom of docs pages

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-insightrule.html
https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutInsightRule.html

@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/aws-cloudwatch Related to Amazon CloudWatch documentation This is a problem with documentation. effort/small Small work item – less than a day of effort needs-cfn This issue is waiting on changes to CloudFormation before it can be addressed. p2
Projects
None yet
Development

No branches or pull requests

3 participants