Skip to content

Commit 797edbd

Browse files
author
Niranjan Jayakar
authored
chore(rds): undeprecated APIs whose migration will cause interruption (aws#17683)
All deprecated APIs will be removed from CDKv2. Migrating from `SnapshotCredentials.fromGeneratedPassword()` to its documented alternative will modify the RDS instance in ways that may impact usability of the resource. This API must not be deprecated. The alternative APIs to the `DatabaseInstanceEngine` APIs refereced in this PR will cause the [CFN EngineVersion][1] to be modified. Modification of this property causes [some interruption][2] to the resource. This may cause "some interruption" to users' running applications. [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-engineversion [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent ddf2881 commit 797edbd

File tree

4 files changed

+10
-32
lines changed

4 files changed

+10
-32
lines changed

‎DEPRECATED_APIs.md

-10
Original file line numberDiff line numberDiff line change
@@ -600,20 +600,10 @@
600600
| @aws-cdk/aws-dynamodb | Table.​grantListStreams() | Use {@link #grantTableListStreams} for more granular permission |
601601
| @aws-cdk/aws-dynamodb | Table.​metricSystemErrors() | use `metricSystemErrorsForOperations`. |
602602
| @aws-cdk/aws-dynamodb | TableOptions.​serverSideEncryption | This property is deprecated. In order to obtain the same behavior as enabling this, set the `encryption` property to `TableEncryption.AWS_MANAGED` instead. |
603-
| @aws-cdk/aws-rds | Credentials.​fromUsername() | use `fromGeneratedSecret()` or `fromPassword()` for new Clusters and Instances. Note that switching from `fromUsername()` to `fromGeneratedSecret()` or `fromPassword()` for already deployed Clusters or Instances will result in their replacement! |
604603
| @aws-cdk/aws-rds | CredentialsFromUsernameOptions | supporting API `fromUsername()` has been deprecated. See deprecation notice of the API. |
605604
| @aws-cdk/aws-rds | CredentialsFromUsernameOptions.​password | supporting API `fromUsername()` has been deprecated. See deprecation notice of the API. |
606-
| @aws-cdk/aws-rds | DatabaseInstanceEngine.​MARIADB | using unversioned engines is an availability risk. We recommend using versioned engines created using the {@link mariaDb()} method |
607-
| @aws-cdk/aws-rds | DatabaseInstanceEngine.​MYSQL | using unversioned engines is an availability risk. We recommend using versioned engines created using the {@link mysql()} method |
608-
| @aws-cdk/aws-rds | DatabaseInstanceEngine.​ORACLE_​EE | using unversioned engines is an availability risk. We recommend using versioned engines created using the {@link oracleEe()} method |
609605
| @aws-cdk/aws-rds | DatabaseInstanceEngine.​ORACLE_​SE | instances can no longer be created with this engine. See https://forums.aws.amazon.com/ann.jspa?annID=7341 |
610606
| @aws-cdk/aws-rds | DatabaseInstanceEngine.​ORACLE_​SE1 | instances can no longer be created with this engine. See https://forums.aws.amazon.com/ann.jspa?annID=7341 |
611-
| @aws-cdk/aws-rds | DatabaseInstanceEngine.​ORACLE_​SE2 | using unversioned engines is an availability risk. We recommend using versioned engines created using the {@link oracleSe2()} method |
612-
| @aws-cdk/aws-rds | DatabaseInstanceEngine.​POSTGRES | using unversioned engines is an availability risk. We recommend using versioned engines created using the {@link postgres()} method |
613-
| @aws-cdk/aws-rds | DatabaseInstanceEngine.​SQL_​SERVER_​EE | using unversioned engines is an availability risk. We recommend using versioned engines created using the {@link sqlServerEe()} method |
614-
| @aws-cdk/aws-rds | DatabaseInstanceEngine.​SQL_​SERVER_​EX | using unversioned engines is an availability risk. We recommend using versioned engines created using the {@link sqlServerEx()} method |
615-
| @aws-cdk/aws-rds | DatabaseInstanceEngine.​SQL_​SERVER_​SE | using unversioned engines is an availability risk. We recommend using versioned engines created using the {@link sqlServerSe()} method |
616-
| @aws-cdk/aws-rds | DatabaseInstanceEngine.​SQL_​SERVER_​WEB | using unversioned engines is an availability risk. We recommend using versioned engines created using the {@link sqlServerWeb()} method |
617607
| @aws-cdk/aws-rds | DatabaseInstanceEngine.​oracleSe() | instances can no longer be created with this engine. See https://forums.aws.amazon.com/ann.jspa?annID=7341 |
618608
| @aws-cdk/aws-rds | DatabaseInstanceEngine.​oracleSe1() | instances can no longer be created with this engine. See https://forums.aws.amazon.com/ann.jspa?annID=7341 |
619609
| @aws-cdk/aws-rds | DatabaseInstanceNewProps.​vpcPlacement | use `vpcSubnets` |

‎deprecated_apis.txt

-10
Original file line numberDiff line numberDiff line change
@@ -599,17 +599,8 @@ constructs.Node#uniqueId
599599
@aws-cdk/aws-rds.Credentials#fromUsername
600600
@aws-cdk/aws-rds.CredentialsFromUsernameOptions
601601
@aws-cdk/aws-rds.CredentialsFromUsernameOptions#password
602-
@aws-cdk/aws-rds.DatabaseInstanceEngine#MARIADB
603-
@aws-cdk/aws-rds.DatabaseInstanceEngine#MYSQL
604-
@aws-cdk/aws-rds.DatabaseInstanceEngine#ORACLE_EE
605602
@aws-cdk/aws-rds.DatabaseInstanceEngine#ORACLE_SE
606603
@aws-cdk/aws-rds.DatabaseInstanceEngine#ORACLE_SE1
607-
@aws-cdk/aws-rds.DatabaseInstanceEngine#ORACLE_SE2
608-
@aws-cdk/aws-rds.DatabaseInstanceEngine#POSTGRES
609-
@aws-cdk/aws-rds.DatabaseInstanceEngine#SQL_SERVER_EE
610-
@aws-cdk/aws-rds.DatabaseInstanceEngine#SQL_SERVER_EX
611-
@aws-cdk/aws-rds.DatabaseInstanceEngine#SQL_SERVER_SE
612-
@aws-cdk/aws-rds.DatabaseInstanceEngine#SQL_SERVER_WEB
613604
@aws-cdk/aws-rds.DatabaseInstanceEngine#oracleSe
614605
@aws-cdk/aws-rds.DatabaseInstanceEngine#oracleSe1
615606
@aws-cdk/aws-rds.DatabaseInstanceNewProps#vpcPlacement
@@ -721,7 +712,6 @@ constructs.Node#uniqueId
721712
@aws-cdk/aws-rds.PostgresEngineVersion#VER_9_6_6
722713
@aws-cdk/aws-rds.PostgresEngineVersion#VER_9_6_8
723714
@aws-cdk/aws-rds.PostgresEngineVersion#VER_9_6_9
724-
@aws-cdk/aws-rds.SnapshotCredentials#fromGeneratedPassword
725715
@aws-cdk/aws-rds.SqlServerEngineVersion#VER_15_00_4043_23_V1
726716
@aws-cdk/aws-autoscaling.BlockDevice#mappingEnabled
727717
@aws-cdk/aws-autoscaling.CommonAutoScalingGroupProps#notificationsTopic

‎packages/@aws-cdk/aws-rds/lib/instance-engine.ts

+9-9
Original file line numberDiff line numberDiff line change
@@ -1572,31 +1572,31 @@ export class DatabaseInstanceEngine {
15721572
/**
15731573
* The unversioned 'mariadb' instance engine.
15741574
*
1575-
* @deprecated using unversioned engines is an availability risk.
1575+
* NOTE: using unversioned engines is an availability risk.
15761576
* We recommend using versioned engines created using the {@link mariaDb()} method
15771577
*/
15781578
public static readonly MARIADB: IInstanceEngine = new MariaDbInstanceEngine();
15791579

15801580
/**
15811581
* The unversioned 'mysql' instance engine.
15821582
*
1583-
* @deprecated using unversioned engines is an availability risk.
1583+
* NOTE: using unversioned engines is an availability risk.
15841584
* We recommend using versioned engines created using the {@link mysql()} method
15851585
*/
15861586
public static readonly MYSQL: IInstanceEngine = new MySqlInstanceEngine();
15871587

15881588
/**
15891589
* The unversioned 'oracle-ee' instance engine.
15901590
*
1591-
* @deprecated using unversioned engines is an availability risk.
1591+
* NOTE: using unversioned engines is an availability risk.
15921592
* We recommend using versioned engines created using the {@link oracleEe()} method
15931593
*/
15941594
public static readonly ORACLE_EE: IInstanceEngine = new OracleEeInstanceEngine();
15951595

15961596
/**
15971597
* The unversioned 'oracle-se2' instance engine.
15981598
*
1599-
* @deprecated using unversioned engines is an availability risk.
1599+
* NOTE: using unversioned engines is an availability risk.
16001600
* We recommend using versioned engines created using the {@link oracleSe2()} method
16011601
*/
16021602
public static readonly ORACLE_SE2: IInstanceEngine = new OracleSe2InstanceEngine();
@@ -1618,39 +1618,39 @@ export class DatabaseInstanceEngine {
16181618
/**
16191619
* The unversioned 'postgres' instance engine.
16201620
*
1621-
* @deprecated using unversioned engines is an availability risk.
1621+
* NOTE: using unversioned engines is an availability risk.
16221622
* We recommend using versioned engines created using the {@link postgres()} method
16231623
*/
16241624
public static readonly POSTGRES: IInstanceEngine = new PostgresInstanceEngine();
16251625

16261626
/**
16271627
* The unversioned 'sqlserver-ee' instance engine.
16281628
*
1629-
* @deprecated using unversioned engines is an availability risk.
1629+
* NOTE: using unversioned engines is an availability risk.
16301630
* We recommend using versioned engines created using the {@link sqlServerEe()} method
16311631
*/
16321632
public static readonly SQL_SERVER_EE: IInstanceEngine = new SqlServerEeInstanceEngine();
16331633

16341634
/**
16351635
* The unversioned 'sqlserver-se' instance engine.
16361636
*
1637-
* @deprecated using unversioned engines is an availability risk.
1637+
* NOTE: using unversioned engines is an availability risk.
16381638
* We recommend using versioned engines created using the {@link sqlServerSe()} method
16391639
*/
16401640
public static readonly SQL_SERVER_SE: IInstanceEngine = new SqlServerSeInstanceEngine();
16411641

16421642
/**
16431643
* The unversioned 'sqlserver-ex' instance engine.
16441644
*
1645-
* @deprecated using unversioned engines is an availability risk.
1645+
* NOTE: using unversioned engines is an availability risk.
16461646
* We recommend using versioned engines created using the {@link sqlServerEx()} method
16471647
*/
16481648
public static readonly SQL_SERVER_EX: IInstanceEngine = new SqlServerExInstanceEngine();
16491649

16501650
/**
16511651
* The unversioned 'sqlserver-web' instance engine.
16521652
*
1653-
* @deprecated using unversioned engines is an availability risk.
1653+
* NOTE: using unversioned engines is an availability risk.
16541654
* We recommend using versioned engines created using the {@link sqlServerWeb()} method
16551655
*/
16561656
public static readonly SQL_SERVER_WEB: IInstanceEngine = new SqlServerWebInstanceEngine();

‎packages/@aws-cdk/aws-rds/lib/props.ts

+1-3
Original file line numberDiff line numberDiff line change
@@ -346,9 +346,7 @@ export abstract class SnapshotCredentials {
346346
*
347347
* Note - The username must match the existing master username of the snapshot.
348348
*
349-
* @deprecated use `fromGeneratedSecret()` for new Clusters and Instances.
350-
* Note that switching from `fromGeneratedPassword()` to `fromGeneratedSecret()` for already deployed
351-
* Clusters or Instances will update their master password.
349+
* NOTE: use `fromGeneratedSecret()` for new Clusters and Instances.
352350
*/
353351
public static fromGeneratedPassword(username: string, options: SnapshotCredentialsFromGeneratedPasswordOptions = {}): SnapshotCredentials {
354352
return {

0 commit comments

Comments
 (0)