aws-rds: generate password/secret with SnapshotCredentials

[mostafafarzaneh]

Describe the issue

There are two methods in the aws-rds.SnapshotCredentials for generating password/secret for the snapshot:
1- fromGeneratedPassword 2- fromGeneratedSecret
What is the difference between these two methods? The documentation says the same thing about them.

Links

SnapshotCredentials.

[peterwoodworth]

Looks to me that the only difference is that fromGeneratedSecret() will set the replacePasswordOnCriteriaChange prop to true when DatabaseInstanceFromSnapshot and ServerlessClusterFromSnapshot create the DatabaseSecret. fromGeneratedPassword() will not set this prop at all, making it end up defaulting to false.

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

Lines 345 to 352 in 2edcbba

	public static fromGeneratedSecret(username: string, options: SnapshotCredentialsFromGeneratedPasswordOptions = {}): SnapshotCredentials {
	return {
	...options,
	generatePassword: true,
	replaceOnPasswordCriteriaChanges: true,
	username,
	};
	}

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

Lines 361 to 367 in 2edcbba

	public static fromGeneratedPassword(username: string, options: SnapshotCredentialsFromGeneratedPasswordOptions = {}): SnapshotCredentials {
	return {
	...options,
	generatePassword: true,
	username,
	};
	}

Would you be willing to help us clarify this in the documentation? Check out Contributing.md to get started. Let me know if you have any questions 🙂

[mostafafarzaneh]

Thanks for the clarification.
So, what is the point of using fromGeneratedPassword? What is the scenario someone may want to use it in?

It is worth mentioning, as I pointed out in #20434, the fromGeneratedSecret does not work.

Would you be willing to help us clarify this in the documentation?

I would love to contribute. I will reach out to you if need help

[jogold]

See the PR description here #11237 for a detailed explanation.

Switching from fromGeneratedPassword() to fromGeneratedSecret() for existing clusters/instances replaces the password (breaking). fromGeneratedPassword() was initially deprecated but then undeprecated in 797edbd (#17683).

[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.