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

Feature: Add ability to set stack description #4457

Closed
2 tasks
TomDufall opened this issue Oct 10, 2019 · 3 comments · Fixed by #4477
Closed
2 tasks

Feature: Add ability to set stack description #4457

TomDufall opened this issue Oct 10, 2019 · 3 comments · Fixed by #4477
Assignees
Labels
@aws-cdk/core Related to core CDK functionality feature-request A feature should be added or improved. good first issue Related to contributions. See CONTRIBUTING.md

Comments

@TomDufall
Copy link
Contributor

Cloudformation stacks have a description field. This should be setable through the CDK.
There is currently no documented way to set it.

Use Case

Descriptions provide a more human-friendly form of documentation. In my case, I have stacks in a shared environment and I'd like it to be clear to others what they are and who they belong to.

Proposed Solution

A 'description' stack property would fulfill this requirement.

Other

Description field as viewed in the console:
Image of description field in the console

Current documentation - no description property: https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_core.Stack.html

  • 👋 I may be able to implement this feature request
  • ⚠️ This feature might incur a breaking change

This is a 🚀 Feature Request

@TomDufall TomDufall added feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Oct 10, 2019
@NGL321 NGL321 added good first issue Related to contributions. See CONTRIBUTING.md @aws-cdk/core Related to core CDK functionality and removed needs-triage This issue or PR still needs to be triaged. labels Oct 10, 2019
@NGL321
Copy link
Contributor

NGL321 commented Oct 10, 2019

Hey @tom98784,

Thank you for submitting this request! This seems totally reasonable, and not too difficult to implement.

If you would like to submit a PR one of us will review it, otherwise someone will update this issue when there is further information!

@nmussy
Copy link
Contributor

nmussy commented Oct 11, 2019

From what I can see, the change set description isn't set when calling createChangeSet (there's a Description field there too), but in the template body.

The most appropriate I can see to implement this feature would be in CdkToolkit.deploy.

@tom98784 Tell me if you'd like to give it a shot, otherwise I'd be happy to make a PR.

@TomDufall
Copy link
Contributor Author

@nmussy I've never done any TS so I'm not that confident, but it's a relatively straightforward change so I'll give it a go. If I've got nowhere in a few days/end up not having time to do it, I'll let you know.

@mergify mergify bot closed this as completed in #4477 Oct 11, 2019
mergify bot pushed a commit that referenced this issue Oct 11, 2019
* Add description parameter to StackProps

* Test new description StackProp
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/core Related to core CDK functionality feature-request A feature should be added or improved. good first issue Related to contributions. See CONTRIBUTING.md
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants