refactor(core): use "string" for physical name props #3011
Merged
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.
We realized there is no need to use a strong type (
PhysicalName
) for resource physical names. Eventually users want to be able to either use the default, pass an explicit string for the name or request that the framework generate a name for them, conditionally (or, in the future, unconditionally) to whether the resource is being referenced across environments.To that end, all physical name props have been converted back to
string
and a special token markerPhysicalName.GENERATE_IF_NEEDED
was introduced which can be used to indicate that physical name will be generated if needed for cross environment references.This change also modifies the protected API provided the
Resource
class:physicalName
returns the value that should be passed to the CFN resourcegetResourceNameAttribute(nameAttr)
returns a token that should be exposed as the resource name (e.g.bucketName
).getResourceArnAttribute(arnAttr, components)
returns a token that should bexposed as the resource's ARN (e.g.bucketArn
).All of these are "environment-sensitive" and will return "the right" value, depending on the resource's poster and configuration.
Please read the contribution guidelines and follow the pull-request checklist.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license