aws-cdk
aws-cdk copied to clipboard
docs(rds): clarify how to enable S3Import/S3Export in Readme.md
Reason for this change
Documentation does not state clearly that feature needs to be manually enabled when using Postgres
Description of changes
Small update to Readme.md and inline TSdoc
Description of how you validated changes
None
Checklist
- [x] My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license
Hello ! Sure I can, here is the AWS Doc for S3Import, that mentions this feature to choose from.
As well, here is the relevant code that checks if the S3Import/S3Export feature has been enabled, which by default is false
https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-rds/lib/cluster-engine.ts#L1061
Actually now that I think of it, the error message s3Import is not supported for Postgres version: ${this.engineVersion.fullVersion}. Use a version that supports the s3Import feature. is a bit misleading as the issue could also be not having enabled the feature when declaring the DatabaseClusterEngine
Hey @scanlonp - thanks for the advice, indeed this is a odd behavior, I modified as I expect to render. Is there a way to build locally the doc ? I might have missed it in the contributing guide
I updated the PR with an example - it might also make sense to update the error message
Updated after comments 🙌
Good on my side 👍
the wording is all thanks to @evzzk !
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).
AWS CodeBuild CI Report
- CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
- Commit ID: 1ce95f265bd174f876a87c00a6d2f89daeb536cd
- Result: SUCCEEDED
- Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).
Comments on closed issues and PRs are hard for our team to see. If you need help, please 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.
Thanks @scanlonp !
Comments on closed issues and PRs are hard for our team to see. If you need help, please open a new issue that references this one.