fix: ensure all generated logical ids conform to CloudFormation standard #396
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
akash1810
approved these changes
Apr 8, 2021
| @@ -15,7 +15,9 @@ export interface Identity extends StackStageIdentity, AppIdentity {} | |||
| export const AppIdentity = { | |||
| suffixText(appIdentity: AppIdentity, text: string): string { | |||
| const titleCaseApp = appIdentity.app.charAt(0).toUpperCase() + appIdentity.app.slice(1); | |||
| return `${text}${titleCaseApp}`; | |||
| // CloudFormation Logical Ids must be alphanumeric, so remove any non-alphanumeric characters: https://stackoverflow.com/a/20864946 | |||
| const alphanumericTitleCaseApp = titleCaseApp.replace(/[\W_]+/g, ""); | |||
There was a problem hiding this comment.
Lovely! This is a lot cleaner than my ascii code array idea!
|
🎉 This PR is included in version 7.1.2 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
What does this change?
This PR ensures that the logical ids generated by this library always conform to AWS's standard:
Does this change require changes to existing projects or CDK CLI?
No.
How to test
Existing unit tests have been updated due to this change.
How can we measure success?
Previously, it was impossible to CloudForm the resources created by the
GuInstanceRoleconstruct if yourAppIdentityincluded non-alphanumeric characters (e.g. when usingtest-app). After this change, users will be able to include hyphens (or other non-alphanumeric characters if they really must?!) in their app names.Have we considered potential risks?
I can't think of any risks which would result from making this change.