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

aws_cdk: Add support for description to aws_cdk.ExportValueOptions #29092

Closed
2 tasks
toxygene opened this issue Feb 13, 2024 · 3 comments · Fixed by #29150
Closed
2 tasks

aws_cdk: Add support for description to aws_cdk.ExportValueOptions #29092

toxygene opened this issue Feb 13, 2024 · 3 comments · Fixed by #29150
Labels
effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2

Comments

@toxygene
Copy link

Describe the feature

aws_cdk.ExportValueOptions currently does not expose a property for setting the description of the CfnOutput it creates.

export interface ExportValueOptions {

Use Case

I would like to be able to set the description of the CfnOutput created when using aws_cdk.Stack.exportValue and aws_cdk.Stack.exportStringListValue.

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.114.1 (build 02bbb1d)

Environment details (OS name and version, etc.)

MacOS 14.3.1

@toxygene toxygene added feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Feb 13, 2024
@pahud
Copy link
Contributor

pahud commented Feb 14, 2024

According to the doc, Export only supports Name. Can you share some code sample or snippets that you expect ?

@pahud pahud added p2 effort/medium Medium work item – several days of effort and removed needs-triage This issue or PR still needs to be triaged. labels Feb 14, 2024
@toxygene
Copy link
Author

toxygene commented Feb 14, 2024

My request is that the CfnOutput created by aws_cdk.Stack.exportValue and aws_cdk.Stack.exportStringListValue add support for setting the Description of the CloudFormation output.

For example:

this.exportValue("test", {
  description: "the description for the value",
  name: "testing"
})

would produce:

Outputs:
  [...]:
    Description: the description for the value
    Value: test
    Export:
      Name: testing

@mergify mergify bot closed this as completed in #29150 Feb 23, 2024
mergify bot pushed a commit that referenced this issue Feb 23, 2024
…alue` methods (#29150)

### Issue # (if applicable)

Closes #29092.

### Reason for this change

To be able to set the description of the `CfnOutput` created when using `exportValue` and `exportStringListValue`.

### Description of changes

Add property `description` to `ExportValueOptions` interface.

### Description of how you validated changes

Both unit and integ tests

### Checklist
- [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
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
effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants