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

Jump to bottom

SSM Overview references SecretString instead of SecureString Parameter Type #6039

Closed
stephendwu opened this issue Jan 31, 2020 · 3 comments · Fixed by #16228
Closed

SSM Overview references SecretString instead of SecureString Parameter Type #6039

stephendwu opened this issue Jan 31, 2020 · 3 comments · Fixed by #16228
Labels
@aws-cdk/aws-ssm Related to AWS Systems Manager docs/generated Related to the generated API Reference documentation effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p1

Comments

@stephendwu
Copy link
Contributor

https://docs.aws.amazon.com/cdk/api/latest/docs/aws-ssm-readme.html#creating-new-ssm-parameters-in-your-cdk-app

The sentence says:

Parameters of type SecretString cannot be created directly from a CDK application; if you want to provision secrets automatically, use Secrets Manager Secrets

This should say SecureString instead of SecretString.

Would it also be possible to mention that a SecureString cannot be created from a CDK application in the enum too? https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-ssm.ParameterType.html

This is a 📕 documentation issue
@stephendwu stephendwu added feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Jan 31, 2020
@SomayaB SomayaB added @aws-cdk/aws-ssm Related to AWS Systems Manager docs/generated Related to the generated API Reference documentation labels Feb 4, 2020
@MrArnoldPalmer
Copy link
Contributor

Makes sense to me!

@MrArnoldPalmer MrArnoldPalmer added p1 and removed needs-triage This issue or PR still needs to be triaged. labels Feb 4, 2020
@SomayaB SomayaB removed their assignment Feb 10, 2020
@MrArnoldPalmer MrArnoldPalmer added chore effort/small Small work item – less than a day of effort labels Feb 12, 2020
@SomayaB SomayaB removed the chore label Feb 19, 2020
@ThomasSteinbach
Copy link
Contributor

I ran exactly into this issue

1/9 | 4:58:34 AM | CREATE_FAILED        | AWS::SSM::Parameter | linux-security-group-id (linuxsecuritygroupidA2A6971D) SSM Parameters of type SecureString cannot be created using CloudFormation
	new StringParameter (/tmp/jsii-kernel-QyvDUV/node_modules/@aws-cdk/aws-ssm/lib/parameter.js:99:26)
	\_ /usr/local/lib/python3.7/site-packages/jsii/_embedded/jsii/jsii-runtime.js:7932:49
	\_ Kernel._wrapSandboxCode (/usr/local/lib/python3.7/site-packages/jsii/_embedded/jsii/jsii-runtime.js:8417:20)
	\_ Kernel._create (/usr/local/lib/python3.7/site-packages/jsii/_embedded/jsii/jsii-runtime.js:7932:26)
	\_ Kernel.create (/usr/local/lib/python3.7/site-packages/jsii/_embedded/jsii/jsii-runtime.js:7676:21)
	\_ KernelHost.processRequest (/usr/local/lib/python3.7/site-packages/jsii/_embedded/jsii/jsii-runtime.js:7456:28)
	\_ KernelHost.run (/usr/local/lib/python3.7/site-packages/jsii/_embedded/jsii/jsii-runtime.js:7394:14)
	\_ Immediate._onImmediate (/usr/local/lib/python3.7/site-packages/jsii/_embedded/jsii/jsii-runtime.js:7397:37)
	\_ processImmediate (internal/timers.js:439:21)

@MrArnoldPalmer MrArnoldPalmer removed their assignment Jun 21, 2021
@ryparker ryparker mentioned this issue Aug 25, 2021
Merged
@mergify mergify bot closed this as completed in #16228 Sep 15, 2021
mergify bot pushed a commit that referenced this issue Sep 15, 2021
@ryparker
fix(SSM API docs): Typo SecretString -> SecureString and note how…
950e875 
… SecureStrings cannot be created via CDK (#16228)

## Summary

This PR updates the API docs for aws-ssm. 
- Corrects a typo in the aws-ssm `SecretString` -> `SecureString`
- Adds a note to the `ParameterType.SecureString` enum that SecureStrings can not be created by a CDK app.

Fixes: #6039

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@github-actions
Copy link

⚠️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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
@aws-cdk/aws-ssm Related to AWS Systems Manager docs/generated Related to the generated API Reference documentation effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p1
Projects
None yet
Milestone
No milestone
4 participants
@ThomasSteinbach @MrArnoldPalmer @SomayaB @stephendwu