Skip to main content

Component: elasticsearch

This component is responsible for provisioning an Elasticsearch cluster with built-in integrations with Kibana and Logstash.


Stack Level: Regional

Here's an example snippet for how to use this component.

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


terraform>= 1.0.0
aws>= 4.9.0
random>= 3.0


aws>= 4.9.0
random>= 3.0






additional_tag_mapAdditional 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.
attributesID 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 delimiter
and treated as a single ID element.
contextSingle 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.
"additional_tag_map": {},
"attributes": [],
"delimiter": null,
"descriptor_formats": {},
"enabled": true,
"environment": null,
"id_length_limit": null,
"label_key_case": null,
"label_order": [],
"label_value_case": null,
"labels_as_tags": [
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
create_iam_service_linked_roleWhether 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 for more information.
dedicated_master_countNumber of dedicated master nodes in the clusternumber0no
dedicated_master_enabledIndicates whether dedicated master nodes are enabled for the clusterbooln/ayes
dedicated_master_typeInstance type of the dedicated master nodes in the clusterstring"t2.small.elasticsearch"no
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
descriptor_formatsDescribe 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 be
identical to how they appear in id.
Default is {} (descriptors output will be empty).
dns_delegated_environment_nameThe name of the environment where the dns-delegated component is deployedstring"gbl"no
domain_hostname_enabledExplicit flag to enable creating a DNS hostname for ES. If true, then var.dns_zone_id is required.booln/ayes
ebs_volume_sizeEBS volumes for data storage in GBnumbern/ayes
elasticsearch_iam_actionsList of actions to allow for the IAM roles, e.g. es:ESHttpGet, es:ESHttpPut, es:ESHttpPostlist(string)
elasticsearch_iam_role_arnsList of additional IAM role ARNs to permit access to the Elasticsearch domainlist(string)[]no
elasticsearch_passwordPassword for the elasticsearch userstring""no
elasticsearch_subdomain_nameThe name of the subdomain for Elasticsearch in the DNS zone (_e.g._ elasticsearch, ui, ui-es, search-ui)stringn/ayes
elasticsearch_versionVersion of Elasticsearch 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.5stringn/ayes
enabledSet to false to prevent the module from creating any resourcesboolnullno
encrypt_at_rest_enabledWhether to enable encryption at restbooln/ayes
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
id_length_limitLimit 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.
instance_typeThe type of the instancestringn/ayes
kibana_hostname_enabledExplicit flag to enable creating a DNS hostname for Kibana. If true, then var.dns_zone_id is required.booln/ayes
kibana_subdomain_nameThe name of the subdomain for Kibana in the DNS zone (_e.g._ kibana, ui, ui-es, search-ui, kibana.elasticsearch)stringn/ayes
label_key_caseControls 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.
label_orderThe 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.
label_value_caseControls 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.
labels_as_tagsSet 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.
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 be
changed in later chained modules. Attempts to change it will be silently ignored.
nameID 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.
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
regex_replace_charsTerraform 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.
regionAWS regionstringn/ayes
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno


domain_arnARN of the Elasticsearch domain
domain_endpointDomain-specific endpoint used to submit index, search, and data upload requests
domain_hostnameElasticsearch domain hostname to submit index, search, and data upload requests
domain_idUnique identifier for the Elasticsearch domain
elasticsearch_user_iam_role_arnThe ARN of the IAM role to allow access to Elasticsearch cluster
elasticsearch_user_iam_role_nameThe name of the IAM role to allow access to Elasticsearch cluster
kibana_endpointDomain-specific endpoint for Kibana without https scheme
kibana_hostnameKibana hostname
master_password_ssm_keySSM key of Elasticsearch master password
security_group_idSecurity Group ID to control access to the Elasticsearch domain