aws_cdk: Add support for description to aws_cdk.ExportValueOptions

[toxygene]

Describe the feature

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

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

Line 1762 in c3c771c

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

[pahud]

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

[toxygene]

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

[github-actions]

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