@aws-cdk/aws-redshift-alpha: Add comments for redshift tables construct #22682
Labels
@aws-cdk/aws-redshift
Related to Amazon Redshift
effort/small
Small work item – less than a day of effort
feature-request
A feature should be added or improved.
p2
Comments
ksco92
added
feature-request
peterwoodworth
added
p2
effort/small
|
For the Glue table we are able to make use of the CloudFormation Glue Table description property. However for Redshift we make use of a custom resource which I'm personally not too familiar with. But this custom resource gives us quite a bit of freedom, if there's any way to create comments with the Redshift API then we should be able to support this 🙂 |
4 tasks
4 tasks
mergify bot
pushed a commit
that referenced
this issue
Feb 3, 2023
Adds comments to tables. closes #22682 ---- ### All Submissions: * [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) ### Adding new Construct Runtime Dependencies: * [ ] This PR adds new construct runtime dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-construct-runtime-dependencies) ### New Features * [x] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)? * [x] 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
Describe the feature
Currently we have this construct:
https://docs.aws.amazon.com/cdk/api/v2/docs/@aws-cdk_aws-redshift-alpha.Table.html
In order to be able to fully utilize CI/CD for tables and generate version controlled documentation, we need to be able to add table descriptions through code. A simple
descriptionattribute like in Glue tables should be enough:https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_aws-glue.Table.html
Use Case
The current table construct allows the programmatic creation and modification of tables, however, in real life, comments for documentation are critical in any big data use case for automated documentation.
This addition will bring CDK one step closer to being able to fully manage a Redshift's table table structure and documentation.
Proposed Solution
Add a
descriptionattribute to the table construct.Other Information
No response
Acknowledgements
CDK version used
2.45
Environment details (OS name and version, etc.)
AmazonLinux2
The text was updated successfully, but these errors were encountered: