What does the next major release mean?

[yukinakanaka]

Context

CDK Version: 2.83.0

$ cdk --version
2.83.0 (build 0fd7f2b)

$ pip list | grep aws-cdk-lib
aws-cdk-lib                                    2.83.0

WARNING messages

When cdk ls was executed, the following WARNING messages were displayed.

$ cdk ls
[WARNING] aws-cdk-lib.aws_rds.DatabaseClusterProps#instanceProps is deprecated.
  - use writer and readers instead
  This API will be removed in the next major release.
[WARNING] aws-cdk-lib.aws_rds.DatabaseClusterProps#instances is deprecated.
  - use writer and readers instead
  This API will be removed in the next major release.
.
.
.

Database recreation is needed to fix WARNING

When we changed the Python code to fix Waring, it turned out that the database needed to be recreated. So, we stopped to change our Python code. If possible, we wouldn't like to recreate database because we need to stop our service(product).

Question

What does the next major release mean? The CDK document says that it uses Semantic versioning, so is the next major version V3(3.x.x)?. If so, is there any schedule to release it?

[codyebberson]

Hi @yukinakanaka - did you try the isFromLegacyInstanceProps flag described here: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_rds-readme.html#migrating-from-instanceprops

We were able to use it, and update without recreating the database. See PR here: medplum/medplum#2211

[yukinakanaka]

@codyebberson Thanks a lot. You're PR is very helpful to me.
BTW, If you know the meaning of next major release, could you please let me know?

[codyebberson]

I assume that it means a change to the "major" version number in semver (major.minor.patch), so when CDK goes from v2 to v3. That's just my interpretation though.

[yukinakanaka]

I am relieved that my interpretation is the same as yours. Thank you.

[peterwoodworth]

so is the next major version V3(3.x.x)?

Yes!

If so, is there any schedule to release it?

A v3 is not currently on our radar 🙂

[yukinakanaka]

@peterwoodworth
Thank you for your reply! I understood!

[TimQuist]

Hi @yukinakanaka - did you try the isFromLegacyInstanceProps flag described here: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_rds-readme.html#migrating-from-instanceprops

We were able to use it, and update without recreating the database. See PR here: medplum/medplum#2211

This doesn't seem to do it for me. I specified the parameter to true, yet still when I run a diff against current account it will tell me:

Resources
[~] AWS::RDS::DBInstance rds-cluster/Instance1 rdsclusterInstance replace
 └─ [-] DBInstanceIdentifier (requires replacement)
     └─ rds-clusterinstance1
[~] AWS::RDS::DBInstance rds-cluster/Instance2 rdsclusterInstance replace
 └─ [-] DBInstanceIdentifier (requires replacement)
     └─ rds-clusterinstance2

Any help would be greatly appreciated.

Old CDK code:

    private buildRdsCluster(): DatabaseCluster {
        const rdsCluster = new DatabaseCluster(
            this,
            RdsUtils.RDS_CLUSTER,
            {
                clusterIdentifier: RdsUtils.RDS_CLUSTER,
                engine: DatabaseClusterEngine.auroraPostgres(
                    {
                        version: AuroraPostgresEngineVersion.VER_14_6,
                    }
                ),
                port: RdsUtils.RDS_PORT,
                credentials: Credentials.fromSecret(this.rdsPostgresSecret),
                storageEncrypted: true,
                instanceProps: {
                    instanceType: InstanceType.of(InstanceClass.T3, InstanceSize.MEDIUM),
                    vpcSubnets: {
                        subnetType: SubnetType.PRIVATE_ISOLATED,
                    },
                    vpc: this.vpc,
                    securityGroups: [
                        this.rdsSecurityGroup,
                    ],
                },
                backup: {
                    preferredWindow: '00:00-01:00',
                    retention: Duration.days(
                        this.props.isProduction ? 30 : 7
                    ),
                },
                preferredMaintenanceWindow: 'Wed:01:00-Wed:02:00',
                removalPolicy: RemovalPolicy.RETAIN,
            }
        );
        new CfnOutput(
            this,
            `${RdsUtils.RDS_CLUSTER_ENDPOINT}-output`,
            {
                exportName: RdsUtils.getRdsClusterEndpointExportName(),
                description: 'The RDS cluster endpoint',
                value: `${rdsCluster.clusterEndpoint.socketAddress}`,
            }
        );
        return rdsCluster;
    }

New CDK code:

 private buildRdsCluster(): DatabaseCluster {
    const instanceProps: ProvisionedClusterInstanceProps = {
      instanceType: InstanceType.of(InstanceClass.T3, InstanceSize.MEDIUM),
      isFromLegacyInstanceProps: true,
    };

    const rdsCluster = new DatabaseCluster(this, RdsUtils.RDS_CLUSTER, {
      vpc: this.vpc,
      securityGroups: [this.rdsSecurityGroup],
      vpcSubnets: { subnetType: SubnetType.PRIVATE_ISOLATED },
      clusterIdentifier: RdsUtils.RDS_CLUSTER,
      engine: DatabaseClusterEngine.auroraPostgres({
        version: AuroraPostgresEngineVersion.VER_14_6,
      }),
      port: RdsUtils.RDS_PORT,
      credentials: Credentials.fromSecret(this.rdsPostgresSecret),
      storageEncrypted: true,
      writer: ClusterInstance.provisioned("Instance1", instanceProps),
      readers: [ClusterInstance.provisioned("Instance2", instanceProps)],
      backup: {
        preferredWindow: "00:00-01:00",
        retention: Duration.days(this.props.isProduction ? 30 : 7),
      },
      preferredMaintenanceWindow: "Wed:01:00-Wed:02:00",
      removalPolicy: RemovalPolicy.RETAIN,
    });
    new CfnOutput(this, `${RdsUtils.RDS_CLUSTER_ENDPOINT}-output`, {
      exportName: RdsUtils.getRdsClusterEndpointExportName(),
      description: "The RDS cluster endpoint",
      value: `${rdsCluster.clusterEndpoint.socketAddress}`,
    });
    return rdsCluster;
  }

[github-actions[bot]]

Hello! Reopening this discussion to make it searchable.