Skip to content
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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 9 commits into from
Jul 24, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
e138cf5
Update README.md of aws-cdk-lib/aws-rds with details to enable S3Impo…
duranbe Jun 5, 2024
7182e9b
docs(rds): Clarify how to enable S3Import/S3Export
duranbe Jun 5, 2024
f64d3d9
Add details for enabling S3Import/S3Export
duranbe Jun 15, 2024
6b5bcf5
Update README.md
duranbe Jul 3, 2024
b4e38b1
Update README.md
duranbe Jul 10, 2024
179375b
Update cluster.ts
duranbe Jul 10, 2024
e883ecb
Update packages/aws-cdk-lib/aws-rds/README.md
scanlonp Jul 17, 2024
c303657
Merge branch 'main' into patch-1
duranbe Jul 22, 2024
1ce95f2
Merge branch 'main' into patch-1
mergify[bot] Jul 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/aws-cdk-lib/aws-rds/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: To use `s3ImportRole` and `s3ExportRole` with Aurora PostgreSQL, you must also enable the S3 import and export features when you create the DatabaseClusterEngine.

You can read more about loading data to (or from) S3 here:

Expand Down
4 changes: 2 additions & 2 deletions packages/aws-cdk-lib/aws-rds/lib/cluster.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ interface DatabaseClusterBaseProps {
* This feature is only supported by the Aurora database engine.
*
* This property must not be used if `s3ImportBuckets` is used.
*
* To use this property with Aurora PostgreSQL, it must be configured with the S3 import feature enabled when creating the DatabaseClusterEngine
* For MySQL:
* @see https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Integrating.LoadFromS3.html
*
Expand Down Expand Up @@ -284,7 +284,7 @@ interface DatabaseClusterBaseProps {
* This feature is only supported by the Aurora database engine.
*
* This property must not be used if `s3ExportBuckets` is used.
*
* To use this property with Aurora PostgreSQL, it must be configured with the S3 export feature enabled when creating the DatabaseClusterEngine
* For MySQL:
* @see https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Integrating.SaveIntoS3.html
*
Expand Down