feat: added functionality (#3)

## Description
<!--- Describe your changes in detail -->

## Motivation and Context
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->

## Breaking Changes
<!-- Does this break backwards compatibility with the current major
version? -->
<!-- If so, please provide an explanation why it is necessary. -->

## How Has This Been Tested?
- [ ] I have updated at least one of the `examples/*` to demonstrate and
validate my change(s)
- [ ] I have tested and validated these changes using one or more of the
provided `examples/*` projects
<!--- Users should start with an existing example as its written, deploy
it, then check their changes against it -->
<!--- This will highlight breaking/disruptive changes. Once you have
checked, deploy your changes to verify -->
<!--- Please describe how you tested your changes -->
- [ ] I have executed `pre-commit run -a` on my pull request
<!--- Please see
https://github.com/antonbabenko/pre-commit-terraform#how-to-install for
how to install -->

README.md

@@ -1,2 +1,95 @@
 # terraform-aws-lambda
 Terraform module which creates a lambda function, monitoring via CloudWatch and a dead-letter queue with roles
+
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Requirements
+
+| Name | Version |
+|------|---------|
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3.0 |
+| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4.30.0 |
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4.30.0 |
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| <a name="module_cloudwatch_label"></a> [cloudwatch\_label](#module\_cloudwatch\_label) | cloudposse/label/null | 0.25.0 |
+| <a name="module_dead_letter_queue"></a> [dead\_letter\_queue](#module\_dead\_letter\_queue) | justtrackio/sqs-queue/aws | 1.4.0 |
+| <a name="module_iam_label"></a> [iam\_label](#module\_iam\_label) | cloudposse/label/null | 0.25.0 |
+| <a name="module_lambda_label"></a> [lambda\_label](#module\_lambda\_label) | cloudposse/label/null | 0.25.0 |
+| <a name="module_sqs_label"></a> [sqs\_label](#module\_sqs\_label) | cloudposse/label/null | 0.25.0 |
+| <a name="module_this"></a> [this](#module\_this) | cloudposse/label/null | 0.25.0 |
+
+## Resources
+
+| Name | Type |
+|------|------|
+| [aws_cloudwatch_log_group.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) | resource |
+| [aws_cloudwatch_metric_alarm.errors](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_metric_alarm) | resource |
+| [aws_cloudwatch_metric_alarm.success_rate](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_metric_alarm) | resource |
+| [aws_cloudwatch_metric_alarm.throttles](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_metric_alarm) | resource |
+| [aws_iam_role.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
+| [aws_iam_role_policy.dead_letter_queue](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) | resource |
+| [aws_iam_role_policy.logs](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) | resource |
+| [aws_iam_role_policy_attachment.lambda_insights](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
+| [aws_lambda_function.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_function) | resource |
+| [aws_iam_policy.lambda_insights](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy) | data source |
+| [aws_iam_policy_document.dead_letter_queue_access](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
+| [aws_iam_policy_document.log_stream_access](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
+| [aws_iam_policy_document.trust_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| <a name="input_additional_tag_map"></a> [additional\_tag\_map](#input\_additional\_tag\_map) | Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`.<br>This is for some rare cases where resources want additional configuration of tags<br>and therefore take a list of maps with tag key, value, and additional configuration. | `map(string)` | `{}` | no |
+| <a name="input_alarm_backlog"></a> [alarm\_backlog](#input\_alarm\_backlog) | Errors alarm parameters | <pre>object({<br>    minutes             = optional(number, 5)<br>    datapoints_to_alarm = optional(number, 5)<br>    evaluation_periods  = optional(number, 5)<br>    period              = optional(number, 300)<br>    threshold           = optional(number, 1)<br>  })</pre> | `{}` | no |
+| <a name="input_alarm_create"></a> [alarm\_create](#input\_alarm\_create) | Whether to create the errors and success rate alarms or not | `bool` | `true` | no |
+| <a name="input_alarm_errors"></a> [alarm\_errors](#input\_alarm\_errors) | Errors alarm parameters | <pre>object({<br>    datapoints_to_alarm = optional(number, 9)<br>    evaluation_periods  = optional(number, 10)<br>    period              = optional(number, 300)<br>    threshold           = optional(number, 1)<br>  })</pre> | `{}` | no |
+| <a name="input_alarm_success_rate"></a> [alarm\_success\_rate](#input\_alarm\_success\_rate) | Success rate alarm parameters | <pre>object({<br>    datapoints_to_alarm = optional(number, 1)<br>    evaluation_periods  = optional(number, 1)<br>    period              = optional(number, 60)<br>    threshold           = optional(number, 99)<br>  })</pre> | `{}` | no |
+| <a name="input_alarm_throttles"></a> [alarm\_throttles](#input\_alarm\_throttles) | Throttles alarm parameters | <pre>object({<br>    datapoints_to_alarm = optional(number, 2)<br>    evaluation_periods  = optional(number, 3)<br>    period              = optional(number, 60)<br>    threshold           = optional(number, 1)<br>  })</pre> | `{}` | no |
+| <a name="input_alarm_topic_arn"></a> [alarm\_topic\_arn](#input\_alarm\_topic\_arn) | ARN of the SNS Topic used for notifying about alarm/ok messages. | `string` | `null` | no |
+| <a name="input_architectures"></a> [architectures](#input\_architectures) | Instruction set architecture for your Lambda function. Valid values are ['x86\_64'] and ['arm64']. Default is ['x86\_64']. Removing this attribute, function's architecture stay the same | `list(string)` | `null` | no |
+| <a name="input_attributes"></a> [attributes](#input\_attributes) | ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,<br>in the order they appear in the list. New attributes are appended to the<br>end of the list. The elements of the list are joined by the `delimiter`<br>and treated as a single ID element. | `list(string)` | `[]` | no |
+| <a name="input_aws_account_id"></a> [aws\_account\_id](#input\_aws\_account\_id) | AWS Account ID | `string` | n/a | yes |
+| <a name="input_aws_region"></a> [aws\_region](#input\_aws\_region) | The AWS region | `string` | n/a | yes |
+| <a name="input_container_image_tag"></a> [container\_image\_tag](#input\_container\_image\_tag) | Tag within the container repository, can e.g. take values from data.aws\_ecr\_image.my-image.image\_tag | `string` | n/a | yes |
+| <a name="input_container_repository_url"></a> [container\_repository\_url](#input\_container\_repository\_url) | URL of the repository, can e.g. take values from data.aws\_ecr\_repository.my-repo.repository\_url | `string` | n/a | yes |
+| <a name="input_context"></a> [context](#input\_context) | Single object for setting entire context at once.<br>See description of individual variables for details.<br>Leave string and numeric variables as `null` to use default value.<br>Individual variable settings (non-null) override settings in context object,<br>except for attributes, tags, and additional\_tag\_map, which are merged. | `any` | <pre>{<br>  "additional_tag_map": {},<br>  "attributes": [],<br>  "delimiter": null,<br>  "descriptor_formats": {},<br>  "enabled": true,<br>  "environment": null,<br>  "id_length_limit": null,<br>  "label_key_case": null,<br>  "label_order": [],<br>  "label_value_case": null,<br>  "labels_as_tags": [<br>    "unset"<br>  ],<br>  "name": null,<br>  "namespace": null,<br>  "regex_replace_chars": null,<br>  "stage": null,<br>  "tags": {},<br>  "tenant": null<br>}</pre> | no |
+| <a name="input_dead_letter_queue_create"></a> [dead\_letter\_queue\_create](#input\_dead\_letter\_queue\_create) | Defines if you want to add a dead letter queue to your lambda function, capturing all errored events. | `bool` | `true` | no |
+| <a name="input_delimiter"></a> [delimiter](#input\_delimiter) | Delimiter to be used between ID elements.<br>Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. | `string` | `null` | no |
+| <a name="input_descriptor_formats"></a> [descriptor\_formats](#input\_descriptor\_formats) | Describe additional descriptors to be output in the `descriptors` output map.<br>Map of maps. Keys are names of descriptors. Values are maps of the form<br>`{<br>   format = string<br>   labels = list(string)<br>}`<br>(Type is `any` so the map values can later be enhanced to provide additional options.)<br>`format` is a Terraform format string to be passed to the `format()` function.<br>`labels` is a list of labels, in order, to pass to `format()` function.<br>Label values will be normalized before being passed to `format()` so they will be<br>identical to how they appear in `id`.<br>Default is `{}` (`descriptors` output will be empty). | `any` | `{}` | no |
+| <a name="input_enabled"></a> [enabled](#input\_enabled) | Set to false to prevent the module from creating any resources | `bool` | `null` | no |
+| <a name="input_environment"></a> [environment](#input\_environment) | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | `string` | `null` | no |
+| <a name="input_environment_variables"></a> [environment\_variables](#input\_environment\_variables) | Map of environment variables to be added to the lambda context. | `map(string)` | `{}` | no |
+| <a name="input_id_length_limit"></a> [id\_length\_limit](#input\_id\_length\_limit) | Limit `id` to this many characters (minimum 6).<br>Set to `0` for unlimited length.<br>Set to `null` for keep the existing setting, which defaults to `0`.<br>Does not affect `id_full`. | `number` | `null` | no |
+| <a name="input_insights_enable"></a> [insights\_enable](#input\_insights\_enable) | Defines whether to attach the required policies to run Lambda Insights. | `bool` | `true` | no |
+| <a name="input_label_key_case"></a> [label\_key\_case](#input\_label\_key\_case) | Controls the letter case of the `tags` keys (label names) for tags generated by this module.<br>Does not affect keys of tags passed in via the `tags` input.<br>Possible values: `lower`, `title`, `upper`.<br>Default value: `title`. | `string` | `null` | no |
+| <a name="input_label_order"></a> [label\_order](#input\_label\_order) | The order in which the labels (ID elements) appear in the `id`.<br>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. | `list(string)` | `null` | no |
+| <a name="input_label_orders"></a> [label\_orders](#input\_label\_orders) | Overrides the `labels_order` for the different labels to modify ID elements appear in the `id` | <pre>object({<br>    cloudwatch = optional(list(string)),<br>    iam        = optional(list(string)),<br>    lambda     = optional(list(string)),<br>    sqs        = optional(list(string)),<br>  })</pre> | `{}` | no |
+| <a name="input_label_value_case"></a> [label\_value\_case](#input\_label\_value\_case) | Controls the letter case of ID elements (labels) as included in `id`,<br>set as tag values, and output by this module individually.<br>Does not affect values of tags passed in via the `tags` input.<br>Possible values: `lower`, `title`, `upper` and `none` (no transformation).<br>Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs.<br>Default value: `lower`. | `string` | `null` | no |
+| <a name="input_labels_as_tags"></a> [labels\_as\_tags](#input\_labels\_as\_tags) | Set of labels (ID elements) to include as tags in the `tags` output.<br>Default is to include all labels.<br>Tags with empty values will not be included in the `tags` output.<br>Set to `[]` to suppress all generated tags.<br>**Notes:**<br>  The value of the `name` tag, if included, will be the `id`, not the `name`.<br>  Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be<br>  changed in later chained modules. Attempts to change it will be silently ignored. | `set(string)` | <pre>[<br>  "default"<br>]</pre> | no |
+| <a name="input_memory_size"></a> [memory\_size](#input\_memory\_size) | Amount of memory in MB your Lambda Function can use at runtime. Defaults to 128. | `number` | `null` | no |
+| <a name="input_name"></a> [name](#input\_name) | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br>This is the only ID element not also included as a `tag`.<br>The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input. | `string` | `null` | no |
+| <a name="input_namespace"></a> [namespace](#input\_namespace) | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique | `string` | `null` | no |
+| <a name="input_regex_replace_chars"></a> [regex\_replace\_chars](#input\_regex\_replace\_chars) | Terraform regular expression (regex) string.<br>Characters matching the regex will be removed from the ID elements.<br>If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. | `string` | `null` | no |
+| <a name="input_reserved_concurrent_executions"></a> [reserved\_concurrent\_executions](#input\_reserved\_concurrent\_executions) | Amount of reserved concurrent executions for this lambda function. A value of 0 disables lambda from being triggered and -1 removes any concurrency limitations. Defaults to Unreserved Concurrency Limits -1 | `number` | `null` | no |
+| <a name="input_stage"></a> [stage](#input\_stage) | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | `string` | `null` | no |
+| <a name="input_tags"></a> [tags](#input\_tags) | Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).<br>Neither the tag keys nor the tag values will be modified by this module. | `map(string)` | `{}` | no |
+| <a name="input_tenant"></a> [tenant](#input\_tenant) | ID element \_(Rarely used, not included by default)\_. A customer identifier, indicating who this instance of a resource is for | `string` | `null` | no |
+| <a name="input_timeout"></a> [timeout](#input\_timeout) | Timeout ouf the lambda function in seconds. | `number` | `300` | no |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| <a name="output_function_arn"></a> [function\_arn](#output\_function\_arn) | ARN of the lambda function |
+| <a name="output_function_name"></a> [function\_name](#output\_function\_name) | Name of the lambda function |
+| <a name="output_iam_role_name"></a> [iam\_role\_name](#output\_iam\_role\_name) | IAM role name used to execute the function |
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

data.tf

@@ -0,0 +1,5 @@
+data "aws_iam_policy" "lambda_insights" {
+  count = var.insights_enable ? 1 : 0
+
+  name = "CloudWatchLambdaInsightsExecutionRolePolicy"
+}

examples/basic/main.tf

@@ -0,0 +1,14 @@
+module "example" {
+  source = "../.."
+
+  namespace                = "ns"
+  environment              = "env"
+  stage                    = "st"
+  name                     = "app"
+  attributes               = ["foo"]
+  aws_account_id           = "1234567890101"
+  aws_region               = "eu-central-1"
+  container_image_tag      = "latest"
+  alarm_create             = false
+  container_repository_url = "123456789012.dkr.ecr.us-east-1.amazonaws.com/hello-world"
+}

examples/basic/providers.tf

@@ -0,0 +1,3 @@
+provider "aws" {
+  region = "eu-central-1"
+}

examples/basic/versions.tf

@@ -0,0 +1,10 @@
+terraform {
+  required_providers {
+    aws = {
+      source  = "hashicorp/aws"
+      version = "4.45.0"
+    }
+  }
+
+  required_version = ">= 1.3.7"
+}

examples/full/main.tf

@@ -0,0 +1,61 @@
+# tflint-ignore: aws_resource_missing_tags
+resource "aws_sns_topic" "alarm" {
+  name = "foo-alarm-topic"
+}
+
+module "example" {
+  source = "../.."
+
+  namespace   = "ns"
+  environment = "env"
+  stage       = "st"
+  name        = "app"
+  attributes  = ["foo"]
+  label_orders = {
+    cloudwatch = ["environment", "stage", "name", "attributes"]
+    iam        = ["environment", "stage", "name", "attributes"]
+    lambda     = ["environment", "stage", "name", "attributes"]
+    sqs        = ["stage", "name", "attributes"]
+  }
+
+  alarm_create = true
+  alarm_backlog = {
+    minutes             = 5
+    datapoints_to_alarm = 5
+    evaluation_periods  = 5
+    period              = 300
+    threshold           = 1
+  }
+  alarm_errors = {
+    datapoints_to_alarm = 9
+    evaluation_periods  = 10
+    period              = 300
+    threshold           = 1
+  }
+  alarm_success_rate = {
+    datapoints_to_alarm = 9
+    evaluation_periods  = 10
+    period              = 300
+    threshold           = 1
+  }
+  alarm_throttles = {
+    datapoints_to_alarm = 9
+    evaluation_periods  = 10
+    period              = 300
+    threshold           = 1
+  }
+  alarm_topic_arn          = aws_sns_topic.alarm.arn
+  architectures            = ["x86_64"]
+  aws_account_id           = "1234567890101"
+  aws_region               = "eu-central-1"
+  container_image_tag      = "latest"
+  container_repository_url = "123456789012.dkr.ecr.us-east-1.amazonaws.com/hello-world"
+  dead_letter_queue_create = true
+  environment_variables = {
+    foo = "bar"
+  }
+  insights_enable                = true
+  memory_size                    = 256
+  reserved_concurrent_executions = 10
+  timeout                        = 60
+}

examples/full/providers.tf

@@ -0,0 +1,3 @@
+provider "aws" {
+  region = "eu-central-1"
+}

examples/full/versions.tf

@@ -0,0 +1,10 @@
+terraform {
+  required_providers {
+    aws = {
+      source  = "hashicorp/aws"
+      version = "4.45.0"
+    }
+  }
+
+  required_version = ">= 1.3.7"
+}

label.tf

@@ -0,0 +1,31 @@
+module "cloudwatch_label" {
+  source  = "cloudposse/label/null"
+  version = "0.25.0"
+
+  context     = module.this.context
+  label_order = var.label_orders.cloudwatch
+}
+
+module "iam_label" {
+  source  = "cloudposse/label/null"
+  version = "0.25.0"
+
+  context     = module.this.context
+  label_order = var.label_orders.iam
+}
+
+module "lambda_label" {
+  source  = "cloudposse/label/null"
+  version = "0.25.0"
+
+  context     = module.this.context
+  label_order = var.label_orders.lambda
+}
+
+module "sqs_label" {
+  source  = "cloudposse/label/null"
+  version = "0.25.0"
+
+  context     = module.this.context
+  label_order = var.label_orders.sqs
+}