docs(cloudformation-module): Improve Docs #1090
Merged
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
scottgerring
previously approved these changes
Mar 16, 2023
docs/utilities/custom_resources.md
Outdated
| ### Configuring Response Objects | ||
| In both of the scenarios, powertools-java will assign the `physicalResourceId` based on the following logic: | ||
| - if present, use the `physicalResourceId` provided in the `CloudFormationCustomResourceEvent` | ||
| - if it is not present, use the `LogStreamName` from the Lambda context |
There was a problem hiding this comment.
I think we could be more explicit here. The physicalResourceId will only be missing for CREATE - "For CREATE operations, the logStreamName will be used. For UPDATE and DELETE, the physicalResourceId previously given by the custom resource to CloudFormation will be provided, back to the handler.", or something
There was a problem hiding this comment.
Agreed, it would be easier to understand this way, I will update the verbiage
improvements from PR Co-authored-by: Scott Gerring <scottgerring@users.noreply.github.com>
improvements from PR Co-authored-by: Scott Gerring <scottgerring@users.noreply.github.com>
improvements from PR Co-authored-by: Scott Gerring <scottgerring@users.noreply.github.com>
improvements from PR Co-authored-by: Scott Gerring <scottgerring@users.noreply.github.com>
PR Feedback Co-authored-by: Scott Gerring <scottgerring@users.noreply.github.com>
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 available: #1081
Description of changes:
Improving the Cloudformation custom resources documentation, including the new APIs introduced as part of this PR #1082
Checklist
Breaking change checklist
RFC issue #:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.