ResiLien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
terraform/website/source/docs/providers/aws/r/elasticsearch_domain.html.m...

92 lines
2.9 KiB
Markdown
Raw Normal View History

provider/aws: Add docs for aws_elasticsearch_domain
2015-10-02 00:13:32 +02:00
---
layout: "aws"
page_title: "AWS: aws_elasticsearch_domain"
website: Fix missing sidebar_current
2016-03-06 15:51:25 +01:00
sidebar_current: "docs-aws-resource-elasticsearch-domain"
provider/aws: Add docs for aws_elasticsearch_domain
2015-10-02 00:13:32 +02:00
description: |-
Provides an ElasticSearch Domain.
---
# aws\_elasticsearch\_domain
## Example Usage
```
resource "aws_elasticsearch_domain" "es" {
domain_name = "tf-test"
provider/aws: Support `aws_elasticsearch_domain` upgrades to (#7860) `elasticsearch_version` 2.3 Fixes #7836 This will allow ElasticSearch domains to be deployed with version 2.3 of ElasticSearch The other slight modifications are to stop dereferencing values before passing to d.Set in the Read func. It is safer to pass the pointer to d.Set and allow that to dereference if there is a value ``` % make testacc TEST=./builtin/providers/aws TESTARGS='-run=TestAccAWSElasticSearchDomain_' ==> Checking that code complies with gofmt requirements... go generate $(go list ./... | grep -v /terraform/vendor/) TF_ACC=1 go test ./builtin/providers/aws -v -run=TestAccAWSElasticSearchDomain_ -timeout 120m === RUN TestAccAWSElasticSearchDomain_basic --- PASS: TestAccAWSElasticSearchDomain_basic (1611.74s) === RUN TestAccAWSElasticSearchDomain_v23 --- PASS: TestAccAWSElasticSearchDomain_v23 (1898.80s) === RUN TestAccAWSElasticSearchDomain_complex --- PASS: TestAccAWSElasticSearchDomain_complex (1802.44s) PASS ok github.com/hashicorp/terraform/builtin/providers/aws 5313.006s ``` Update resource_aws_elasticsearch_domain.go
2016-08-05 09:59:15 +02:00
elasticsearch_version = "1.5"
provider/aws: Add docs for aws_elasticsearch_domain
2015-10-02 00:13:32 +02:00
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
}
provider/aws: `aws_elastisearch_domain` tags not being set correctly. The top level object was used not the tags within
2016-02-28 02:25:07 +01:00
tags {
Domain = "TestDomain"
}
provider/aws: Add docs for aws_elasticsearch_domain
2015-10-02 00:13:32 +02:00
}
```
## 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, see below.
* `cluster_config` - (Optional) Cluster configuration of the domain, see below.
* `snapshot_options` - (Optional) Snapshot related options, see below.
provider/aws: Support `aws_elasticsearch_domain` upgrades to (#7860) `elasticsearch_version` 2.3 Fixes #7836 This will allow ElasticSearch domains to be deployed with version 2.3 of ElasticSearch The other slight modifications are to stop dereferencing values before passing to d.Set in the Read func. It is safer to pass the pointer to d.Set and allow that to dereference if there is a value ``` % make testacc TEST=./builtin/providers/aws TESTARGS='-run=TestAccAWSElasticSearchDomain_' ==> Checking that code complies with gofmt requirements... go generate $(go list ./... | grep -v /terraform/vendor/) TF_ACC=1 go test ./builtin/providers/aws -v -run=TestAccAWSElasticSearchDomain_ -timeout 120m === RUN TestAccAWSElasticSearchDomain_basic --- PASS: TestAccAWSElasticSearchDomain_basic (1611.74s) === RUN TestAccAWSElasticSearchDomain_v23 --- PASS: TestAccAWSElasticSearchDomain_v23 (1898.80s) === RUN TestAccAWSElasticSearchDomain_complex --- PASS: TestAccAWSElasticSearchDomain_complex (1802.44s) PASS ok github.com/hashicorp/terraform/builtin/providers/aws 5313.006s ``` Update resource_aws_elasticsearch_domain.go
2016-08-05 09:59:15 +02:00
* `elasticsearch_version` - (Optional) The version of ElasticSearch to deploy. Only valid values are `1.5` and `2.3`. Defaults to `1.5`
provider/aws: `aws_elastisearch_domain` tags not being set correctly. The top level object was used not the tags within
2016-02-28 02:25:07 +01:00
* `tags` - (Optional) A mapping of tags to assign to the resource
provider/aws: Add docs for aws_elasticsearch_domain
2015-10-02 00:13:32 +02:00
**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.
provider/aws: Document volume_size requirement if using EBS in ElasticSearch Domain
2016-03-17 15:00:41 +01:00
* `volume_size` - The size of EBS volumes attached to data nodes.
**Required** if `ebs_enabled` is set to `true`.
provider/aws: Add docs for aws_elasticsearch_domain
2015-10-02 00:13:32 +02:00
* `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
Add missing 'e'
2015-10-08 22:34:17 +02:00
* `zone_awareness_enabled` - (Optional) Indicates whether zone awareness is enabled.
provider/aws: Add docs for aws_elasticsearch_domain
2015-10-02 00:13:32 +02:00
**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.