No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
test
.gitignore
.travis.yml
.yamllint
LICENSE
README.md
module.yml
package.json

README.md

Build Status NPM version

cfn-modules: Alerting

Central SNS topic that receives alerts from other modules and forwards them to your team via email, HTTP, or HTTPS.

Install

Install Node.js and npm first!

npm i @cfn-modules/alerting

Usage

---
AWSTemplateFormatVersion: '2010-09-09'
Description: 'cfn-modules example'
Resources:
  Alerting:
    Type: 'AWS::CloudFormation::Stack'
    Properties:
      Parameters:
        Email: 'team@org.com' # optional
        HttpEndpoint: 'http://org.com/webhook' # optional
        HttpsEndpoint: 'https://org.com/webhook' # optional
        FallbackEmail: 'user@org.net' # optional
      TemplateURL: './node_modules/@cfn-modules/alerting/module.yml'

Parameters

Name Description Default Required? Allowed values
Email Email address that will receive alerts no
HttpEndpoint HTTP endpoint that will receive alerts via POST requests no
HttpsEndpoint HTTPS endpoint that will receive alerts via POST requests (can be a marbot.io endpoint) no
FallbackEmail Email address that will receive alerts if alerts can not be delivered no