docs(core): document special construct IDs - #38698
Open
ZedingZhang wants to merge 1 commit into
Open
Conversation
This file contains hidden or 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
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.
Issue # (if applicable)
Closes #21410.
Reason for this change
The special treatment of construct IDs named
DefaultandResourceduring CloudFormation logical ID generation was only documented in the implementation. Users could unintentionally change logical IDs or produce duplicate logical IDs without knowing that these names have special behavior.Description of changes
Adds a new section to the
aws-cdk-libREADME that documents:Defaultis removed entirely from logical ID calculation, including the hash.Resourceis omitted from the human-readable portion of nested resource logical IDs while remaining part of the hash.This is a documentation-only change and does not modify logical ID behavior.
Describe any new or updated permissions being added
None.
Description of how you validated changes
git diff --check.packages/aws-cdk-lib/README.mdusing the repository's MarkdownLint configuration.core/lib/private/uniqueid.tsand the existing logical ID tests.A full build was not run because the change only adds prose and a Markdown table, with no code or Rosetta examples.
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license