Documentation uses deprecated SecretStringValueBeta1

[kbakk]

Describe the issue

Example shown in https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.AccessKey.html:

// Creates a new IAM user, access and secret keys, and stores the secret access key in a Secret.
const user = new iam.User(this, 'User');
const accessKey = new iam.AccessKey(this, 'AccessKey', { user });
const secretValue = secretsmanager.SecretStringValueBeta1.fromToken(accessKey.secretAccessKey.toString());
new secretsmanager.Secret(this, 'Secret', {
   secretStringBeta1: secretValue,
});

This will raise a deprecation warning, as #19543 deprecated the SecretStringValueBeta1 method.

(Side-note: I'm curious on how to solve this properly using cdk.SecretValue.)

Links

• https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.AccessKey.html

[laurelmay]

Some sample code on using this with the new API would be:

    const user = new iam.User(this, "User");
    const accessKey = new iam.AccessKey(this, "AccessKey", { user });
    const secret = new secrets.Secret(this, "Secret", {
      secretStringValue: accessKey.secretAccessKey,
    });

Not sure exactly how the "Example" gets generated (that code snippet seems to come from the aws-secretsmanager package, not aws-iam), otherwise I'd open a PR to fix.

There isn't a need to construct a cdk.SecretValue yourself in this case as secretAccessKey is already a SecretValue.

[kbakk]

Thanks!

There isn't a need to construct a cdk.SecretValue yourself in this case as secretAccessKey is already a SecretValue.

This gotcha was what I struggled with. 🙂

[skinny85]

Thanks for opening the issue @kbakk. I guess we need to fix the example code here:

aws-cdk/packages/@aws-cdk/aws-secretsmanager/lib/secret.ts

Line 234 in 7fd542c

* const secretValue = secretsmanager.SecretStringValueBeta1.fromToken(accessKey.secretAccessKey.toString());

[triqp]

Looking at making my first contribution. Is @kylelaker recommended code change appropriate?

[skinny85]

@triqp yes, it is 🙂.

Check out the "Contributing" guide: https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.