aws / aws/aws-cdk

(docs): Include resource type of the construct on the docs pages

Open
#34,071 1 comment 1 reaction 0 assignees View on GitHub
docs/generated effort/medium feature-request p2
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
1d 19h
Merged PRs (30d)
71

Description

### Describe the feature

It would be nice to have the created resource types of the constructs on the docs pages or a link to the relevant cfn docs page.

E.g. A [Stack](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.Stack.html) creates a `AWS::CloudFormation::Stack` or [docs page](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html).

### Use Case

When creating tests It's not easy to get the constructed template in a readable format or to list resources etc. so being able to dive into a `template.hasResourceProperties(...)` because you know the cfn type would be useful.

### Proposed Solution

_No response_

### Other Information

_No response_

### Acknowledgements

- [ ] I may be able to implement this feature request
- [ ] This feature might incur a breaking change

### CDK version used

2.188.0

### Environment details (OS name and version, etc.)

N/A

Contributor guide

Open the contributing guide

Research direction

Start with the linked Stack documentation page and the referenced AWS CloudFormation resource documentation to understand the desired presentation. Check how construct documentation pages currently expose related information, then verify that the completed docs identify the created resource type or link to its CloudFormation page, including for Stack.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, typescript
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.