docs(rds): clarify how to enable S3Import/S3Export in Readme.md#30459
docs(rds): clarify how to enable S3Import/S3Export in Readme.md#30459mergify[bot] merged 9 commits intoaws:mainfrom duranbe:patch-1
Conversation
aws-cdk-automation
left a comment
There was a problem hiding this comment.
The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.
A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.
✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
aaythapa
left a comment
There was a problem hiding this comment.
Hi, thanks for making this change! Is there any documentation that supports this claim? Just want to make sure before approving
|
Hello ! 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 |
scanlonp
left a comment
There was a problem hiding this comment.
Hey @duranbe, quick note. Our doc generation has some odd behavior with respect to tags (@see, @default, etc.). Any text after a tag will be omitted. Only the last @see link will be used.
Take a look at s3ExportRole in our docs (link). You'll see that 'For PostgreSQL:' does not show up. Also the link is the PostgreSQL link (the last one).
While this problem is widespread in the file, you should be good only fixing the formatting for these two props. That should help your changes to actually show up!
|
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
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. |
|
Thanks @scanlonp ! |
…30459) ### Reason for this change Documentation does not state clearly that feature needs to be manually enabled when using Postgres Example : The following code will fail with the error message ```ts const cluster = new rds.DatabaseCluster(this, 'Database', { engine: rds.DatabaseClusterEngine.auroraPostgres({version: AuroraPostgresEngineVersion.of('12.7','12')}), writer: rds.ClusterInstance.provisioned('writer', { instanceType: ec2.InstanceType.of(ec2.InstanceClass.R6G, ec2.InstanceSize.XLARGE4), }), serverlessV2MinCapacity: 6.5, serverlessV2MaxCapacity: 64, s3ImportRole: sampleRole }); ``` Will fail with this error message :`Error: s3Import is not supported for Postgres version: 12.7. Use a version that supports the s3Import feature` But the thing is that 12.7 does support it ! The real problem here is that the feature needs to be enabled as such ```ts const cluster = new rds.DatabaseCluster(this, 'Database', { engine: rds.DatabaseClusterEngine.auroraPostgres({version: AuroraPostgresEngineVersion.of('12.7','12', {s3Export: true, s3Import:true})}), writer: rds.ClusterInstance.provisioned('writer', { instanceType: ec2.InstanceType.of(ec2.InstanceClass.R6G, ec2.InstanceSize.XLARGE4), }), serverlessV2MinCapacity: 6.5, serverlessV2MaxCapacity: 64, s3ImportRole: sampleRole }); ``` ### 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](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*
|
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. |
Reason for this change
Documentation does not state clearly that feature needs to be manually enabled when using Postgres
Example :
The following code will fail with the error message
Will fail with this error message :
Error: s3Import is not supported for Postgres version: 12.7. Use a version that supports the s3Import featureBut the thing is that 12.7 does support it ! The real problem here is that the feature needs to be enabled as such
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