Update README with 'tagging' metadata key description #138
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
zhaomicx
approved these changes
Sep 19, 2022
aygold92
reviewed
Sep 19, 2022
README.md
Outdated
Comment on lines
42
to
44
| * `tagOnCreate`: A boolean flag indicating whether this resource type supports tagging resources upon creation. | ||
| * `tagUpdatable`: A boolean flag indicating whether this resource type supports updatable tagging. | ||
| * `cloudFormationSystemTags`: A boolean flag indicating whether this resource type supports CloudFormation system tags. |
There was a problem hiding this comment.
we may want to explain these a little bit more. I'll let you give a shot at phrasing this for these doc purposes, but here is what I think is missing:
Q: What do we mean by tagging resources on creation?
A: You can pass the tags into the create API, allowing for enforcement of tags based access control
Q: What is "updatable tagging"?
A: You can modify the tags using the update handler. Now that I'm thinking about this, this property is unnecessary. We can just check if the tagProperty is in createOnlyProperties
Q: What does "supports CloudFormation System Tags" mean?
A: The create handler will apply aws prefixed tags as described here
ammokhov
approved these changes
Sep 20, 2022
marcuram
force-pushed
the
tagging-description
branch
from
00e9f79 to
1a69155
Compare
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.
Description of changes: Update
READMEwithtaggingmetadata key description and examplesBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.