From 20d0141a2964968e8521ee3ffa71e6578b7cf176 Mon Sep 17 00:00:00 2001 From: Ryan Parker Date: Wed, 25 Aug 2021 13:01:16 -0700 Subject: [PATCH 1/2] fix(api docs)SecretString -> SecureString --- packages/@aws-cdk/aws-ssm/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/@aws-cdk/aws-ssm/README.md b/packages/@aws-cdk/aws-ssm/README.md index 2a47ba47c2529..54e7acab8cec0 100644 --- a/packages/@aws-cdk/aws-ssm/README.md +++ b/packages/@aws-cdk/aws-ssm/README.md @@ -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). From 22d4e9976c8f52a98654a12dfe7c0986d769cbff Mon Sep 17 00:00:00 2001 From: Ryan Parker Date: Wed, 25 Aug 2021 13:15:55 -0700 Subject: [PATCH 2/2] feat(SSM API docs): Added a note that SecureString parameters cannot be created via CDK. --- packages/@aws-cdk/aws-ssm/lib/parameter.ts | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/@aws-cdk/aws-ssm/lib/parameter.ts b/packages/@aws-cdk/aws-ssm/lib/parameter.ts index df30c8197cf91..a33759d7cf014 100644 --- a/packages/@aws-cdk/aws-ssm/lib/parameter.ts +++ b/packages/@aws-cdk/aws-ssm/lib/parameter.ts @@ -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', /**