From e138cf50a75ebf3c043c04e5699d251178c6c67d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Durand?= Date: Wed, 5 Jun 2024 20:48:42 +0200 Subject: [PATCH 1/7] Update README.md of aws-cdk-lib/aws-rds with details to enable S3Import/S3Export feature --- packages/aws-cdk-lib/aws-rds/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/aws-cdk-lib/aws-rds/README.md b/packages/aws-cdk-lib/aws-rds/README.md index 973762247098e..663cc55a65896 100644 --- a/packages/aws-cdk-lib/aws-rds/README.md +++ b/packages/aws-cdk-lib/aws-rds/README.md @@ -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. You can read more about loading data to (or from) S3 here: From 7182e9beaa4a8713ef406d7d5df0cc31009f2ec2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Durand?= Date: Wed, 5 Jun 2024 20:59:32 +0200 Subject: [PATCH 2/7] docs(rds): Clarify how to enable S3Import/S3Export --- packages/aws-cdk-lib/aws-rds/lib/cluster.ts | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/aws-cdk-lib/aws-rds/lib/cluster.ts b/packages/aws-cdk-lib/aws-rds/lib/cluster.ts index 30bfd914d6303..ba04763f22fd6 100644 --- a/packages/aws-cdk-lib/aws-rds/lib/cluster.ts +++ b/packages/aws-cdk-lib/aws-rds/lib/cluster.ts @@ -258,6 +258,7 @@ interface DatabaseClusterBaseProps { * @see https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Integrating.LoadFromS3.html * * For PostgreSQL: + * This feature needs to be enabled when creating the DatabaseClusterEngine * @see https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Migrating.html * * @default - New role is created if `s3ImportBuckets` is set, no role is defined otherwise @@ -289,6 +290,7 @@ interface DatabaseClusterBaseProps { * @see https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Integrating.SaveIntoS3.html * * For PostgreSQL: + * This feature needs to be enabled when creating the DatabaseClusterEngine * @see https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/postgresql-s3-export.html * * @default - New role is created if `s3ExportBuckets` is set, no role is defined otherwise From f64d3d9bc90f139c9e83480166f6b668fefd16ac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Durand?= Date: Sat, 15 Jun 2024 22:17:13 +0200 Subject: [PATCH 3/7] Add details for enabling S3Import/S3Export --- packages/aws-cdk-lib/aws-rds/lib/cluster.ts | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/packages/aws-cdk-lib/aws-rds/lib/cluster.ts b/packages/aws-cdk-lib/aws-rds/lib/cluster.ts index ba04763f22fd6..e372930c4352d 100644 --- a/packages/aws-cdk-lib/aws-rds/lib/cluster.ts +++ b/packages/aws-cdk-lib/aws-rds/lib/cluster.ts @@ -253,12 +253,11 @@ interface DatabaseClusterBaseProps { * This feature is only supported by the Aurora database engine. * * This property must not be used if `s3ImportBuckets` is used. - * + * Note for PostgreSQL : This feature needs to be enabled when creating the DatabaseClusterEngine * For MySQL: * @see https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Integrating.LoadFromS3.html * * For PostgreSQL: - * This feature needs to be enabled when creating the DatabaseClusterEngine * @see https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Migrating.html * * @default - New role is created if `s3ImportBuckets` is set, no role is defined otherwise @@ -285,12 +284,11 @@ interface DatabaseClusterBaseProps { * This feature is only supported by the Aurora database engine. * * This property must not be used if `s3ExportBuckets` is used. - * + * Note for PostgreSQL : This feature needs to be enabled when creating the DatabaseClusterEngine * For MySQL: * @see https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Integrating.SaveIntoS3.html * * For PostgreSQL: - * This feature needs to be enabled when creating the DatabaseClusterEngine * @see https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/postgresql-s3-export.html * * @default - New role is created if `s3ExportBuckets` is set, no role is defined otherwise From 6b5bcf520370da543ae45f2f43174b2b8dc98645 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Durand?= Date: Wed, 3 Jul 2024 10:22:47 +0200 Subject: [PATCH 4/7] Update README.md fix typo s --- packages/aws-cdk-lib/aws-rds/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/aws-cdk-lib/aws-rds/README.md b/packages/aws-cdk-lib/aws-rds/README.md index 663cc55a65896..749ac9ebae1fe 100644 --- a/packages/aws-cdk-lib/aws-rds/README.md +++ b/packages/aws-cdk-lib/aws-rds/README.md @@ -938,7 +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. +Note that when using `s3ImportRole` and/or `s3ExportRole` with AuroraPostgres, you need to enable the respective feature when declaring the DatabaseClusterEngine. You can read more about loading data to (or from) S3 here: From b4e38b16b1c2f56d9d4cd4ba636f8b5776af4b29 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Durand?= Date: Wed, 10 Jul 2024 18:56:07 +0200 Subject: [PATCH 5/7] Update README.md --- packages/aws-cdk-lib/aws-rds/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/aws-cdk-lib/aws-rds/README.md b/packages/aws-cdk-lib/aws-rds/README.md index 749ac9ebae1fe..a99efd374d8b2 100644 --- a/packages/aws-cdk-lib/aws-rds/README.md +++ b/packages/aws-cdk-lib/aws-rds/README.md @@ -938,7 +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 respective feature when declaring the DatabaseClusterEngine. +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: From 179375bba571621c8b4a68ca54d32b31269c3b42 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Durand?= Date: Wed, 10 Jul 2024 18:57:15 +0200 Subject: [PATCH 6/7] Update cluster.ts --- packages/aws-cdk-lib/aws-rds/lib/cluster.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/aws-cdk-lib/aws-rds/lib/cluster.ts b/packages/aws-cdk-lib/aws-rds/lib/cluster.ts index e372930c4352d..515115663b828 100644 --- a/packages/aws-cdk-lib/aws-rds/lib/cluster.ts +++ b/packages/aws-cdk-lib/aws-rds/lib/cluster.ts @@ -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. - * Note for PostgreSQL : This feature needs to be enabled when creating the DatabaseClusterEngine + * 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 * @@ -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. - * Note for PostgreSQL : This feature needs to be enabled when creating the DatabaseClusterEngine + * 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 * From e883ecb29fa74480c0a19e3351acf3aa7a4a5e8c Mon Sep 17 00:00:00 2001 From: Parker Scanlon <69879391+scanlonp@users.noreply.github.com> Date: Wed, 17 Jul 2024 11:05:27 -0700 Subject: [PATCH 7/7] Update packages/aws-cdk-lib/aws-rds/README.md --- packages/aws-cdk-lib/aws-rds/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/aws-cdk-lib/aws-rds/README.md b/packages/aws-cdk-lib/aws-rds/README.md index a99efd374d8b2..58eed278f186d 100644 --- a/packages/aws-cdk-lib/aws-rds/README.md +++ b/packages/aws-cdk-lib/aws-rds/README.md @@ -938,7 +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. +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: