aws-cdk icon indicating copy to clipboard operation
aws-cdk copied to clipboard

docs(rds): clarify how to enable S3Import/S3Export in Readme.md

Open duranbe opened this issue 1 year ago • 3 comments

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


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

duranbe avatar Jun 05 '24 18:06 duranbe

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

duranbe avatar Jun 10 '24 21:06 duranbe

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

duranbe avatar Jun 15 '24 20:06 duranbe

I updated the PR with an example - it might also make sense to update the error message

duranbe avatar Jul 08 '24 19:07 duranbe

Updated after comments 🙌

duranbe avatar Jul 10 '24 16:07 duranbe

Good on my side 👍

duranbe avatar Jul 11 '24 09:07 duranbe

the wording is all thanks to @evzzk !

duranbe avatar Jul 17 '24 18:07 duranbe

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).

mergify[bot] avatar Jul 24 '24 18:07 mergify[bot]

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

aws-cdk-automation avatar Jul 24 '24 19:07 aws-cdk-automation

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).

mergify[bot] avatar Jul 24 '24 19:07 mergify[bot]

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.

github-actions[bot] avatar Jul 24 '24 19:07 github-actions[bot]

Thanks @scanlonp !

duranbe avatar Jul 24 '24 19:07 duranbe

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.

aws-cdk-automation avatar Jul 25 '24 20:07 aws-cdk-automation