Terraform module to provision a scheduled Lambda function which will delete old Elasticsearch indexes using SigV4Auth authentication. The lambda function can optionally send output to an SNS topic if the topic ARN is given. This module was largely inspired by aws-lambda-es-cleanup
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!
Security scanning is graciously provided by Bridgecrew. Bridgecrew is the leading fully hosted, cloud-native solution providing continuous Terraform security and compliance.
| Benchmark | Description |
|---|---|
| Infrastructure Security Compliance | |
| Center for Internet Security, KUBERNETES Compliance | |
| Center for Internet Security, AWS Compliance | |
| Center for Internet Security, AZURE Compliance | |
| Payment Card Industry Data Security Standards Compliance | |
| National Institute of Standards and Technology Compliance | |
| Information Security Management System, ISO/IEC 27001 Compliance | |
| Service Organization Control 2 Compliance | |
| Center for Internet Security, GCP Compliance | |
| Health Insurance Portability and Accountability Compliance |
IMPORTANT: We do not pin modules to versions in our examples because of the difficulty of keeping the versions in the documentation in sync with the latest released versions. We highly recommend that in your code you pin the version to the exact version you are using so that your infrastructure remains stable, and update versions in a systematic way so that they do not catch you by surprise.
Also, because of a bug in the Terraform registry (hashicorp/terraform#21417), the registry shows many of our inputs as required when in fact they are optional. The table below correctly indicates which inputs are required.
For a complete example, see examples/complete.
For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test.
module "elasticsearch_cleanup" { source = "https://github.com/cloudposse/terraform-aws-lambda-elasticsearch-cleanup.git?ref=master" es_endpoint = module.elasticsearch.domain_endpoint es_domain_arn = module.elasticsearch.domain_arn es_security_group_id = module.elasticsearch.security_group_id vpc_id = module.vpc.vpc_id namespace = "eg" stage = "dev" schedule = "cron(0 3 * * ? *)" }Indexes are expected to be in the format name-date where date is in the format specified by var.index_format. By default, all indexes except for the ones added by Kibana will be deleted based on the date part of the full index name. The actual creation date of the index is not used.
Index matching is done with unanchored regular expresssion, so "bar" matches index "foobarbaz".
- If the full index name, including the date part, matches
skip_index_re, then the index will be skipped (never deleted). Kibana indexes are skipped by the defaultskip_index_reof^\.kibana*so if you specify a value forskip_index_reyou must include the Kibana exception in your regex if you want it excepted. (Since Kibana indexes do not have a date part, this module should not delete them, but will complain about them having malformed dates if they are not excluded.) - If the index name without the trailing
-datepart matchesindex_re, then it will be cleaned up according to the date part.
Keep in mind that, fundamentally, this module expects indexes to be in the format of name-date so it will not work properly if the regexes end up selecting an index that does not end with -date. To avoid edge cases, it is wise not to include dashes in your index name or date format.
Prior to version 0.10.0, this moudle had inputs index, which was a comma-separated list of index names or the special name "all" to indicate all but Kibana indexes, and index_regex, which was a regular expression for parsing index name and date parts. There was no mechanism for specifying a list of indexes to exclude. Starting with version 0.10.0 this module drops those inputs and instead takes index_re and skip_index_re, both of which are regular expressions. (You probably want to anchor your regexes to the beginning of the index name by starting with ^).
| If you previously had | Now use |
|---|---|
index = "all" | Default values for index_re and skip_index_re |
index = "a,xb,c0" | index_re = "^(a|xb|c0)" and skip_index_re = "^$" |
index_regex = "(ipat)-(dpat)" | index_re = "ipat" and be sure index_format is correct for your date format |
Available targets: build Build Lambda function zip dependencies Install dependencies help Help screen help/all Display help for all targets help/short This help short screen lint Lint terraform code This module creates a scheduled Lambda function which will delete old Elasticsearch indexes using SigV4Auth authentication. The lambda function can optionally send output to an SNS topic if the topic ARN is given
| Name | Version |
|---|---|
| terraform | >= 0.13.0 |
| aws | >= 2.0 |
| null | >= 2.0 |
| Name | Version |
|---|---|
| aws | >= 2.0 |
| Name | Source | Version |
|---|---|---|
| artifact | cloudposse/module-artifact/external | 0.7.1 |
| label | cloudposse/label/null | 0.25.0 |
| this | cloudposse/label/null | 0.24.1 |
| Name | Type |
|---|---|
| aws_cloudwatch_event_rule.default | resource |
| aws_cloudwatch_event_target.default | resource |
| aws_iam_role.default | resource |
| aws_iam_role_policy.default | resource |
| aws_iam_role_policy_attachment.default | resource |
| aws_lambda_function.default | resource |
| aws_lambda_permission.default | resource |
| aws_security_group.default | resource |
| aws_security_group_rule.egress_from_lambda_to_es_cluster | resource |
| aws_security_group_rule.ingress_to_es_cluster_from_lambda | resource |
| aws_security_group_rule.tcp_dns_egress_from_lambda | resource |
| aws_security_group_rule.udp_dns_egress_from_lambda | resource |
| aws_iam_policy_document.assume_role | data source |
| aws_iam_policy_document.default | data source |
| aws_iam_policy_document.es_logs | data source |
| aws_iam_policy_document.sns | data source |
| 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 |
| artifact_git_ref | Git ref of the lambda artifact to use. Use latest version if null. | string | "" | no |
| artifact_url | URL template for the remote artifact | string | "https://artifacts.cloudposse.com/$${module_name}/$${git_ref}/$${filename}" | no |
| attributes | Additional attributes (e.g. 1) | list(string) | [] | no |
| context | Single object for setting entire context at once. See description of individual variables for details. Leave string and numeric variables as null to use default value.Individual variable settings (non-null) override settings in context object, except for attributes, tags, and additional_tag_map, which are merged. | any | { | no |
| delete_after | Number of days to preserve | number | 15 | no |
| delimiter | Delimiter to be used between namespace, environment, stage, name and attributes.Defaults to - (hyphen). Set to "" to use no delimiter at all. | string | null | no |
| enabled | Set to false to prevent the module from creating any resources | bool | null | no |
| environment | Environment, e.g. 'uw2', 'us-west-2', OR 'prod', 'staging', 'dev', 'UAT' | string | null | no |
| es_domain_arn | The Elasticsearch domain ARN | string | n/a | yes |
| es_endpoint | The Elasticsearch endpoint for the Lambda function to connect to | string | n/a | yes |
| es_security_group_id | The Elasticsearch cluster security group ID | string | n/a | yes |
| id_length_limit | Limit id to this many characters (minimum 6).Set to 0 for unlimited length.Set to null for default, which is 0.Does not affect id_full. | number | null | no |
| index_format | Combined with 'index' variable and is used to evaluate the index age | string | "%Y.%m.%d" | no |
| index_re | Regular Expression that matches the index names to clean up (not including trailing dash and date) | string | ".*" | no |
| label_key_case | The letter case of label keys (tag names) (i.e. name, namespace, environment, stage, attributes) to use in tags.Possible values: lower, title, upper.Default value: title. | string | null | no |
| label_order | The naming order of the id output and Name tag. Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 5 elements, but at least one must be present. | list(string) | null | no |
| label_value_case | The letter case of output label values (also used in tags and id).Possible values: lower, title, upper and none (no transformation).Default value: lower. | string | null | no |
| name | Solution name, e.g. 'app' or 'jenkins' | string | null | no |
| namespace | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' | string | null | no |
| python_version | The Python version to use | string | "3.7" | no |
| regex_replace_chars | Regex to replace chars with empty string in namespace, environment, stage and name.If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits. | string | null | no |
| schedule | CloudWatch Events rule schedule using cron or rate expression | string | "cron(0 3 * * ? *)" | no |
| skip_index_re | Regular Expression that matches the index names to ignore (not clean up). Takes precedence over index_re.BY DEFAULT (when value is null), a pattern is used to exclude Kibana indexes.Use "^$" if you do not want to skip any indexes. Include an exclusion for kibana if youwant to use a custom value and also exclude the kibana indexes. | string | null | no |
| sns_arn | SNS ARN to publish alerts | string | "" | no |
| stage | Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' | string | null | no |
| subnet_ids | Subnet IDs | list(string) | n/a | yes |
| tags | Additional tags (e.g. map('BusinessUnit','XYZ') | map(string) | {} | no |
| timeout | Timeout for Lambda function in seconds | number | 300 | no |
| vpc_id | The VPC ID for the Lambda function | string | n/a | yes |
| Name | Description |
|---|---|
| lambda_function_arn | ARN of the Lambda Function |
| lambda_function_source_code_size | The size in bytes of the function .zip file |
| security_group_id | Security Group ID of the Lambda Function |
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-vpc - Terraform Module that defines a VPC with public/private subnets across multiple AZs with Internet Gateways
- terraform-aws-dynamic-subnets - Terraform module for dynamic subnets provisioning.
- terraform-aws-elasticsearch - Terraform module for AWS Elasticsearch provisioning.
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-2021 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.
 Josh Myers |  Erik Osterman |  Andriy Knysh |  Igor Rodionov |  Marcin Brański |
|---|