-
Notifications
You must be signed in to change notification settings - Fork 3.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(rds): clarify how to enable S3Import/S3Export in Readme.md #30459
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 Actually now that I think of it, the error message |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 |
@@ -938,6 +938,7 @@ Data in S3 buckets can be imported to and exported from certain database engines | |||
functionality, set the `s3ImportBuckets` and `s3ExportBuckets` properties for import and export respectively. When | |||
configured, the CDK automatically creates and configures IAM roles as required. | |||
Additionally, the `s3ImportRole` and `s3ExportRole` properties can be used to set this role directly. | |||
Note that when using `s3ImportRole` and/or `s3ExportRole` with AuroraPostgres, you need to enable the respectives feature when declaring the DatabaseClusterEngine. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is the 'respectives' feature? Having trouble finding out more information about it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It refer to the s3Import and s3Export features
this._features = {
s3Import: auroraPostgresFeatures?.s3Import ? 's3Import' : undefined,
s3Export: auroraPostgresFeatures?.s3Export ? 's3Export' : undefined,
};
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Feel free to rephrase - good to have an external view
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it accurate to say this?
To use s3ImportRole and s3ExportRole with Aurora PostgreSQL, you must also configure the S3 import and export features when creating the DatabaseClusterEngine.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think enable would be more appropriate - as it is turning a boolean flag to true
I updated the PR with an example - it might also make sense to update the error message |
Updated after comments 🙌 |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
Good on my side 👍 |
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 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
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