https://github.com/ServerlessOpsIO/aws-health-event-to-slack-message

Receive AWS health notification events and format to a Slack message and publish over SNS
https://github.com/ServerlessOpsIO/aws-health-event-to-slack-message

Last synced: 3 months ago
JSON representation

Receive AWS health notification events and format to a Slack message and publish over SNS

• Host: GitHub
• URL: https://github.com/ServerlessOpsIO/aws-health-event-to-slack-message
• Owner: ServerlessOpsIO
• License: bsd-2-clause
• Created: 2018-05-10T22:45:23.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-09-28T09:33:19.000Z (about 1 year ago)
• Last Synced: 2024-06-28T07:38:22.116Z (5 months ago)
• Language: Python
• Size: 56.6 KB
• Stars: 7
• Watchers: 4
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# aws-health-event-publisher

[![Serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com)

[![License](https://img.shields.io/badge/License-BSD%202--Clause-orange.svg)](https://opensource.org/licenses/BSD-2-Clause)

[![Build Status](https://travis-ci.org/ServerlessOpsIO/aws-health-event-to-slack-message.svg?branch=master)](https://travis-ci.org/ServerlessOpsIO/aws-health-event-to-slack-message)

Publish an AWS Health event formatted as a Slack API _chat.postMessage_ message to an SNS topic.  **This currently supports AWS Health notifications and not issues because issues are not sent as _aws.health_ events.**

![System Architecture](/diagram.png?raw=true "System Architecture")

This is intended to be used with [aws-sns-to-slack-publisher](https://github.com/ServerlessOpsIO/aws-sns-to-slack-publisher)

## Service Interface

* __Event Type:__ AWS CloudWatch Event - Health Event

* __Event Message:__ The message shape may be found here: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#health-event-types

Example event:

```json

{

  "version": "0",

  "id": "7bf73129-1428-4cd3-a780-95db273d1602",

  "detail-type": "AWS Health Event",

  "source": "aws.health",

  "account": "123456789012",

  "time": "2016-06-05T06:27:57Z",

  "region": "%%region%%",

  "resources": [],

  "detail": {

    "eventArn": "arn:aws:health:%%region%%::event/%%id%%",

    "service": "service",

    "eventTypeCode": "AWS_%%service_code%%",

    "eventTypeCategory": "%%category%%",

    "startTime": "Sun, 05 Jun 2016 05:01:10 GMT",

    "endTime": "Sun, 05 Jun 2016 05:30:57 GMT",

    "eventDescription": [{

      "language": "%%lang-code%%",

      "latestDescription": "%%description%%"

    }]

    ...

  }

}

```

## Deployment

This application is intended to be deployed using [AWS Serverless Application Repository](https://aws.amazon.com/serverless/serverlessrepo/).  However, [Serverless Framework](https://www.serverless.com) is also supported.

### Serverless Application Repository / CloudFormation

* AWS Serverless Application Repository: [aws-health-event-publisher](https://serverlessrepo.aws.amazon.com/applications/arn:aws:serverlessrepo:us-east-1:641494176294:applications~aws-health-event-to-slack-message)

### Serverless Framework

```

$ npm install -g serverless

$ npm install

$ serverless deploy -v

```

## Exports

* __${AWS::StackName}-HealthEventSnsTopicArn__: AWS SNS topic ARN where health events are published to.