README.md
January 1, 2026 · View on GitHub
This component is responsible for provisioning an Elasticsearch cluster with built-in integrations with Kibana and Logstash.
Tip
👽 Use Atmos with Terraform
Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform.
Works with Github Actions, Atlantis, or Spacelift.
Watch demo of using Atmos with Terraform
Example of running
atmos to manage infrastructure from our Quick Start tutorial.
Usage
Stack Level: Regional
Here's an example snippet for how to use this component.
components:
terraform:
elasticsearch:
vars:
enabled: true
name: foobar
instance_type: "t3.medium.elasticsearch"
elasticsearch_version: "7.9"
encrypt_at_rest_enabled: true
dedicated_master_enabled: false
elasticsearch_subdomain_name: "es"
kibana_subdomain_name: "kibana"
ebs_volume_size: 40
create_iam_service_linked_role: true
kibana_hostname_enabled: true
domain_hostname_enabled: true
Important
In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.
Requirements
| Name | Version |
|---|---|
| terraform | >= 1.0.0 |
| aws | >= 4.9.0, < 6.0.0 |
| random | >= 3.0 |
Providers
| Name | Version |
|---|---|
| aws | >= 4.9.0, < 6.0.0 |
| random | >= 3.0 |
Modules
| Name | Source | Version |
|---|---|---|
| dns_delegated | cloudposse/stack-config/yaml//modules/remote-state | 1.8.0 |
| elasticsearch | cloudposse/elasticsearch/aws | 2.1.0 |
| elasticsearch_log_cleanup | cloudposse/lambda-elasticsearch-cleanup/aws | 0.16.1 |
| iam_roles | ../account-map/modules/iam-roles | n/a |
| this | cloudposse/label/null | 0.25.0 |
| vpc | cloudposse/stack-config/yaml//modules/remote-state | 1.8.0 |
Resources
Inputs
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| additional_tag_map | Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.This is for some rare cases where resources want additional configuration of tags and therefore take a list of maps with tag key, value, and additional configuration. | map(string) | {} | no |
| advanced_security_options_anonymous_auth_enabled | Whether Anonymous auth is enabled. Enables fine-grained access control on an existing domain | bool | false | no |
| advanced_security_options_enabled | AWS Elasticsearch Kibana enhanced security plugin enabling (forces new resource) | bool | true | no |
| advanced_security_options_internal_user_database_enabled | Whether to enable or not internal Kibana user database for ELK OpenDistro security plugin | bool | true | no |
| advanced_security_options_master_user_name | Master user username (applicable if advanced_security_options_internal_user_database_enabled set to true) | string | "admin" | no |
| attributes | ID element. Additional attributes (e.g. workers or cluster) to add to id,in the order they appear in the list. New attributes are appended to the end of the list. The elements of the list are joined by the delimiterand treated as a single ID element. | list(string) | [] | no |
| aws_service_type | The type of AWS service to deploy (elasticsearch or opensearch). | string | "elasticsearch" | no |
| cold_storage_enabled | Enables cold storage support. | bool | false | 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 |
| create_iam_service_linked_role | Whether to create AWSServiceRoleForAmazonElasticsearchService service-linked role.Set this to false if you already have an ElasticSearch cluster created in the AWS account and AWSServiceRoleForAmazonElasticsearchService already exists.See https://github.com/terraform-providers/terraform-provider-aws/issues/5218 for more information. | bool | n/a | yes |
| dedicated_master_count | Number of dedicated master nodes in the cluster | number | 0 | no |
| dedicated_master_enabled | Indicates whether dedicated master nodes are enabled for the cluster | bool | n/a | yes |
| dedicated_master_type | Instance type of the dedicated master nodes in the cluster | string | "t2.small.elasticsearch" | no |
| delimiter | Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all. | string | null | no |
| descriptor_formats | Describe additional descriptors to be output in the descriptors output map.Map of maps. Keys are names of descriptors. Values are maps of the form {<br/> format = string<br/> labels = list(string)<br/>}(Type is any so the map values can later be enhanced to provide additional options.)format is a Terraform format string to be passed to the format() function.labels is a list of labels, in order, to pass to format() function.Label values will be normalized before being passed to format() so they will beidentical to how they appear in id.Default is {} (descriptors output will be empty). | any | {} | no |
| dns_delegated_environment_name | The name of the environment where the dns-delegated component is deployed | string | "gbl" | no |
| domain_hostname_enabled | Explicit flag to enable creating a DNS hostname for ES. If true, then var.dns_zone_id is required. | bool | n/a | yes |
| ebs_volume_size | EBS volumes for data storage in GB | number | n/a | yes |
| elasticsearch_domain_name | The name of the Elasticsearch domain. Must be at least 3 and no more than 28 characters long. Valid characters are a-z (lowercase letters), 0-9, and - (hyphen). | string | "" | no |
| elasticsearch_iam_actions | List of actions to allow for the IAM roles, e.g. es:ESHttpGet, es:ESHttpPut, es:ESHttpPost | list(string) | [ | no |
| elasticsearch_iam_role_arns | List of additional IAM role ARNs to permit access to the Elasticsearch domain | list(string) | [] | no |
| elasticsearch_log_cleanup_enabled | Whether to enable Elasticsearch log cleanup Lambda | bool | true | no |
| elasticsearch_password | Password for the elasticsearch user | string | "" | no |
| elasticsearch_saml_options | Manages SAML authentication options for an AWS OpenSearch Domain enabled: Whether to enable SAML authentication for the OpenSearch Domain entity_id: The entity ID of the IdP metadata_content: The metadata of the IdP | object({ | {} | no |
| elasticsearch_subdomain_name | The name of the subdomain for Elasticsearch in the DNS zone (_e.g._ elasticsearch, ui, ui-es, search-ui) | string | n/a | yes |
| elasticsearch_version | Version of Elasticsearch or Opensearch to deploy (_e.g._ 7.1, 6.8, 6.7, 6.5, 6.4, 6.3, 6.2, 6.0, 5.6, 5.5, 5.3, 5.1, 2.3, 1.5 | string | n/a | yes |
| enabled | Set to false to prevent the module from creating any resources | bool | null | no |
| encrypt_at_rest_enabled | Whether to enable encryption at rest | bool | n/a | yes |
| environment | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | string | null | no |
| id_length_limit | Limit id to this many characters (minimum 6).Set to 0 for unlimited length.Set to null for keep the existing setting, which defaults to 0.Does not affect id_full. | number | null | no |
| instance_type | The type of the instance | string | n/a | yes |
| kibana_hostname_enabled | Explicit flag to enable creating a DNS hostname for Kibana. If true, then var.dns_zone_id is required. | bool | n/a | yes |
| kibana_subdomain_name | The name of the subdomain for Kibana in the DNS zone (_e.g._ kibana, ui, ui-es, search-ui, kibana.elasticsearch) | string | null | no |
| label_key_case | Controls the letter case of the tags keys (label names) for tags generated by this module.Does not affect keys of tags passed in via the tags input.Possible values: lower, title, upper.Default value: title. | string | null | no |
| label_order | The order in which the labels (ID elements) appear in the id.Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. | list(string) | null | no |
| label_value_case | Controls the letter case of ID elements (labels) as included in id,set as tag values, and output by this module individually. Does not affect values of tags passed in via the tags input.Possible values: lower, title, upper and none (no transformation).Set this to title and set delimiter to "" to yield Pascal Case IDs.Default value: lower. | string | null | no |
| labels_as_tags | Set of labels (ID elements) to include as tags in the tags output.Default is to include all labels. Tags with empty values will not be included in the tags output.Set to [] to suppress all generated tags.Notes: The value of the name tag, if included, will be the id, not the name.Unlike other null-label inputs, the initial setting of labels_as_tags cannot bechanged in later chained modules. Attempts to change it will be silently ignored. | set(string) | [ | no |
| name | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. This is the only ID element not also included as a tag.The "name" tag is set to the full id string. There is no tag with the value of the name input. | string | null | no |
| 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 |
| node_to_node_encryption_enabled | Whether to enable node-to-node encryption | bool | true | no |
| regex_replace_chars | Terraform regular expression (regex) string. Characters matching the regex will be removed from the ID elements. If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits. | string | null | no |
| region | AWS region | string | n/a | yes |
| stage | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | string | null | no |
| tags | Additional tags (e.g. {'BusinessUnit': 'XYZ'}).Neither the tag keys nor the tag values will be modified by this module. | map(string) | {} | no |
| tenant | ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for | string | null | no |
Outputs
| Name | Description |
|---|---|
| domain_arn | ARN of the Elasticsearch domain |
| domain_endpoint | Domain-specific endpoint used to submit index, search, and data upload requests |
| domain_hostname | Elasticsearch domain hostname to submit index, search, and data upload requests |
| domain_id | Unique identifier for the Elasticsearch domain |
| domain_name | Name of the Elasticsearch domain |
| elasticsearch_user_iam_role_arn | The ARN of the IAM role to allow access to Elasticsearch cluster |
| elasticsearch_user_iam_role_name | The name of the IAM role to allow access to Elasticsearch cluster |
| kibana_endpoint | Domain-specific endpoint for Kibana without https scheme |
| kibana_hostname | Kibana hostname |
| master_password_ssm_key | SSM key of Elasticsearch master password |
| security_group_id | Security Group ID to control access to the Elasticsearch domain |
Related Projects
Check out these related projects.
- Cloud Posse Terraform Modules - Our collection of reusable Terraform modules used by our reference architectures.
- Atmos - Atmos is like docker-compose but for your infrastructure
References
For additional context, refer to some of these links.
- cloudposse-terraform-components - Cloud Posse's upstream component
Tip
Use Terraform Reference Architectures for AWS
Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.
✅ We build it together with your team.
✅ Your team owns everything.
✅ 100% Open Source and backed by fanatical support.
📚 Learn More
Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.
Your team can operate like a pro today.
Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.
Day-0: Your Foundation for Success
- Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
- Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
- Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
- Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
- GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.
Day-2: Your Operational Mastery
- Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
- Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
- Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
- Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
- Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
- Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
- Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.
✨ Contributing
This project is under active development, and we encourage contributions from our community.
Many thanks to our outstanding contributors:
For 🐛 bug reports & feature requests, please use the issue tracker.
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
- Review our Code of Conduct and Contributor Guidelines.
- 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!
Running Terraform Tests
We use Atmos to streamline how Terraform tests are run. It centralizes configuration and wraps common test workflows with easy-to-use commands.
All tests are located in the test/ folder.
Under the hood, tests are powered by Terratest together with our internal Test Helpers library, providing robust infrastructure validation.
Setup dependencies:
- Install Atmos (installation guide)
- Install Go 1.24+ or newer
- Install Terraform or OpenTofu
To run tests:
- Run all tests:
atmos test run - Clean up test artifacts:
atmos test clean - Explore additional test options:
atmos test --help
The configuration for test commands is centrally managed. To review what's being imported, see the atmos.yaml file.
Learn more about our automated testing in our documentation or implementing custom commands with atmos.
🌎 Slack Community
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.
📰 Newsletter
Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.
📆 Office Hours 
Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!
License
Preamble to the Apache License, Version 2.0
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.
Trademarks
All other trademarks referenced herein are the property of their respective owners.
Copyright © 2017-2026 Cloud Posse, LLC