AWS Notify Slack Terraform module

This module creates an SNS topic (or uses an existing one) and an AWS Lambda function that sends notifications to Slack using the incoming webhooks API.

Start by setting up an incoming webhook integration in your Slack workspace.

Doing serverless with Terraform? Check out serverless.tf framework, which aims to simplify all operations when working with the serverless in Terraform.

Terraform versions

Terraform 0.13. Pin module version to ~> v4.0. Submit pull-requests to master branch.

Terraform 0.12. Pin module version to 3.5.0 (or older). Submit pull-requests to terraform012 branch.

Terraform 0.11. Pin module version to ~> v1.0.

Features

• [x] AWS Lambda runtime Python 3.8
• [x] Create new SNS topic or use existing one
• [x] Support plaintext and encrypted version of Slack webhook URL
• [x] Most of Slack message options are customizable
• [x] Support different types of SNS messages:
  • [x] AWS CloudWatch Alarms
  • [x] AWS CloudWatch LogMetrics Alarms
  • [ ] Send pull-request to add support of other message types
• [x] Local pytest driven testing of the lambda to a Slack sandbox channel

Usage

module "notify_slack" {
  source  = "terraform-aws-modules/notify-slack/aws"
  version = "~> 4.0"

  sns_topic_name = "slack-topic"

  slack_webhook_url = "https://hooks.slack.com/services/AAA/BBB/CCC"
  slack_channel     = "aws-notification"
  slack_username    = "reporter"
}

Upgrade from 2.0 to 3.0

Version 3 uses Terraform AWS Lambda module to handle most of heavy-lifting related to Lambda packaging, roles, and permissions, while maintaining the same interface for the user of this module after many of resources will be recreated.

Using with Terraform Cloud Agents

Terraform Cloud Agents are a paid feature, available as part of the Terraform Cloud for Business upgrade package.

This module requires Python 3.8. You can customize tfc-agent to include Python using this sample Dockerfile:

FROM hashicorp/tfc-agent:latest
RUN apt-get -y update && apt-get -y install python3.8 python3-pip
ENTRYPOINT ["/bin/tfc-agent"]

Use existing SNS topic or create new

If you want to subscribe the AWS Lambda Function created by this module to an existing SNS topic you should specify create_sns_topic = false as an argument and specify the name of existing SNS topic name in sns_topic_name.

Examples

• notify-slack-simple - Creates SNS topic which sends messages to Slack channel.
• cloudwatch-alerts-to-slack - End to end example which shows how to send AWS Cloudwatch alerts to Slack channel and use KMS to encrypt webhook URL.

Testing with pytest

To run the tests:

1. Set up a dedicated slack channel as a test sandbox with it's own webhook. See Slack Incoming Webhooks docs for details.

2. Make a copy of the sample pytest configuration and edit as needed.

    cp functions/pytest.ini.sample functions/pytest.ini
   

3. Run the tests:

    pytest functions/notify_slack_test.py
   

Requirements

Providers

Modules

Resources

Inputs

Outputs

Authors

Module managed by Anton Babenko.

License

Apache 2 Licensed. See LICENSE for full details.