refactor: introduce SecretValue to represent secrets #2161
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The class `cdk.SecretValue` is a token that represents a value that should be treated as a secret. It can be created through one of the factory methods: `SecretValue.secretsManager(id)` or `SecretValue.plainText(text)`. Constructs that reference secrets have been converted to use this type instead of plain strings. The `secretsmanager.Secret` construct now has `secretValue` and `secretJsonValue` which return `SecretValue` objects with a dynamic reference. The `DynamicReference` class is now a `Token`. BREAKING CHANGE: The `secretsmanager.SecretString` class has been removed in favor of `cdk.SecretValue.secretsManager(id[, options])` The following prop types have been changed from `string` to `cdk.SecretValue`: `codepipeline-actions.AlexaSkillDeployAction.clientSecret`, `codepipeline-actions.AlexaSkillDeployAction.refreshToken`, `codepipeline-actions.GitHubSourceAction.oauthToken`, `iam.User.password` `secretsmanager.Secret.stringValue` and `jsonFieldValue` have been removed. Use `secretsmanage.Secret.secretValue` and `secretJsonValue` instead. `secretsmanager.Secret.secretString` have been removed. Use `cdk.SecretValue.secretsManager()` or `secretsmanager.Secret.import(..).secretValue`. The class `cdk.Secret` has been removed. Use `cdk.SecretValue` instead. The class `cdk.DynamicReference` is no longer a construct, and it's constructor signature was changed.
rix0rrr
reviewed
Apr 2, 2019
| * @param secretId The ID or ARN of the secret | ||
| * @param options Options | ||
| */ | ||
| public static secretsManager(secretId: string, options: SecretsManagerSecretOptions = { }): SecretValue { |
There was a problem hiding this comment.
If you're going to go the way of adding constructor functions here, then you should also add one for SSMPS.
There was a problem hiding this comment.
And it should kinda/sorta also be possible to use a NoEcho CfnParameter.
We shouldn't encourage it but it is something people can do today, and SecretsManager does cost money per secret per month.
There was a problem hiding this comment.
Yap adding that too. Enforcing NoEcho is a nice touch.
|
Hey @eladb, shouldn't this also be converted? |
added 2 commits
April 3, 2019 12:29
* add `SecretValue.ssmSecure`. * add `SecretValue.cfnDynamicReference` * add `SecretValue.cfnParameter` BREAKING CHANGE: cdk.DynamicReference renamed to cdk.CfnDynamicReference.
rix0rrr
approved these changes
Apr 3, 2019
eladb
pushed a commit
that referenced
this pull request
Apr 4, 2019
The class `cdk.SecretValue` is a token that represents a value that should be treated as a secret. It can be created through one of the factory methods: `SecretValue.secretsManager(id)` or `SecretValue.plainText(text)`. Constructs that reference secrets have been converted to use this type instead of plain strings. The `secretsmanager.Secret` construct now has `secretValue` and `secretJsonValue` which return `SecretValue` objects with a dynamic reference. The `DynamicReference` class is now a `Token`. BREAKING CHANGE: The `secretsmanager.SecretString` class has been removed in favor of `cdk.SecretValue.secretsManager(id[, options])` The following prop types have been changed from `string` to `cdk.SecretValue`: `codepipeline-actions.AlexaSkillDeployAction.clientSecret`, `codepipeline-actions.AlexaSkillDeployAction.refreshToken`, `codepipeline-actions.GitHubSourceAction.oauthToken`, `iam.User.password` `secretsmanager.Secret.stringValue` and `jsonFieldValue` have been removed. Use `secretsmanage.Secret.secretValue` and `secretJsonValue` instead. `secretsmanager.Secret.secretString` have been removed. Use `cdk.SecretValue.secretsManager()` or `secretsmanager.Secret.import(..).secretValue`. The class `cdk.Secret` has been removed. Use `cdk.SecretValue` instead. The class `cdk.DynamicReference` is no longer a construct, and it's constructor signature was changed and was renamed `cdk.CfnDynamicReference`.
|
Thanks so much for taking the time to contribute to the AWS CDK ❤️ We will shortly assign someone to review this pull request and help get it
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The class
cdk.SecretValueis a token that represents a value that shouldbe treated as a secret. It can be created through one of the factory methods:
SecretValue.secretsManager(id)orSecretValue.plainText(text).Constructs that reference secrets have been converted to use this type
instead of plain strings.
The
secretsmanager.Secretconstruct now hassecretValueandsecretJsonValuewhich returnSecretValueobjects with a dynamic reference.The
DynamicReferenceclass is now aToken.BREAKING CHANGE: The
secretsmanager.SecretStringclass has been removed in favor ofcdk.SecretValue.secretsManager(id[, options])The following prop types have been changed from
stringtocdk.SecretValue:codepipeline-actions.AlexaSkillDeployAction.clientSecret,codepipeline-actions.AlexaSkillDeployAction.refreshToken,codepipeline-actions.GitHubSourceAction.oauthToken,iam.User.passwordsecretsmanager.Secret.stringValueandjsonFieldValuehave been removed. Usesecretsmanage.Secret.secretValueandsecretJsonValueinstead.secretsmanager.Secret.secretStringhave been removed. Usecdk.SecretValue.secretsManager()orsecretsmanager.Secret.import(..).secretValue.The class
cdk.Secrethas been removed. Usecdk.SecretValueinstead.The class
cdk.DynamicReferenceis no longer a construct, and it'sconstructor signature was changed.
Pull Request Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.