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.

Sign up for GitHub

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

Jump to bottom

NestedStack: nested stack properties does not allow to set its description #16337

Closed
ttais2017 opened this issue Sep 2, 2021 · 3 comments · Fixed by #20930
Closed

NestedStack: nested stack properties does not allow to set its description #16337

ttais2017 opened this issue Sep 2, 2021 · 3 comments · Fixed by #20930
Labels
effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. good first issue Related to contributions. See CONTRIBUTING.md p1

Comments

@ttais2017
Copy link

ttais2017 commented Sep 2, 2021 •
edited
Loading

so like the StackProps.builder() allows to set the 'description' field of the given stack, the NestedStackProps should also allow to set the description of a nested stack

This is a 🚀 Feature Request
@ttais2017 ttais2017 added feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Sep 2, 2021
@gruber76
Copy link

gruber76 commented Oct 26, 2021 •
edited
Loading

As a (horrible) workaround, you can do the following:

  const myNestedStack = new NestedStack(stack, 'nestedStackName')

  myNestedStack.templateOptions.description = 'Nested Stack description'

@peterwoodworth peterwoodworth added good first issue Related to contributions. See CONTRIBUTING.md p1 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 May 28, 2022
@peterwoodworth
Copy link
Contributor

I believe all we'd need to do is add the description prop to NestedStackProps, then pass that into the super() call.

aws-cdk/packages/@aws-cdk/core/lib/nested-stack.ts

Line 116 in ea69ad2

super(scope, id, {

@joe-king-sh joe-king-sh mentioned this issue Jun 30, 2022
Merged
4 tasks
@mergify mergify bot closed this as completed in #20930 Jul 8, 2022
mergify bot pushed a commit that referenced this issue Jul 8, 2022
@joe-king-sh
feat(core): add a description parameter for the NestedStackProps (#20930
5ef106b 
)

This PR adds a description parameter for the NestedStackProps.

Fixes #16337

----

### All Submissions:

* [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md)

### Adding new Unconventional Dependencies:

* [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies)

### New Features

* [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)?
	* [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)?

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@github-actions
Copy link

github-actions bot commented Jul 8, 2022

⚠️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.

daschaa pushed a commit to daschaa/aws-cdk that referenced this issue Jul 9, 2022
@joe-king-sh @daschaa
feat(core): add a description parameter for the NestedStackProps (aws…
e7f4602 
…#20930)

This PR adds a description parameter for the NestedStackProps.

Fixes aws#16337

----

### All Submissions:

* [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md)

### Adding new Unconventional Dependencies:

* [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies)

### New Features

* [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)?
	* [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)?

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. good first issue Related to contributions. See CONTRIBUTING.md p1
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(core): add a description parameter for the NestedStackProps joe-king-sh/aws-cdk
3 participants
@gruber76 @ttais2017 @peterwoodworth