docs: Updated required versions in README

terraform-aws-modules · Apr 13, 2020 · 53989e1 · 53989e1
1 parent f3d26ec
commit 53989e1
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -62,40 +62,46 @@ To run the tests:
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Requirements
 
-No requirements.
+| Name | Version |
+|------|---------|
+| terraform | ~> 0.12.6 |
+| aws | ~> 2.35 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
 | archive | n/a |
-| aws | n/a |
+| aws | ~> 2.35 |
 | null | n/a |
 
 ## Inputs
 
 | Name | Description | Type | Default | Required |
-|------|-------------|:----:|:-----:|:-----:|
-| cloudwatch\_log\_group\_kms\_key\_id | The ARN of the KMS Key to use when encrypting log data for Lambda | string | `"null"` | no |
-| cloudwatch\_log\_group\_retention\_in\_days | Specifies the number of days you want to retain log events in log group for Lambda. | number | `"0"` | no |
-| cloudwatch\_log\_group\_tags | Additional tags for the Cloudwatch log group | map(string) | `{}` | no |
-| create | Whether to create all resources | bool | `"true"` | no |
-| create\_sns\_topic | Whether to create new SNS topic | bool | `"true"` | no |
-| iam\_role\_tags | Additional tags for the IAM role | map(string) | `{}` | no |
-| iam\_role\_boundary\_policy\_arn | The ARN of the policy that is used to set the permissions boundary for the role | string | `null` | no |
-| kms\_key\_arn | ARN of the KMS key used for decrypting slack webhook url | string | `""` | no |
-| lambda\_description | The description of the Lambda function | string | `"null"` | no |
-| lambda\_function\_name | The name of the Lambda function to create | string | `"notify_slack"` | no |
-| lambda\_function\_tags | Additional tags for the Lambda function | map(string) | `{}` | no |
-| log\_events | Boolean flag to enabled/disable logging of incoming events | string | `"false"` | no |
-| reserved\_concurrent\_executions | The amount of reserved concurrent executions for this lambda function. A value of 0 disables lambda from being triggered and -1 removes any concurrency limitations | number | `"-1"` | no |
-| slack\_channel | The name of the channel in Slack for notifications | string | n/a | yes |
-| slack\_emoji | A custom emoji that will appear on Slack messages | string | `":aws:"` | no |
-| slack\_username | The username that will appear on Slack messages | string | n/a | yes |
-| slack\_webhook\_url | The URL of Slack webhook | string | n/a | yes |
-| sns\_topic\_name | The name of the SNS topic to create | string | n/a | yes |
-| sns\_topic\_tags | Additional tags for the SNS topic | map(string) | `{}` | no |
-| tags | A map of tags to add to all resources | map(string) | `{}` | no |
+|------|-------------|------|---------|:--------:|
+| cloudwatch\_log\_group\_kms\_key\_id | The ARN of the KMS Key to use when encrypting log data for Lambda | `string` | `null` | no |
+| cloudwatch\_log\_group\_retention\_in\_days | Specifies the number of days you want to retain log events in log group for Lambda. | `number` | `0` | no |
+| cloudwatch\_log\_group\_tags | Additional tags for the Cloudwatch log group | `map(string)` | `{}` | no |
+| create | Whether to create all resources | `bool` | `true` | no |
+| create\_sns\_topic | Whether to create new SNS topic | `bool` | `true` | no |
+| iam\_role\_boundary\_policy\_arn | The ARN of the policy that is used to set the permissions boundary for the role | `string` | `null` | no |
+| iam\_role\_name\_prefix | A unique role name beginning with the specified prefix | `string` | `"lambda"` | no |
+| iam\_role\_policy\_name\_prefix | A unique policy name beginning with the specified prefix | `string` | `"lambda-policy-"` | no |
+| iam\_role\_tags | Additional tags for the IAM role | `map(string)` | `{}` | no |
+| kms\_key\_arn | ARN of the KMS key used for decrypting slack webhook url | `string` | `""` | no |
+| lambda\_description | The description of the Lambda function | `string` | `null` | no |
+| lambda\_function\_name | The name of the Lambda function to create | `string` | `"notify_slack"` | no |
+| lambda\_function\_tags | Additional tags for the Lambda function | `map(string)` | `{}` | no |
+| log\_events | Boolean flag to enabled/disable logging of incoming events | `bool` | `false` | no |
+| reserved\_concurrent\_executions | The amount of reserved concurrent executions for this lambda function. A value of 0 disables lambda from being triggered and -1 removes any concurrency limitations | `number` | `-1` | no |
+| slack\_channel | The name of the channel in Slack for notifications | `string` | n/a | yes |
+| slack\_emoji | A custom emoji that will appear on Slack messages | `string` | `":aws:"` | no |
+| slack\_username | The username that will appear on Slack messages | `string` | n/a | yes |
+| slack\_webhook\_url | The URL of Slack webhook | `string` | n/a | yes |
+| sns\_topic\_name | The name of the SNS topic to create | `string` | n/a | yes |
+| sns\_topic\_tags | Additional tags for the SNS topic | `map(string)` | `{}` | no |
+| subsription\_filter\_policy | (Optional) A valid filter policy that will be used in the subscription to filter messages seen by the target resource. | `string` | `null` | no |
+| tags | A map of tags to add to all resources | `map(string)` | `{}` | no |
 
 ## Outputs
 

diff --git a/versions.tf b/versions.tf
@@ -0,0 +1,7 @@
+terraform {
+  required_version = "~> 0.12.6"
+
+  required_providers {
+    aws = "~> 2.35"
+  }
+}