mirror of https://github.com/opentffoundation/opentf.git synced 2026-03-13 01:00:50 -04:00

Files

Jake Champlin ebc89e9426 Merge pull request #13701 from kavu/kavu-docs_hcl_addition

Massively add HCL source tag in docs Markdown files

2017-04-17 09:48:25 -04:00

3.3 KiB

Raw Blame History

layout, page_title, sidebar_current, description

layout	page_title	sidebar_current	description
aws	AWS: aws_elasticsearch_domain	docs-aws-resource-elasticsearch-domain	Provides an ElasticSearch Domain.

aws_elasticsearch_domain

Example Usage

resource "aws_elasticsearch_domain" "es" {
  domain_name           = "tf-test"
  elasticsearch_version = "1.5"
  cluster_config {
    instance_type = "r3.large.elasticsearch"
  }

  advanced_options {
    "rest.action.multi.allow_explicit_index" = "true"
  }

  access_policies = <<CONFIG
{
	"Version": "2012-10-17",
	"Statement": [
		{
			"Action": "es:*",
			"Principal": "*",
			"Effect": "Allow",
			"Condition": {
				"IpAddress": {"aws:SourceIp": ["66.193.100.22/32"]}
			}
		}
	]
}
CONFIG

  snapshot_options {
    automated_snapshot_start_hour = 23
  }

  tags {
    Domain = "TestDomain"
  }
}

Argument Reference

The following arguments are supported:

domain_name - (Required) Name of the domain.
access_policies - (Optional) IAM policy document specifying the access policies for the domain
advanced_options - (Optional) Key-value string pairs to specify advanced configuration options.
ebs_options - (Optional) EBS related options, may be required based on chosen instance size. See below.
cluster_config - (Optional) Cluster configuration of the domain, see below.
snapshot_options - (Optional) Snapshot related options, see below.
elasticsearch_version - (Optional) The version of ElasticSearch to deploy. Defaults to 1.5
tags - (Optional) A mapping of tags to assign to the resource

ebs_options supports the following attributes:

ebs_enabled - (Required) Whether EBS volumes are attached to data nodes in the domain
volume_type - (Optional) The type of EBS volumes attached to data nodes.
volume_size - The size of EBS volumes attached to data nodes (in GB). Required if ebs_enabled is set to true.
iops - (Optional) The baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the Provisioned IOPS EBS volume type.

cluster_config supports the following attributes:

instance_type - (Optional) Instance type of data nodes in the cluster.
instance_count - (Optional) Number of instances in the cluster.
dedicated_master_enabled - (Optional) Indicates whether dedicated master nodes are enabled for the cluster.
dedicated_master_type - (Optional) Instance type of the dedicated master nodes in the cluster.
dedicated_master_count - (Optional) Number of dedicated master nodes in the cluster
zone_awareness_enabled - (Optional) Indicates whether zone awareness is enabled.

snapshot_options supports the following attribute:

automated_snapshot_start_hour - (Required) Hour during which the service takes an automated daily snapshot of the indices in the domain.

Attributes Reference

The following attributes are exported:

arn - Amazon Resource Name (ARN) of the domain.
domain_id - Unique identifier for the domain.
endpoint - Domain-specific endpoint used to submit index, search, and data upload requests.

Import

ElasticSearch domains can be imported using the domain_name, e.g.

$ terraform import aws_elasticsearch_domain.example domain_name

3.3 KiB Raw Blame History