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.

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

Conversation

ryparker
Copy link
Contributor

@ryparker ryparker commented Aug 25, 2021

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

@gitpod-io
Copy link

gitpod-io bot commented Aug 25, 2021

@ryparker ryparker changed the title fix(SSM API docs): Typo SecretString -> SecureString fix(SSM API docs): Typo SecretString -> SecureString and note how SecureStrings cannot be created via CDK Aug 25, 2021
@ryparker ryparker added pr-linter/exempt-test The PR linter will not require test changes docs/generated Related to the generated API Reference documentation labels Aug 25, 2021
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject89A8053A-LhjRyN9kxr8o
  • Commit ID: aa0910f
  • Result: FAILED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@mergify mergify bot merged commit 950e875 into master Sep 15, 2021
@mergify mergify bot deleted the fix-api-docs-secure-string branch September 15, 2021 18:52
@mergify
Copy link
Contributor

mergify bot commented Sep 15, 2021

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@peterwoodworth peterwoodworth changed the title fix(SSM API docs): Typo SecretString -> SecureString and note how SecureStrings cannot be created via CDK docs(ssm): Typo SecretString -> SecureString and note how SecureStrings cannot be created via CDK Sep 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs/generated Related to the generated API Reference documentation pr-linter/exempt-test The PR linter will not require test changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

SSM Overview references SecretString instead of SecureString Parameter Type
3 participants