https://github.com/byu-oit/terraform-aws-sns-teams-lambda
Send messages to teams from SNS
https://github.com/byu-oit/terraform-aws-sns-teams-lambda
Last synced: 5 months ago
JSON representation
Send messages to teams from SNS
- Host: GitHub
- URL: https://github.com/byu-oit/terraform-aws-sns-teams-lambda
- Owner: byu-oit
- License: apache-2.0
- Created: 2022-04-14T16:08:37.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-10-30T16:03:15.000Z (over 2 years ago)
- Last Synced: 2025-03-05T22:32:12.720Z (over 1 year ago)
- Language: HCL
- Size: 25.4 KB
- Stars: 0
- Watchers: 12
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SNS to Teams Lambda
Terraform module to create a Lambda that can transform SNS notifications and send them to Teams.
#### [New to Terraform Modules at BYU?](https://devops.byu.edu/terraform/index.html)
## Usage
1. Create
a [Teams Webhook](https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook#create-incoming-webhook-1)
and generate a webhook URL.
```hcl
module "sns_teams_lambda" {
source = "github.com/byu-oit/terraform-aws-sns-teams-lambda?ref=v1.0.0"
}
```
### Limitations
Because
of [limitations with Terraform](https://www.terraform.io/docs/language/meta-arguments/for_each.html#limitations-on-values-used-in-for_each)
, SNS Topics you want integrating with this module should be created in your one-time setup resources. You can then
include this module in your app resources as normal. If that's not possible, you must add this module to your app
resources after the initial deployment of your application to a new environment and creation of the SNS Topic it will
integrate with. Otherwise, you'll get an error similar to this:
```bash
Error: Invalid for_each argument
on ../../main.tf line 75, in resource "aws_lambda_permission" "with_sns":
75: for_each = var.sns_topic_arns
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.
```
## Requirements
* Terraform version 0.14.11 or greater
* AWS provider version 3.0.0 or greater
## Inputs
| Name | Type | Description | Default |
|---------------------------| --- |--------------------------------------------------------------------------------------------------------------------|---------|
| app_name | string | The application name to include in the name of resources created. Displayed as a prefix to the Teams message. |
| log_retention_in_days | number | The number of days to retain logs for the sns-to-teams Lambda. | 90 |
| memory_size | number | The amount of memory for the function | 128 |
| role_permissions_boundary | string | The ARN of the role permissions boundary to attach to the Lambda role. |
| send_to_teams | boolean | Whether or not to actually send messages to Teams. Recommended to be false for all environments except production. | true |
| teams_webhook_url | string | The webhook URL to use when sending messages to Teams. This value contains a secret and should be kept safe. |
| sns_topic_arns | set(string) | The ARNs of the SNS topics you want to see messages for in Teams. |
| timeout | number | The number of seconds the function is allowed to run. | 30 |
| tags | map(string) | A map of AWS Tags to attach to each resource created. | {} |
## Outputs
| Name | Type | Description |
| --- | --- | --- |
| lambda_function_arn | string | The ARN of the Lambda function created. |
| lambda_function_name | string | The name of the Lambda function created. |
# Deployment
When developing this module, if you update the Lambda code, be sure to run `zip -r function.zip .` in the `lamba` folder
so your code changes are bundled with the module.