How do I implement the AWS SHD Notifier?

Short description

It's a best practice to use AWS User Notifications or Amazon EventBridge for public event notifications. User Notifications provides a centralized place to set up and manage your AWS notifications. AWS Health publishes public events to EventBridge in your primary and backup AWS Regions.

AWS Health SHD Notifier sends service status updates to an Amazon Simple Notification Service (Amazon SNS) topic, Amazon Chime webhook, or Slack webhook. For more information, see AWS Health SHD Notifier on the GitHub website.

Resolution

Note: If you receive errors when you run AWS Command Line Interface (AWS CLI) commands, then see Troubleshooting errors for the AWS CLI. Also, make sure that you're using the most recent AWS CLI version.

Set up User Notifications

To set up User Notifications, create a notification configuration.

Use EventBridge for public event notifications

To receive AWS Health events from EventBridge, create rules that react to events in Amazon EventBridge.

Install the AWS SHD Notifier tool

Complete the following steps:

1. Run the following command in your terminal or CLI:

   git clone https://github.com/aws/aws-health-tools.git && cd aws-health-tools

   Example output:

   Cloning into 'aws-health-tools'... 
   remote: Enumerating objects... 
   remote: Counting objects... 
   remote: Compressing objects... 
   remote: Total XXXX (delta YY), reused ZZZZ 
   Receiving objects: 100% 
   Resolving deltas: 100%
   

2. Run the following command:

   git filter-branch --subdirectory-filter shd-notifier/ HEAD

   Example output:

   Rewrite ... (X/Y) (Z%) 
   ... 
   Ref 'HEAD' was rewritten

Create a notification on Slack, Amazon Chime, or Amazon SNS

To create a notification type, see the following documentation:

• For Slack webhooks, see Sending messages using incoming webhooks on the Slack Developers website.
• For Amazon Chime webhooks, see Adding webhooks to a chat room.
• For Amazon SNS, see Create an Amazon SNS topic and publish messages.

Run the CloudFormation template

Complete the following steps:

1. Open the AWS CloudFormation console.
2. In the navigation pane, choose Stacks, and then choose Create stack.
3. For Prerequisite - Prepare template, choose Choose an existing template.
4. Under Specify template, choose Amazon S3 URL.
5. Enter the following Amazon Simple Storage Service (Amazon S3) template URL:
   https://s3.amazonaws.com/aws-health-tools-assets/cloudformation-templates/shd-notifier.yml
6. Choose Next.
7. For the Stack name, enter ShdNotifier.
8. Choose Next.
9. Select I acknowledge that AWS CloudFormation might create IAM resources.
10. Choose Next, and then choose Submit.

The following are example endpoint arrays:

• Chime: ["https://hooks.chime.aws/incomingwebhooks/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXXX?token=XXXXXXXXXXXXXXXXXXXX"]
• Slack: ["arn:aws:sns:us-east-1:111122223333:MY_TOPIC_NAME"]
• Amazon SNS: ["https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"]

Run shd-notifier

Run the deploy.sh file on the AWS CLI:

/bin/bash deploy.sh Health-Event us-east-1

Note: Replace us-east-1 with your Region.