tf-module-sns-teams-relay

Terraform module to relay AWS SNS messages to a Teams webhook

A CloudFormation template of these resources is available at https://github.com/CU-CommunityApps/cu-aws-cloudformation/tree/main/sns-teams-relay

Change Log

2024-11-08

• Moved repository from https://github.com/CU-CommunityApps/tf-module-sns-teams-relay to https://github.com/cu-cit-cloud-team/tf-module-sns-teams-relay as part of Cornell Github Organization restructuring.

v3.2.0

• add generic_sns_topic_arn_list_normal parameter
• add generic_sns_topic_arn_list_alert parameter
• updated to Lambda code to support these new parameters

v3.1.0

• minor change to generic SNS message display format to allow markdown-formatted message payloads to display better in Teams

v3.0.0

• add terraform/required_providers block for aws provider.

v2.1.1

• revert to using just sns_topic_arn_list to create subscriptions

v2.1.0

• add support for handling CloudWatch alarms messages
• add default value of empty list for sns_topic_arn_list parameter
• add alarm_sns_topic_arn_list_normal parameter
• add alarm_sns_topic_arn_list_alert parameter
• add strftime_format parameter

v2.0.0

• apply some Python style improvements
• add support for two different webhook URLs; one handles regular notifications, one handles more critical notifications
• add support for contextual colors, depending on notification type

v1.1.0

• refactor aws_sns_topic_subscription, aws_lambda_permission to avoid this TF error: 'The "for_each" value depends on resource attributes that cannot be determined until apply, so Terraform cannot predict how many instances will be created. To work around this, use the -target argument to first apply only the resources that the for_each depends on.'

v1.0.0

• Initial release

Variables

• namespace (optional) --- A string prefix to add to AWS resource in order to ensure unique AWS resource names, if the module is deployed multiple times in the same region
• tags (optional) --- Mapping of tags to apply to AWS resources created
• teams_webhook_url_normal (required) --- URL of webhook exposed for target Teams channel for regular notifications
• teams_webhook_url_alert (required) --- URL of webhook for the target Teams channel
• sns_topic_arn_list (optional) --- A list of SNS Arns which should have messages relayed to Teams
• alarm_sns_topic_arn_list_normal --- All alarm notifications coming on these SNS topics always will be sent to the normal webhook. All these topics must also be included in sns_topic_arn_list.
• alarm_sns_topic_arn_list_alert --- All alarm notifications coming on these SNS topics always will be sent to the alert webhook. All these topics must also be included in sns_topic_arn_list.
• strftime_format --- Python strftime format string to use to convert to readable timestamps in output messages

Outputs

• sns_teams_relay_lambda_arn --- the Arn of the Lambda function deployed by the module

Example Use

resource "aws_sns_topic" "example" {
  name = "example-topic"
}

module "sns_teams_relay" {
  source = "github.com/CU-CommunityApps/tf-module-sns-teams-relay.git?ref=v2.1.0"
  
  tags                      = {
    "Environment" = "development"
  }
  namespace                 = "example"
  teams_webhook_url_normal  = "https://cornellprod.webhook.office.com/webhookb2/abc123"
  teams_webhook_url_alert   = "https://cornellprod.webhook.office.com/webhookb2/xyz789"
  sns_topic_arn_list        = [ aws_sns_topic.example.arn ]
}