Add validation for S3 NotificationConfiguration in Serverless Functin… #2473
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
mildaniel
approved these changes
Aug 22, 2022
jfuss
requested changes
Aug 22, 2022
| @@ -407,13 +407,16 @@ def _inject_notification_configuration(self, function, bucket): | |||
| notification_config = {} | |||
| properties["NotificationConfiguration"] = notification_config | |||
|
|
|||
| if not isinstance(notification_config, dict): | |||
| raise InvalidResourceException(bucket_id, "Invalid type for NotificationConfiguration. Must be a dict.") | |||
There was a problem hiding this comment.
Is dict the right wording here? I only ask because dict is pretty Python specific. How does CloudFormation communicate things like this?
There was a problem hiding this comment.
CloudFormation doesn't seem have a generic name for an object/dict (e.g. it's called NotificationConfiguration type for this case).
Instead of "dict", I think we can just say "Invalid type for NotificationConfiguration". I think it's informative enough for customer to find out how to fix it.
Codecov Report
@@ Coverage Diff @@
## develop #2473 +/- ##
===========================================
+ Coverage 93.58% 94.49% +0.90%
===========================================
Files 90 98 +8
Lines 6124 7299 +1175
Branches 1260 1523 +263
===========================================
+ Hits 5731 6897 +1166
- Misses 183 194 +11
+ Partials 210 208 -2
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
jfuss
approved these changes
Aug 23, 2022
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:
N/A/
Description of changes:
Add Validation for
NotifcationConfigurationin a S3 Bucket if it is used in a Serverless Function as an event source.Description of how you validated changes:
Updated test to catch this error.
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.