Fix DestinationConfig in streaming event sources #2215
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
marekaiv
reviewed
Nov 9, 2021
| @@ -110,6 +110,9 @@ def to_cloudformation(self, **kwargs): | |||
|
|
|||
| destination_config_policy = None | |||
| if self.DestinationConfig: | |||
| if self.DestinationConfig.get("OnFailure") is None: | |||
| raise InvalidEventException(self.logical_id, "'OnFailure' is a required field for 'DestinationConfig'") | |||
There was a problem hiding this comment.
The docs for DestinationConfig show that OnFailure is not a required field. I'm not sure why someone would create DestinationConfig without its only possible field so I think the docs are incorrect. Either way, we should make the code and the docs consistent.
There was a problem hiding this comment.
There's a discrepancy between doc and code. In addition to the one you mentioned above, the doc is also missing to show Type as required under OnFailure. I'll request a doc update to address these inconsistencies.
marekaiv
approved these changes
Nov 9, 2021
moelasmar
approved these changes
Nov 15, 2021
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:
Description of changes:
Fix
DestinationConfigof streaming event sources by ensuringOnFailureis defined before it's used.If
OnFailureis missing, an error will be thrown.Description of how you validated changes:
Checklist:
make prpassesExamples?
Please reach out in the comments, if you want to add an example. Examples will be
added to
sam initthrough https://github.com/awslabs/aws-sam-cli-app-templates/By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.