aws_rds: (regression) Deprecation warning when using rds.DatabaseCluster

[vsabella]

Describe the bug

since 2.245, there is now a regression when using the basic tutorial for new rds.DatabaseCluster(this, 'Cluster', {}...

toCloudFormation is enumerating over deprecated properties, causing a warning every time we synth.

While synthesizing MyStage/Database/Aurora/Cluster/writer/Resource: aws-cdk-lib.aws_rds.CfnDBInstance#tdeCredentialArn is deprecated.
  this property has been deprecated
  This API will be removed in the next major release.
  --- resource created at ---
  --- problem discovered at ---
    at get cfnProperties (/Users/myuser/dev-ghec/axsp-aws/node_modules/.pnpm/aws-cdk-lib@2.245.0_constructs@10.6.0/node_modules/aws-cdk-lib/aws-rds/lib/rds.generated.js:1:109101)
    at CfnDBInstance._toCloudFormation (/Users/myuser/dev-ghec/axsp-aws/node_modules/.pnpm/aws-cdk-lib@2.245.0_constructs@10.6.0/node_modules/aws-cdk-lib/core/lib/cfn-resource.js:1:7641)
    at /Users/myuser/dev-ghec/axsp-aws/node_modules/.pnpm/aws-cdk-lib@2.245.0_constructs@10.6.0/node_modules/aws-cdk-lib/core/lib/private/refs.js:1:5150
    at findTokens (/Users/myuser/dev-ghec/axsp-aws/node_modules/.pnpm/aws-cdk-lib@2.245.0_constructs@10.6.0/node_modules/aws-cdk-lib/core/lib/private/resolve.js:1:4214)
    at findAllReferences (/Users/myuser/dev-ghec/axsp-aws/node_modules/.pnpm/aws-cdk-lib@2.245.0_constructs@10.6.0/node_modules/aws-cdk-lib/core/lib/private/refs.js:1:5127)
    at resolveReferences (/Users/myuser/dev-ghec/axsp-aws/node_modules/.pnpm/aws-cdk-lib@2.245.0_constructs@10.6.0/node_modules/aws-cdk-lib/core/lib/private/refs.js:1:1666)
    at prepareApp (/Users/myuser/dev-ghec/axsp-aws/node_modules/.pnpm/aws-cdk-lib@2.245.0_constructs@10.6.0/node_modules/aws-cdk-lib/core/lib/private/prepare-app.js:1:928)
    at synthesize (/Users/myuser/dev-ghec/axsp-aws/node_modules/.pnpm/aws-cdk-lib@2.245.0_constructs@10.6.0/node_modules/aws-cdk-lib/core/lib/private/synthesis.js:1:1997)
    at AppsStage.synth (/Users/myuser/dev-ghec/axsp-aws/node_modules/.pnpm/aws-cdk-lib@2.245.0_constructs@10.6.0/node_modules/aws-cdk-lib/core/lib/stage.js:1:3157)
    at synthNestedAssemblies (/Users/myuser/dev-ghec/axsp-aws/node_modules/.pnpm/aws-cdk-lib@2.245.0_constructs@10.6.0/node_modules/aws-cdk-lib/core/lib/private/synthesis.js:2:2083) {
  name: 'DeprecationError'

Regression Issue

• Select this option if this issue appears to be a regression.

Last Known Working CDK Library Version

No response

Expected Behavior

It should not throw warnings

Current Behavior

While synthesizing MyStage/Database/Aurora/Cluster/writer/Resource: aws-cdk-lib.aws_rds.CfnDBInstance#tdeCredentialArn is deprecated.
  this property has been deprecated
  This API will be removed in the next major release.
  --- resource created at ---
  --- problem discovered at ---
    at get cfnProperties (/Users/myuser/dev-ghec/axsp-aws/node_modules/.pnpm/aws-cdk-lib@2.245.0_constructs@10.6.0/node_modules/aws-cdk-lib/aws-rds/lib/rds.generated.js:1:109101)
    at CfnDBInstance._toCloudFormation (/Users/myuser/dev-ghec/axsp-aws/node_modules/.pnpm/aws-cdk-lib@2.245.0_constructs@10.6.0/node_modules/aws-cdk-lib/core/lib/cfn-resource.js:1:7641)
    at /Users/myuser/dev-ghec/axsp-aws/node_modules/.pnpm/aws-cdk-lib@2.245.0_constructs@10.6.0/node_modules/aws-cdk-lib/core/lib/private/refs.js:1:5150
    at findTokens (/Users/myuser/dev-ghec/axsp-aws/node_modules/.pnpm/aws-cdk-lib@2.245.0_constructs@10.6.0/node_modules/aws-cdk-lib/core/lib/private/resolve.js:1:4214)
    at findAllReferences (/Users/myuser/dev-ghec/axsp-aws/node_modules/.pnpm/aws-cdk-lib@2.245.0_constructs@10.6.0/node_modules/aws-cdk-lib/core/lib/private/refs.js:1:5127)
    at resolveReferences (/Users/myuser/dev-ghec/axsp-aws/node_modules/.pnpm/aws-cdk-lib@2.245.0_constructs@10.6.0/node_modules/aws-cdk-lib/core/lib/private/refs.js:1:1666)
    at prepareApp (/Users/myuser/dev-ghec/axsp-aws/node_modules/.pnpm/aws-cdk-lib@2.245.0_constructs@10.6.0/node_modules/aws-cdk-lib/core/lib/private/prepare-app.js:1:928)
    at synthesize (/Users/myuser/dev-ghec/axsp-aws/node_modules/.pnpm/aws-cdk-lib@2.245.0_constructs@10.6.0/node_modules/aws-cdk-lib/core/lib/private/synthesis.js:1:1997)
    at AppsStage.synth (/Users/myuser/dev-ghec/axsp-aws/node_modules/.pnpm/aws-cdk-lib@2.245.0_constructs@10.6.0/node_modules/aws-cdk-lib/core/lib/stage.js:1:3157)
    at synthNestedAssemblies (/Users/myuser/dev-ghec/axsp-aws/node_modules/.pnpm/aws-cdk-lib@2.245.0_constructs@10.6.0/node_modules/aws-cdk-lib/core/lib/private/synthesis.js:2:2083) {
  name: 'DeprecationError'

Reproduction Steps

Create an RDS serverless construct just following basic tutorials:
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_rds-readme.html

Possible Solution

No response

Additional Information/Context

No response

AWS CDK Library version (aws-cdk-lib)

aws-cdk-lib@2.245.0

AWS CDK CLI version

2.1114.1 (build 9fa6132)

Node.js Version

v24.13.1

OS

Darwin (MacOS)

Language

TypeScript

Language Version

No response

Other information

No response

[9pace]

The regression will be reversed in the next release.

The root cause of this issue is as follows:

1. spec2cdk now generates getter and setter for mutable properties as of 37285

This generates code for L1s with deprecated properties like rds.generated.ts:

  /**
   * @deprecated this property has been deprecated
   */
  get tdeCredentialArn(): string | undefined {
    return this._tdeCredentialArn;
  }

2. When JSII it finds a getter for a property that has @deprecated in its JSDoc, it inserts a print() call at the top of the getter body, which will throw when the env var $JSII_DEPRECATED is set to fail, or it will print a [WARNING].
   See permalink.

For our example, rds.generated.ts compiles to rds.generated.js:

/**
     * @deprecated this property has been deprecated
     */
    get tdeCredentialArn() {
        try {
            jsiiDeprecationWarnings().print("aws-cdk-lib.aws_rds.CfnDBInstance#tdeCredentialArn", "this property has been deprecated");
        }
        catch (error) {
            if (process.env.JSII_DEBUG !== "1" && error.name === "DeprecationError") {
                Error.captureStackTrace(error, jsiiDeprecationWarnings().getPropertyDescriptor(this, "tdeCredentialArn").get);
            }
            throw error;
        }
        return this._tdeCredentialArn;
    }

Before this change, the deprecated property only threw the error (or printed the warning) if the property was set. This is because the check would be injected into the constructor of the CfnResource. For example in the constructor of CfnDBInstance in rds.generated.js:

    constructor(scope, id, props = {}) {
        super(scope, id, {
            "type": CfnDBInstance.CFN_RESOURCE_TYPE_NAME,
            "properties": props
        });
        try {
            jsiiDeprecationWarnings().aws_cdk_lib_aws_rds_CfnDBInstanceProps(props);
        }

The function called looks like:

function aws_cdk_lib_aws_rds_CfnDBInstanceProps(p) {
 ...
    try {
 ...
        if ("tdeCredentialArn" in p)
            print("aws-cdk-lib.aws_rds.CfnDBInstanceProps#tdeCredentialArn", "this property has been deprecated");

After the change the injected print function is now in the getter, which will cause a warning or an error even when the property is not set because:

3. On cdk synth, get cfnProperties is called in _toCloudFormation, which attempts to access the deprecated property (ex: this.tdeCredentialArn). If $JSII_DEPRECATED is set, it throws the error you saw.

[github-actions]

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.