Terraform module to provision SNS topic
This project is part of our comprehensive "SweetOps" approach towards DevOps.
It's 100% Open Source and licensed under the APACHE2.
We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!
This module provides:
- SNS topic creation
- SNS topic policy
- SNS topic subscriptions
It's possible to subscribe SQS as Dead Letter Queue.
Unfortunately redrive_policy is not yet available in terraform. It's waiting for PR hashicorp/terraform-provider-aws#11770
Without redrive_policy it's impossible to configure DLQ.
IMPORTANT: The master branch is used in source just as an example. In your code, do not pin to master because there may be breaking changes between releases.
Instead pin to the release tag (e.g. ?ref=tags/x.y.z) of one of our latest releases.
Amazon Simple Notification Service (Amazon SNS) is a web service that coordinates and manages the delivery or sending of messages to subscribing endpoints or clients. SNS documentation
There are many ways SNS can be used. As an example we can imagine CloudWatch sending alerts to SNS, by using subscribers such notifications can be sent further to PagerDuty, OpsGenie or any other oncall management tool.
module "sns" {
source = "git::https://github.com/cloudposse/terraform-aws-sns-topic.git?ref=0.0.1"
attributes = var.attributes
name = var.name
namespace = var.namespace
stage = var.stage
subscribers = {
opsgenie = {
protocol = "https"
endpoint = "https://api.example.com/v1/"
endpoint_auto_confirms = true
}
}
sqs_dlq_enabled = false
}Available targets:
help Help screen
help/all Display help for all targets
help/short This help short screen
lint Lint terraform code
| Name | Version |
|---|---|
| terraform | ~> 0.12.0 |
| aws | ~> 2.0 |
| Name | Version |
|---|---|
| aws | ~> 2.0 |
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| allowed_aws_services_for_sns_published | AWS services that will have permission to publish to SNS topic. Used when no external json policy is used. | list(string) |
[ |
no |
| allowed_iam_arns_for_sns_publish | IAM role/user ARNs that will have permission to publish to SNS topic. Used when no external json policy is used. | list(string) |
[] |
no |
| attributes | Additional attributes to distinguish this SNS topic | list(string) |
[] |
no |
| kms_master_key_id | The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK | string |
null |
no |
| name | Name to distinguish this SNS topic | string |
"sns" |
no |
| namespace | Namespace (e.g. cp or cloudposse) |
string |
n/a | yes |
| sns_topic_policy_json | The fully-formed AWS policy as JSON | string |
"" |
no |
| sqs_dlq_enabled | Enable delivery of failed notifications to SQS and monitor messages in queue. | bool |
false |
no |
| sqs_dlq_max_message_size | The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB). | number |
262144 |
no |
| sqs_dlq_message_retention_seconds | The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). | number |
1209600 |
no |
| stage | Stage (e.g. prod, dev, staging) |
string |
n/a | yes |
| subscribers | Required configuration for subscibres to SNS topic. | map(object({ |
{} |
no |
| Name | Description |
|---|---|
| aws_sns_topic_subscriptions | SNS topic subscriptions |
| sns_topic | SNS topic |
Like this project? Please give it a ★ on our GitHub! (it helps us a lot)
Are you using this project or any of our other projects? Consider leaving a testimonial. =)
Check out these related projects.
- terraform-aws-sns-cloudwatch-sns-alarms - Terraform module that configures CloudWatch SNS alerts for SNS
- terraform-aws-ecs-cloudwatch-sns-alarms - Terraform module that configures CloudWatch SNS alerts for ECS
- terraform-aws-efs-cloudwatch-sns-alarms - Terraform module that configures CloudWatch SNS alerts for EFS
- terrform-aws-elasticache-cloudwatch-sns-alarms - Terraform module that configures CloudWatch SNS alerts for ElastiCache
- terraform-aws-lambda-cloudwatch-sns-alarms - Terraform module for creating a set of Lambda alarms and outputting to an endpoint
- terraform-aws-rds-cloudwatch-sns-alarms - Terraform module that configures important RDS alerts using CloudWatch and sends them to an SNS topic
- terraform-aws-sqs-cloudwatch-sns-alarms - Terraform module for creating alarms for SQS and notifying endpoints
Got a question? We got answers.
File a GitHub issue, send us an email or join our Slack Community.
We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.
Work directly with our team of DevOps experts via email, slack, and video conferencing.
We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.
- Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
- Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
- Site Reliability Engineering. You'll have total visibility into your apps and microservices.
- Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
- GitOps. You'll be able to operate your infrastructure via Pull Requests.
- Training. You'll receive hands-on training so your team can operate what we build.
- Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
- Troubleshooting. You'll get help to triage when things aren't working.
- Code Reviews. You'll receive constructive feedback on Pull Requests.
- Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.
Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.
Participate in our Discourse Forums. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.
Sign up for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!
Please use the issue tracker to report any bugs or file feature requests.
If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull Request so that we can review your changes
NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!
Copyright © 2017-2020 Cloud Posse, LLC
See LICENSE for full details.
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
All other trademarks referenced herein are the property of their respective owners.
This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!
We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.
We offer paid support on all of our projects.
Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.
 Marcin Brański |
|---|