OpenSearch Terraform Provider

https://registry.terraform.io/providers/opensearch-project/opensearch/latest/docs
Admin
The OpenSearch Terraform provider allows you to manage OpenSearch resources, including clusters,...
Tokens:1,597
Snippets:8
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Configure OpenSearch Provider

Source: https://registry.terraform.io/providers/opensearch-project/opensearch/latest/docs/index

Configures the OpenSearch provider with a URL. This is a basic setup for connecting to an OpenSearch instance.

```Terraform
provider "opensearch" {
  url = "http://127.0.0.1:9200"
}
```

--------------------------------

### Create OpenSearch Index Template

Source: https://registry.terraform.io/providers/opensearch-project/opensearch/latest/docs/index

Creates an OpenSearch index template with specified name, index patterns, and settings including mappings for source and properties. This allows defining default index configurations.

```Terraform
# Create an index template
resource "opensearch_index_template" "template_1" {
  name = "template_1"
  body = <<EOF
{
  "index_patterns": [
    "your-pattern-here-*"
  ],
  "template": {
    "settings": {
      "index": {
        "number_of_shards": "1"
      }
    },
    "mappings": {
      "_source": {
        "enabled": false
      },
      "properties": {
        "host_name": {
          "type": "keyword"
        },
        "created_at": {
          "type": "date",
          "format": "EEE MMM dd HH:mm:ss Z YYYY"
        }
      }
    }
  }
}
EOF
}
```

--------------------------------

### Set AWS Credentials via Environment Variables

Source: https://registry.terraform.io/providers/opensearch-project/opensearch/latest/docs/index

Configures AWS access key ID, secret access key, and optionally session token using environment variables for authentication.

```Bash
$ export AWS_ACCESS_KEY_ID="anaccesskey"
$ export AWS_SECRET_ACCESS_KEY="asecretkey"
$ terraform plan
```

--------------------------------

### Configure HTTP Basic Auth for OpenSearch

Source: https://registry.terraform.io/providers/opensearch-project/opensearch/latest/docs/index

Provides username and password for OpenSearch domains using an internal user database. AWS request signing must be disabled.

```Terraform
provider "opensearch" {
  url      = "https://search-foo-bar-pqrhr4w3u4dzervg41frow4mmy.us-east-1.es.amazonaws.com"
  username = "ausername"
  password = "apassword"
  # Must be disabled for basic auth
  sign_aws_requests = false
}
```

--------------------------------

### Configure OpenSearch Provider with AWS Static Credentials

Source: https://registry.terraform.io/providers/opensearch-project/opensearch/latest/docs/index

Configures the OpenSearch provider for AWS OpenSearch Service domains using static AWS credentials (access key, secret key, and optional token).

```Terraform
provider "opensearch" {
  url            = "https://search-foo-bar-pqrhr4w3u4dzervg41frow4mmy.us-east-1.es.amazonaws.com"
  aws_access_key = "anaccesskey"
  aws_secret_key = "asecretkey"
  aws_token      = "" # if necessary
}
```

--------------------------------

### Connect to OpenSearch via SSH Tunnel

Source: https://registry.terraform.io/providers/opensearch-project/opensearch/latest/docs/index

Configures the provider to connect to an OpenSearch cluster through an SSH tunnel, typically for VPC-hosted clusters. Uses `host_override` for certificate validation.

```Terraform
provider "opensearch" {
  url           = "https://localhost:9999" # Replace 9999 with the port your SSH tunnel is running on
  host_override = "vpc-<******>.us-east-1.es.amazonaws.com"
}
```

--------------------------------

### Configure AWS Assume Role for OpenSearch Provider

Source: https://registry.terraform.io/providers/opensearch-project/opensearch/latest/docs/index

Instructs the provider to assume an AWS IAM role before interacting with the OpenSearch cluster. Requires the ARN of the role and optionally an external ID.

```Terraform
provider "opensearch" {
  url                         = "https://search-foo-bar-pqrhr4w3u4dzervg41frow4mmy.us-east-1.es.amazonaws.com"
  aws_assume_role_arn         = "arn:aws:iam::012345678901:role/rolename"
  aws_assume_role_external_id = "SecretID"
}
```

--------------------------------

### Configure AWS Profile for OpenSearch Provider

Source: https://registry.terraform.io/providers/opensearch-project/opensearch/latest/docs/index

Specifies a named AWS profile to use for credentials, which can include static credentials or STS assumed role credentials.

```Terraform
provider "opensearch" {
  url         = "https://search-foo-bar-pqrhr4w3u4dzervg41frow4mmy.us-east-1.es.amazonaws.com"
  aws_profile = "profilename"
}
```
Tokens:
Raw