aws / aws/aws-cdk

aws-logs: Support for logs insights query folders missing from docs

Open
#21,437 2 comments 3 reactions 0 assignees View on GitHub
@aws-cdk/aws-logs documentation effort/small feature-request p2
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
2d 3h
Merged PRs (30d)
83

Description

### Describe the issue

When defining logs insight queries from the CloudWatch console, you have the ability to organize your queries into folders. The Logs Insights Query Definition construct also supports the ability to define folders when creating queries, by simply adding a / to the queryDefinitionName prop. This is a feature that many teams would find useful, and so it would be nice to update the docs to make it clear that this feature is also supported by the L2 construct, since there is currently no mention of it.

### Links

- https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs-readme.html
- https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.QueryDefinition.html
- https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.QueryDefinitionProps.html
- https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_Insights-Saving-Queries.html

Contributor guide

Open the contributing guide

Research direction

Start with the aws-cdk-lib.aws_logs README and the QueryDefinition and QueryDefinitionProps API documentation linked in the issue. Confirm how queryDefinitionName supports slash-separated folders, then document that behavior and verify the resulting documentation clearly explains how to define a folder.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.