The purpose of this module is to provide a quick and easy way of translating CloudWatch Alarm's into Email Notifications.
Important
- This module requires the use of AWS Simple Email Service (SES) to send it's notifications.
- If you have deployed v9.x or lower please be advised that the module should be decommissioned entirely before upgrading to v10.x or higher.
- Please read our CHANGELOG for more details.
The following list of AWS services are supported:
- CloudWatch Alarms
Note: We do plan to support other AWS services such as Backup Vault in the future.
Important
- If your SES is currently in sandbox then all email identities must be verified.
- If your SES is no longer in sandbox then only the sender's email address or the sender's domain must be verified identities.
After deploying this module to the AWS account the SRE will need to create or adjust their CloudWatch Alarm configuration. The Alarm's alarm_action and/or ok_action should point at the SNS topic provisioned by this module.
| Variable | Description |
|---|---|
| email_from | Required; The designated email address used as the sender of email notifications. |
| email_to | Required; The designated list of recipient email address of email notifications. |
| encrypted | Optional; Topics will be encrypted at rest using a KMS managed key. |
| kms_key_alias | Optional; Required when encrypted is turned on. |
| log_group_retention_in_days | Optional; Number of days applied to the log group retention policy. |
| name_prefix | Required; Unique name prefix used to label resources. |
We welcome contributions. Please read CONTRIBUTING.md for how to contribute.
We strive for a welcoming and inclusive environment for terraform-aws-sns-notification-framework. Please follow this guidelines in all interactions:
- Be Respectful: use welcoming and inclusive language.
- Assume best intentions: seek to understand other's opinions.
terraform-aws-sns-notification-framework is licensed under the Creative Commons Zero license A copy of that license is distributed with this software.
Please do not submit an issue on GitHub for a security vulnerability. Please contact the SBA at [{{ [email protected] }}](mailto:{{ [email protected] }}).
Be sure to include all the pertinent information.
Created in 1953, the U.S. Small Business Administration (SBA) continues to help small business owners and entrepreneurs pursue the American dream. The SBA is the only cabinet-level federal agency fully dedicated to small business and provides counseling, capital, and contracting expertise as the nation’s only go-to resource and voice for small businesses.
By making source code available for sharing and re-use across Federal agencies, we can avoid duplicative custom software purchases and promote innovation and collaboration across Federal agencies. By opening more of our code to the brightest minds inside and outside of government, we can enable them to work together to ensure that the code is reliable and effective in furthering our national objectives. And we can do all of this while remaining consistent with the Federal Government’s long-standing policy of technology neutrality, through which we seek to ensure that Federal investments in IT are merit-based, improve the performance of our government, and create value for the American people.