Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(ssm): Typo SecretString -> SecureString and note how SecureStrings cannot be created via CDK #16228

Merged
merged 4 commits into from
Sep 15, 2021
Merged

docs(ssm): Typo SecretString -> SecureString and note how SecureStrings cannot be created via CDK #16228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
20d0141
fix(api docs)SecretString -> SecureString
ryparker Aug 25, 2021
22d4e99
feat(SSM API docs): Added a note that SecureString parameters cannot …
ryparker Aug 25, 2021
1acc45f
Merge branch 'master' into fix-api-docs-secure-string
ryparker Sep 11, 2021
aa0910f
Merge branch 'master' into fix-api-docs-secure-string
ryparker Sep 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-ssm/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ your CDK app by using `ssm.ParameterStoreString`:

You can create either `ssm.StringParameter` or `ssm.StringListParameter`s in
a CDK app. These are public (not secret) values. Parameters of type
*SecretString* cannot be created directly from a CDK application; if you want
*SecureString* cannot be created directly from a CDK application; if you want
to provision secrets automatically, use Secrets Manager Secrets (see the
`@aws-cdk/aws-secretsmanager` package).

Expand Down
2 changes: 2 additions & 0 deletions packages/@aws-cdk/aws-ssm/lib/parameter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,9 @@ export enum ParameterType {
STRING = 'String',
/**
* Secure String
*
* Parameter Store uses an AWS Key Management Service (KMS) customer master key (CMK) to encrypt the parameter value.
* Parameters of type SecureString cannot be created directly from a CDK application.
*/
SECURE_STRING = 'SecureString',
/**
Expand Down