AWS guardduty: Update EventBridge rule setup steps and SNS input transformer template guidance
Summary
Refreshes the EventBridge console navigation labels and step text for creating a GuardDuty finding notification rule, and replaces the multi-line input transformer template with a single-line JSON object wrapped in a 'message' key. Adds an Important callout explaining that GuardDuty fields (like description) can contain unescaped control characters/newlines, warning that bare-string or multi-line templates can produce invalid JSON that EventBridge rejects and never delivers, plus a note that email subscriptions render the raw JSON and that chat/Lambda targets give formatted output.
Security assessment
The change fixes an operational reliability problem in the detection-alerting pipeline: a malformed input transformer template causes EventBridge to reject the finding event, so GuardDuty notifications are silently not delivered. Loss of security notifications is security-adjacent (monitoring/alerting), but the diff shows no specific vulnerability, CVE, or incident being addressed, and it documents template formatting rather than a security feature or best practice.
Evidence
+GuardDuty finding fields such as `description` can contain unescaped control characters, including newlines. Don't use either of the following template formats:
Diff
diff --git a/guardduty/latest/ug/guardduty_settingup.md b/guardduty/latest/ug/guardduty_settingup.md index 9befe88..cce4862 100644 --- a//guardduty/latest/ug/guardduty_settingup.md +++ b//guardduty/latest/ug/guardduty_settingup.md @@ -402 +402 @@ To check the email confirmation status, go to the SNS console and choose **Subsc - 2. In the navigation pane, choose **Rules**. + 2. In the navigation pane, under **Buses** , choose **Rules**. @@ -410 +410 @@ A rule can't have the same name as another rule in the same Region and on the sa - 5. For **Event bus** , choose **default**. + 5. For **Event bus** , ensure that **default** is selected and **Enable the rule on the selected event bus** is turned on. @@ -416 +416 @@ A rule can't have the same name as another rule in the same Region and on the sa - 8. For **Event source** , choose **AWS events**. + 8. On the **Build event pattern** page, for **Event source** , choose **AWS events or EventBridge partner events**. @@ -418 +418 @@ A rule can't have the same name as another rule in the same Region and on the sa - 9. For **Event pattern** , choose **Event pattern form**. + 9. In the **Event pattern** section, for **Creation method** , choose **Use pattern form**. @@ -424 +424 @@ A rule can't have the same name as another rule in the same Region and on the sa - 12. For **Event Type** , choose **GuardDuty Finding**. + 12. For **Event type** , choose **GuardDuty Finding**. @@ -430 +430 @@ A rule can't have the same name as another rule in the same Region and on the sa - 15. For **Select a target** , choose **SNS topic** , and for **Topic** , choose the name of the SNS topic you created earlier. + 15. For **Select a target** , choose **SNS topic**. For **Target location** , choose **Target in this account**. For **Topic** , choose the name of the SNS topic you created earlier. @@ -432 +432 @@ A rule can't have the same name as another rule in the same Region and on the sa - 16. In the **Additional settings** section, for **Configure target input** , choose **Input transformer**. + 16. Expand **Additional settings**. For **Configure target input** , choose **Input transformer**. @@ -449 +449 @@ Adding an input transformer formats the JSON finding data sent from GuardDuty in - 19. To format the email, for **Template** , paste the following code and make sure to replace the text in red with the values appropriate to your Region: + 19. To format the email, for **Template** , paste the following code. When EventBridge delivers each finding, the input transformer fills in the values in angle brackets, such as `<severity>` and `<Finding_ID>`, from the **Input path** , so you don't need to replace them. @@ -451,4 +451 @@ Adding an input transformer formats the JSON finding data sent from GuardDuty in - "You have a severity <severity> GuardDuty finding type <Finding_Type> in the <region> region." - "Finding Description:" - "<Finding_Description>." - "For more details open the GuardDuty console at https://console.aws.amazon.com/guardduty/home?region=<region>#/findings?search=id%3D<Finding_ID>" + {"message":"You have a severity <severity> GuardDuty finding type <Finding_Type> in the <region> Region.\n\nFinding Description:\n<Finding_Description>\n\nFor more details open the GuardDuty console at https://console.aws.amazon.com/guardduty/home?region=<region>#/findings?search=id%3D<Finding_ID>"} @@ -455,0 +453,15 @@ Adding an input transformer formats the JSON finding data sent from GuardDuty in +###### Important + +Provide the template as a single-line JSON object, with the message wrapped in a key such as `message`, as shown in the preceding example. Use `\n` to add line breaks. + +GuardDuty finding fields such as `description` can contain unescaped control characters, including newlines. Don't use either of the following template formats: + + * A bare quoted string + + * A multi-line template that uses separate quoted strings on separate lines + +With these formats, the substituted value can produce invalid JSON. EventBridge then rejects the event and doesn't deliver the notification. + +###### Note + +Email subscriptions receive the template output as is, so the email shows the `message` JSON object, and line breaks appear as `\n`. For formatted notifications, deliver the Amazon SNS topic to Amazon Q Developer in chat applications (Slack or Amazon Chime), or use an Lambda function as the target.