elasticsearch

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

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

Variables

Required Variables

create_iam_service_linked_role (bool) required: 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.
dedicated_master_enabled (bool) required: Indicates whether dedicated master nodes are enabled for the cluster
domain_hostname_enabled (bool) required: Explicit flag to enable creating a DNS hostname for ES. If true, then var.dns_zone_id is required.
ebs_volume_size (number) required: EBS volumes for data storage in GB
elasticsearch_subdomain_name (string) required: The name of the subdomain for Elasticsearch in the DNS zone (e.g. elasticsearch, ui, ui-es, search-ui)
elasticsearch_version (string) required: Version 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.5
encrypt_at_rest_enabled (bool) required: Whether to enable encryption at rest
instance_type (string) required: The type of the instance
kibana_hostname_enabled (bool) required: Explicit flag to enable creating a DNS hostname for Kibana. If true, then var.dns_zone_id is required.
kibana_subdomain_name (string) required: The name of the subdomain for Kibana in the DNS zone (e.g. kibana, ui, ui-es, search-ui, kibana.elasticsearch)
region (string) required: AWS region

Optional Variables

dedicated_master_count (number) optional

Number of dedicated master nodes in the cluster

Default value: 0

dedicated_master_type (string) optional

Instance type of the dedicated master nodes in the cluster

Default value: "t2.small.elasticsearch"

dns_delegated_environment_name (string) optional

The name of the environment where the dns-delegated component is deployed

Default value: "gbl"

elasticsearch_iam_actions (list(string)) optional

List of actions to allow for the IAM roles, e.g. es:ESHttpGet, es:ESHttpPut, es:ESHttpPost

Default value:

[
  "es:ESHttpGet",
  "es:ESHttpPut",
  "es:ESHttpPost",
  "es:ESHttpHead",
  "es:Describe*",
  "es:List*"
]

elasticsearch_iam_role_arns (list(string)) optional

List of additional IAM role ARNs to permit access to the Elasticsearch domain

Default value: [ ]

elasticsearch_password (string) optional

Password for the elasticsearch user

Default value: ""

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

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.

Required: No

Default value: { }

attributes (list(string)) optional

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 delimiter
and treated as a single ID element.

Required: No

Default value: [ ]

context (any) optional

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.

Required: No

Default value:

{
  "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": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

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 be
identical to how they appear in id.
Default is {} (descriptors output will be empty).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

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.

Required: No

Default value: null

label_key_case (string) optional

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.

Required: No

Default value: null

label_order (list(string)) optional

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.

Required: No

Default value: null

label_value_case (string) optional

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.

Required: No

Default value: null

labels_as_tags (set(string)) optional

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 be
changed in later chained modules. Attempts to change it will be silently ignored.

Required: No

Default value:

[
  "default"
]

name (string) optional

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.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

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.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

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
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

Dependencies

Requirements

terraform, version: >= 1.0.0
aws, version: >= 4.9.0
random, version: >= 3.0

Providers

aws, version: >= 4.9.0
random, version: >= 3.0

Modules

Name	Version	Source	Description
`dns_delegated`	1.5.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`elasticsearch`	0.42.0	`cloudposse/elasticsearch/aws`	n/a
`elasticsearch_log_cleanup`	0.14.0	`cloudposse/lambda-elasticsearch-cleanup/aws`	n/a
`iam_roles`	latest	`../account-map/modules/iam-roles`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a
`vpc`	1.5.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a

Resources

The following resources are used by this module:

aws_ssm_parameter.admin_password (resource)
aws_ssm_parameter.elasticsearch_domain_endpoint (resource)
aws_ssm_parameter.elasticsearch_kibana_endpoint (resource)
random_password.elasticsearch_password (resource)

Data Sources

The following data sources are used by this module:

References

cloudposse/terraform-aws-components - Cloud Posse's upstream component

Usage​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

References​

Usage

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources

References