From 7f96fedc5fb452e605fc53342476de8d04798b91 Mon Sep 17 00:00:00 2001 From: Nick Adams Date: Tue, 20 Apr 2021 11:56:50 -0500 Subject: [PATCH] Initial commit --- .gitignore | 29 ++++++++ LICENSE | 201 +++++++++++++++++++++++++++++++++++++++++++++++++++ main.tf | 84 +++++++++++++++++++++ outputs.tf | 24 ++++++ variables.tf | 70 ++++++++++++++++++ 5 files changed, 408 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 main.tf create mode 100644 outputs.tf create mode 100644 variables.tf diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7a3e2fd --- /dev/null +++ b/.gitignore @@ -0,0 +1,29 @@ +# Local .terraform directories +**/.terraform/* + +# .tfstate files +*.tfstate +*.tfstate.* + +# Crash log files +crash.log + +# Ignore any .tfvars files that are generated automatically for each Terraform run. Most +# .tfvars files are managed as part of configuration and so should be included in +# version control. +# +# example.tfvars + +# Ignore override files as they are usually used to override resources locally and so +# are not checked in +override.tf +override.tf.json +*_override.tf +*_override.tf.json + +# Include override files you do wish to add to version control using negated pattern +# +# !example_override.tf + +# Include tfplan files to ignore the plan output of command: terraform plan -out=tfplan +# example: *tfplan* diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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 + + http://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. diff --git a/main.tf b/main.tf new file mode 100644 index 0000000..2d3829e --- /dev/null +++ b/main.tf @@ -0,0 +1,84 @@ +resource "aws_sqs_queue" "this_deadletter" { + name = "${var.name}-deadletter" + kms_master_key_id = var.use_cmk == true ? aws_kms_alias.this[0].name : "alias/aws/sqs" + kms_data_key_reuse_period_seconds = 300 + message_retention_seconds = var.message_retention_seconds_deadletter + tags = var.tags +} + +resource "aws_sqs_queue" "this" { + name = var.name + kms_master_key_id = var.use_cmk == true ? aws_kms_alias.this[0].name : "alias/aws/sqs" + kms_data_key_reuse_period_seconds = 300 + message_retention_seconds = var.message_retention_seconds + receive_wait_time_seconds = var.receive_wait_time_seconds + visibility_timeout_seconds = var.visibility_timeout_seconds + + redrive_policy = jsonencode({ + deadLetterTargetArn = aws_sqs_queue.this_deadletter.arn + maxReceiveCount = var.max_receive_count + }) + + tags = var.tags +} + +data "aws_iam_policy_document" "this" { + count = var.use_cmk == true ? 1 : 0 + statement { + effect = "Allow" + principals { + type = "Service" + identifiers = [ + "s3.amazonaws.com", + "events.amazonaws.com", + "sns.amazonaws.com" + ] + } + actions = [ + "kms:GenerateDataKey", + "kms:Decrypt" + ] + resources = [ "*" ] + } +} + +resource "aws_kms_key" "this" { + count = var.use_cmk == true ? 1 : 0 + description = "CMK for SQS - ${var.name}" + deletion_window_in_days = 10 + is_enabled = true + enable_key_rotation = true + key_usage = "ENCRYPT_DECRYPT" + policy = data.aws_iam_policy_document.this[0].json + + tags = merge( + var.tags, + { + Name = var.name, + }, + ) +} + +resource "aws_kms_alias" "this" { + count = var.use_cmk == true ? 1 : 0 + name = "alias/${var.name}-Key" + target_key_id = aws_kms_key.this[0].key_id +} + +resource "aws_cloudwatch_metric_alarm" "this_deadletter" { + actions_enabled = var.enable_actions + alarm_actions = var.alarm_actions + alarm_description = var.alarm_description + alarm_name = var.alarm_name + comparison_operator = "GreaterThanOrEqualToThreshold" + dimensions = { + "QueueName" = aws_sqs_queue.this_deadletter.name + } + evaluation_periods = 1 + metric_name = "ApproximateNumberOfMessagesVisible" + namespace = "AWS/SQS" + period = 60 + statistic = "Maximum" + threshold = 1 + treat_missing_data = "missing" + } \ No newline at end of file diff --git a/outputs.tf b/outputs.tf new file mode 100644 index 0000000..5d6a615 --- /dev/null +++ b/outputs.tf @@ -0,0 +1,24 @@ +output "kms_key_id" { + value = var.use_cmk == true ? aws_kms_key.this[0].key_id : "" +} +output "kms_key_alias_name" { + value = var.use_cmk == true ? aws_kms_alias.this[0].name : "" +} +output "sqs_queue_arn" { + value = aws_sqs_queue.this.arn +} +output "sqs_deadletter_queue_arn" { + value = aws_sqs_queue.this_deadletter.arn +} +output "sqs_queue_id" { + value = aws_sqs_queue.this.id +} +output "sqs_deadletter_queue_id" { + value = aws_sqs_queue.this_deadletter.id +} +output "cloudwatch_alarm_id" { + value = aws_cloudwatch_metric_alarm.this_deadletter.id +} +output "cloudwatch_alarm_arn" { + value = aws_cloudwatch_metric_alarm.this_deadletter.arn +} diff --git a/variables.tf b/variables.tf new file mode 100644 index 0000000..6fa66a0 --- /dev/null +++ b/variables.tf @@ -0,0 +1,70 @@ +variable "name" { + type = string + description = "Name to use for resources created by this module" +} + +variable "message_retention_seconds" { + type = number + default = 86400 + description = "Number of seconds for message retention" +} + +variable "message_retention_seconds_deadletter" { + type = number + default = 345600 + description = "Number of seconds for message retention of deadletter messages" +} + +variable "receive_wait_time_seconds" { + type = number + default = 10 + description = "Number of seconds for receive wait time" +} + +variable "visibility_timeout_seconds" { + type = number + default = 180 + description = "Number of seconds for message visibility timeout" +} + +variable "max_receive_count" { + type = number + default = 5 + description = "Number of times a message can be re-received" +} + +variable "use_cmk" { + type = bool + default = true + description = "Should we use a Customer Managed Key for envelope encryption?" +} + +variable "enable_actions" { + type = bool + default = false + description = "Should we enable alarm actions?" +} + +variable "alarm_actions" { + type = list(string) + default = [] + description = "List of alarm action endpoints" +} + +variable "alarm_description" { + type = string + default = "Monitors for messages sent to a deadletter queue." + description = "Description to use for the deadletter monitor" +} + +variable "alarm_name" { + type = string + default = "deadletter-alarm" + description = "Description to use for the deadletter monitor" +} + +variable "tags" { + type = map(string) + default = {} + description = "Map of strings for tags to apply to resources created by this module" +} \ No newline at end of file