You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Security scanning is graciously provided by Bridgecrew. Bridgecrew is the leading fully hosted, cloud-native solution providing continuous Terraform security and compliance.
|[aws_iam_policy_document.assume_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document)| data source |
217
+
|[aws_iam_policy_document.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document)| data source |
218
+
|[aws_iam_policy_document.es_logs](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document)| data source |
219
+
|[aws_iam_policy_document.sns](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document)| data source |
192
220
193
221
## Inputs
194
222
195
223
| Name | Description | Type | Default | Required |
| additional\_tag\_map | Additional tags for appending to tags\_as\_list\_of\_maps. Not added to `tags`. |`map(string)`|`{}`| no |
198
-
| artifact\_git\_ref | Git ref of the lambda artifact to use. Use latest version if null. |`string`|`""`| no |
199
-
| artifact\_url | URL template for the remote artifact |`string`|`"https://artifacts.cloudposse.com/$${module_name}/$${git_ref}/$${filename}"`| no |
200
-
| attributes | Additional attributes (e.g. `1`) |`list(string)`|`[]`| no |
201
-
| 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> "enabled": true,<br> "environment": null,<br> "id_length_limit": null,<br> "label_key_case": null,<br> "label_order": [],<br> "label_value_case": null,<br> "name": null,<br> "namespace": null,<br> "regex_replace_chars": null,<br> "stage": null,<br> "tags": {}<br>}</pre> | no |
202
-
| delete\_after | Number of days to preserve |`number`|`15`| no |
203
-
| delimiter | Delimiter to be used between `namespace`, `environment`, `stage`, `name` and `attributes`.<br>Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. |`string`|`null`| no |
204
-
| enabled | Set to false to prevent the module from creating any resources |`bool`|`null`| no |
205
-
| environment | Environment, e.g. 'uw2', 'us-west-2', OR 'prod', 'staging', 'dev', 'UAT' |`string`|`null`| no |
| es\_endpoint | The Elasticsearch endpoint for the Lambda function to connect to |`string`| n/a | yes |
208
-
| es\_security\_group\_id | The Elasticsearch cluster security group ID |`string`| n/a | yes |
209
-
| id\_length\_limit | Limit `id` to this many characters (minimum 6).<br>Set to `0` for unlimited length.<br>Set to `null` for default, which is `0`.<br>Does not affect `id_full`. |`number`|`null`| no |
210
-
| index\_format | Combined with 'index' variable and is used to evaluate the index age |`string`|`"%Y.%m.%d"`| no |
211
-
| index\_re | Regular Expression that matches the index names to clean up (not including trailing dash and date) |`string`|`".*"`| no |
212
-
| label\_key\_case | The letter case of label keys (`tag` names) (i.e. `name`, `namespace`, `environment`, `stage`, `attributes`) to use in `tags`.<br>Possible values: `lower`, `title`, `upper`.<br>Default value: `title`. |`string`|`null`| no |
213
-
| label\_order | The naming order of the id output and Name tag.<br>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br>You can omit any of the 5 elements, but at least one must be present. |`list(string)`|`null`| no |
214
-
| label\_value\_case | The letter case of output label values (also used in `tags` and `id`).<br>Possible values: `lower`, `title`, `upper` and `none` (no transformation).<br>Default value: `lower`. |`string`|`null`| no |
215
-
| name | Solution name, e.g. 'app' or 'jenkins' |`string`|`null`| no |
216
-
| namespace | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' |`string`|`null`| no |
217
-
| python\_version | The Python version to use |`string`|`"3.7"`| no |
218
-
| regex\_replace\_chars | Regex to replace chars with empty string in `namespace`, `environment`, `stage` and `name`.<br>If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. |`string`|`null`| no |
219
-
| schedule | CloudWatch Events rule schedule using cron or rate expression |`string`|`"cron(0 3 * * ? *)"`| no |
220
-
| skip\_index\_re | Regular Expression that matches the index names to ignore (not clean up). Takes precedence over `index_re`.<br>BY DEFAULT (when value is `null`), a pattern is used to exclude Kibana indexes.<br>Use `"^$"` if you do not want to skip any indexes. Include an exclusion for `kibana` if you<br>want to use a custom value and also exclude the kibana indexes. |`string`|`null`| no |
221
-
| sns\_arn | SNS ARN to publish alerts |`string`|`""`| no |
222
-
| stage | Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' |`string`|`null`| no |
| tags | Additional tags (e.g. `map('BusinessUnit','XYZ')`|`map(string)`|`{}`| no |
225
-
| timeout | Timeout for Lambda function in seconds |`number`|`300`| no |
226
-
| vpc\_id | The VPC ID for the Lambda function |`string`| n/a | yes |
225
+
|<aname="input_additional_tag_map"></a> [additional\_tag\_map](#input\_additional\_tag\_map)| Additional tags for appending to tags\_as\_list\_of\_maps. Not added to `tags`. |`map(string)`|`{}`| no |
226
+
|<aname="input_artifact_git_ref"></a> [artifact\_git\_ref](#input\_artifact\_git\_ref)| Git ref of the lambda artifact to use. Use latest version if null. |`string`|`""`| no |
227
+
|<aname="input_artifact_url"></a> [artifact\_url](#input\_artifact\_url)| URL template for the remote artifact |`string`|`"https://artifacts.cloudposse.com/$${module_name}/$${git_ref}/$${filename}"`| no |
228
+
|<aname="input_attributes"></a> [attributes](#input\_attributes)| Additional attributes (e.g. `1`) |`list(string)`|`[]`| no |
229
+
|<aname="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> "enabled": true,<br> "environment": null,<br> "id_length_limit": null,<br> "label_key_case": null,<br> "label_order": [],<br> "label_value_case": null,<br> "name": null,<br> "namespace": null,<br> "regex_replace_chars": null,<br> "stage": null,<br> "tags": {}<br>}</pre> | no |
230
+
|<aname="input_delete_after"></a> [delete\_after](#input\_delete\_after)| Number of days to preserve |`number`|`15`| no |
231
+
|<aname="input_delimiter"></a> [delimiter](#input\_delimiter)| Delimiter to be used between `namespace`, `environment`, `stage`, `name` and `attributes`.<br>Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. |`string`|`null`| no |
232
+
|<aname="input_enabled"></a> [enabled](#input\_enabled)| Set to false to prevent the module from creating any resources |`bool`|`null`| no |
233
+
|<aname="input_environment"></a> [environment](#input\_environment)| Environment, e.g. 'uw2', 'us-west-2', OR 'prod', 'staging', 'dev', 'UAT' |`string`|`null`| no |
|<aname="input_es_endpoint"></a> [es\_endpoint](#input\_es\_endpoint)| The Elasticsearch endpoint for the Lambda function to connect to |`string`| n/a | yes |
236
+
|<aname="input_es_security_group_id"></a> [es\_security\_group\_id](#input\_es\_security\_group\_id)| The Elasticsearch cluster security group ID |`string`| n/a | yes |
237
+
|<aname="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 default, which is `0`.<br>Does not affect `id_full`. |`number`|`null`| no |
238
+
|<aname="input_index_format"></a> [index\_format](#input\_index\_format)| Combined with 'index' variable and is used to evaluate the index age |`string`|`"%Y.%m.%d"`| no |
239
+
|<aname="input_index_re"></a> [index\_re](#input\_index\_re)| Regular Expression that matches the index names to clean up (not including trailing dash and date) |`string`|`".*"`| no |
240
+
|<aname="input_label_key_case"></a> [label\_key\_case](#input\_label\_key\_case)| The letter case of label keys (`tag` names) (i.e. `name`, `namespace`, `environment`, `stage`, `attributes`) to use in `tags`.<br>Possible values: `lower`, `title`, `upper`.<br>Default value: `title`. |`string`|`null`| no |
241
+
|<aname="input_label_order"></a> [label\_order](#input\_label\_order)| The naming order of the id output and Name tag.<br>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br>You can omit any of the 5 elements, but at least one must be present. |`list(string)`|`null`| no |
242
+
|<aname="input_label_value_case"></a> [label\_value\_case](#input\_label\_value\_case)| The letter case of output label values (also used in `tags` and `id`).<br>Possible values: `lower`, `title`, `upper` and `none` (no transformation).<br>Default value: `lower`. |`string`|`null`| no |
243
+
|<aname="input_name"></a> [name](#input\_name)| Solution name, e.g. 'app' or 'jenkins' |`string`|`null`| no |
244
+
|<aname="input_namespace"></a> [namespace](#input\_namespace)| Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' |`string`|`null`| no |
245
+
|<aname="input_python_version"></a> [python\_version](#input\_python\_version)| The Python version to use |`string`|`"3.7"`| no |
246
+
|<aname="input_regex_replace_chars"></a> [regex\_replace\_chars](#input\_regex\_replace\_chars)| Regex to replace chars with empty string in `namespace`, `environment`, `stage` and `name`.<br>If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. |`string`|`null`| no |
247
+
|<aname="input_schedule"></a> [schedule](#input\_schedule)| CloudWatch Events rule schedule using cron or rate expression |`string`|`"cron(0 3 * * ? *)"`| no |
248
+
|<aname="input_skip_index_re"></a> [skip\_index\_re](#input\_skip\_index\_re)| Regular Expression that matches the index names to ignore (not clean up). Takes precedence over `index_re`.<br>BY DEFAULT (when value is `null`), a pattern is used to exclude Kibana indexes.<br>Use `"^$"` if you do not want to skip any indexes. Include an exclusion for `kibana` if you<br>want to use a custom value and also exclude the kibana indexes. |`string`|`null`| no |
249
+
|<aname="input_sns_arn"></a> [sns\_arn](#input\_sns\_arn)| SNS ARN to publish alerts |`string`|`""`| no |
250
+
|<aname="input_stage"></a> [stage](#input\_stage)| Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' |`string`|`null`| no |
|<aname="input_tags"></a> [tags](#input\_tags)| Additional tags (e.g. `map('BusinessUnit','XYZ')`|`map(string)`|`{}`| no |
253
+
|<aname="input_timeout"></a> [timeout](#input\_timeout)| Timeout for Lambda function in seconds |`number`|`300`| no |
254
+
|<aname="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id)| The VPC ID for the Lambda function |`string`| n/a | yes |
227
255
228
256
## Outputs
229
257
230
258
| Name | Description |
231
259
|------|-------------|
232
-
| lambda\_function\_arn | ARN of the Lambda Function |
233
-
| lambda\_function\_source\_code\_size | The size in bytes of the function .zip file |
234
-
| security\_group\_id | Security Group ID of the Lambda Function |
235
-
260
+
| <aname="output_lambda_function_arn"></a> [lambda\_function\_arn](#output\_lambda\_function\_arn)| ARN of the Lambda Function |
261
+
| <aname="output_lambda_function_source_code_size"></a> [lambda\_function\_source\_code\_size](#output\_lambda\_function\_source\_code\_size)| The size in bytes of the function .zip file |
262
+
| <aname="output_security_group_id"></a> [security\_group\_id](#output\_security\_group\_id)| Security Group ID of the Lambda Function |
236
263
<!-- markdownlint-restore -->
237
264
238
265
@@ -244,6 +271,7 @@ Like this project? Please give it a ★ on [our GitHub](https://github.com/cloud
244
271
Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =)
245
272
246
273
274
+
247
275
## Related Projects
248
276
249
277
Check out these related projects.
@@ -252,8 +280,6 @@ Check out these related projects.
252
280
-[terraform-aws-dynamic-subnets](https://github.com/cloudposse/terraform-aws-dynamic-subnets) - Terraform module for dynamic subnets provisioning.
253
281
-[terraform-aws-elasticsearch](https://github.com/cloudposse/terraform-aws-elasticsearch) - Terraform module for AWS Elasticsearch provisioning.
0 commit comments