Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Elasticstack Provider
  3. API Docs
  4. ElasticsearchIndex
elasticstack 0.11.14 published on Monday, Apr 14, 2025 by elastic
elastic/terraform-provider-elasticstack

elasticstack.ElasticsearchIndex

Explore with Pulumi AI

elasticstack 0.11.14 published on Monday, Apr 14, 2025 by elastic
elastic/terraform-provider-elasticstack

Creates or updates an index. This resource can define settings, mappings and aliases. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as elasticstack from "@pulumi/elasticstack";

const myIndex = new elasticstack.ElasticsearchIndex("myIndex", {
    aliases: [
        {
            name: "my_alias_1",
        },
        {
            name: "my_alias_2",
            filter: JSON.stringify({
                term: {
                    "user.id": "developer",
                },
            }),
        },
    ],
    mappings: JSON.stringify({
        properties: {
            field1: {
                type: "keyword",
            },
            field2: {
                type: "text",
            },
            field3: {
                properties: {
                    inner_field1: {
                        type: "text",
                        index: false,
                    },
                    inner_field2: {
                        type: "integer",
                        index: false,
                    },
                },
            },
        },
    }),
    numberOfShards: 1,
    numberOfReplicas: 2,
    searchIdleAfter: "20s",
});
Copy
import pulumi
import json
import pulumi_elasticstack as elasticstack

my_index = elasticstack.ElasticsearchIndex("myIndex",
    aliases=[
        {
            "name": "my_alias_1",
        },
        {
            "name": "my_alias_2",
            "filter": json.dumps({
                "term": {
                    "user.id": "developer",
                },
            }),
        },
    ],
    mappings=json.dumps({
        "properties": {
            "field1": {
                "type": "keyword",
            },
            "field2": {
                "type": "text",
            },
            "field3": {
                "properties": {
                    "inner_field1": {
                        "type": "text",
                        "index": False,
                    },
                    "inner_field2": {
                        "type": "integer",
                        "index": False,
                    },
                },
            },
        },
    }),
    number_of_shards=1,
    number_of_replicas=2,
    search_idle_after="20s")
Copy
package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-terraform-provider/sdks/go/elasticstack/elasticstack"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"term": map[string]interface{}{
				"user.id": "developer",
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		tmpJSON1, err := json.Marshal(map[string]interface{}{
			"properties": map[string]interface{}{
				"field1": map[string]interface{}{
					"type": "keyword",
				},
				"field2": map[string]interface{}{
					"type": "text",
				},
				"field3": map[string]interface{}{
					"properties": map[string]interface{}{
						"inner_field1": map[string]interface{}{
							"type":  "text",
							"index": false,
						},
						"inner_field2": map[string]interface{}{
							"type":  "integer",
							"index": false,
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		json1 := string(tmpJSON1)
		_, err = elasticstack.NewElasticsearchIndex(ctx, "myIndex", &elasticstack.ElasticsearchIndexArgs{
			Aliases: elasticstack.ElasticsearchIndexAliasArray{
				&elasticstack.ElasticsearchIndexAliasArgs{
					Name: pulumi.String("my_alias_1"),
				},
				&elasticstack.ElasticsearchIndexAliasArgs{
					Name:   pulumi.String("my_alias_2"),
					Filter: pulumi.String(json0),
				},
			},
			Mappings:         pulumi.String(json1),
			NumberOfShards:   pulumi.Float64(1),
			NumberOfReplicas: pulumi.Float64(2),
			SearchIdleAfter:  pulumi.String("20s"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Elasticstack = Pulumi.Elasticstack;

return await Deployment.RunAsync(() => 
{
    var myIndex = new Elasticstack.ElasticsearchIndex("myIndex", new()
    {
        Aliases = new[]
        {
            new Elasticstack.Inputs.ElasticsearchIndexAliasArgs
            {
                Name = "my_alias_1",
            },
            new Elasticstack.Inputs.ElasticsearchIndexAliasArgs
            {
                Name = "my_alias_2",
                Filter = JsonSerializer.Serialize(new Dictionary<string, object?>
                {
                    ["term"] = new Dictionary<string, object?>
                    {
                        ["user.id"] = "developer",
                    },
                }),
            },
        },
        Mappings = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["properties"] = new Dictionary<string, object?>
            {
                ["field1"] = new Dictionary<string, object?>
                {
                    ["type"] = "keyword",
                },
                ["field2"] = new Dictionary<string, object?>
                {
                    ["type"] = "text",
                },
                ["field3"] = new Dictionary<string, object?>
                {
                    ["properties"] = new Dictionary<string, object?>
                    {
                        ["inner_field1"] = new Dictionary<string, object?>
                        {
                            ["type"] = "text",
                            ["index"] = false,
                        },
                        ["inner_field2"] = new Dictionary<string, object?>
                        {
                            ["type"] = "integer",
                            ["index"] = false,
                        },
                    },
                },
            },
        }),
        NumberOfShards = 1,
        NumberOfReplicas = 2,
        SearchIdleAfter = "20s",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.elasticstack.ElasticsearchIndex;
import com.pulumi.elasticstack.ElasticsearchIndexArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchIndexAliasArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var myIndex = new ElasticsearchIndex("myIndex", ElasticsearchIndexArgs.builder()
            .aliases(            
                ElasticsearchIndexAliasArgs.builder()
                    .name("my_alias_1")
                    .build(),
                ElasticsearchIndexAliasArgs.builder()
                    .name("my_alias_2")
                    .filter(serializeJson(
                        jsonObject(
                            jsonProperty("term", jsonObject(
                                jsonProperty("user.id", "developer")
                            ))
                        )))
                    .build())
            .mappings(serializeJson(
                jsonObject(
                    jsonProperty("properties", jsonObject(
                        jsonProperty("field1", jsonObject(
                            jsonProperty("type", "keyword")
                        )),
                        jsonProperty("field2", jsonObject(
                            jsonProperty("type", "text")
                        )),
                        jsonProperty("field3", jsonObject(
                            jsonProperty("properties", jsonObject(
                                jsonProperty("inner_field1", jsonObject(
                                    jsonProperty("type", "text"),
                                    jsonProperty("index", false)
                                )),
                                jsonProperty("inner_field2", jsonObject(
                                    jsonProperty("type", "integer"),
                                    jsonProperty("index", false)
                                ))
                            ))
                        ))
                    ))
                )))
            .numberOfShards(1)
            .numberOfReplicas(2)
            .searchIdleAfter("20s")
            .build());

    }
}
Copy
resources:
  myIndex:
    type: elasticstack:ElasticsearchIndex
    properties:
      aliases:
        - name: my_alias_1
        - name: my_alias_2
          filter:
            fn::toJSON:
              term:
                user.id: developer
      mappings:
        fn::toJSON:
          properties:
            field1:
              type: keyword
            field2:
              type: text
            field3:
              properties:
                inner_field1:
                  type: text
                  index: false
                inner_field2:
                  type: integer
                  index: false
      numberOfShards: 1
      numberOfReplicas: 2
      searchIdleAfter: 20s
Copy

Create ElasticsearchIndex Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ElasticsearchIndex(name: string, args?: ElasticsearchIndexArgs, opts?: CustomResourceOptions);
@overload
def ElasticsearchIndex(resource_name: str,
                       args: Optional[ElasticsearchIndexArgs] = None,
                       opts: Optional[ResourceOptions] = None)

@overload
def ElasticsearchIndex(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       aliases: Optional[Sequence[ElasticsearchIndexAliasArgs]] = None,
                       analysis_analyzer: Optional[str] = None,
                       analysis_char_filter: Optional[str] = None,
                       analysis_filter: Optional[str] = None,
                       analysis_normalizer: Optional[str] = None,
                       analysis_tokenizer: Optional[str] = None,
                       analyze_max_token_count: Optional[float] = None,
                       auto_expand_replicas: Optional[str] = None,
                       blocks_metadata: Optional[bool] = None,
                       blocks_read: Optional[bool] = None,
                       blocks_read_only: Optional[bool] = None,
                       blocks_read_only_allow_delete: Optional[bool] = None,
                       blocks_write: Optional[bool] = None,
                       codec: Optional[str] = None,
                       default_pipeline: Optional[str] = None,
                       deletion_protection: Optional[bool] = None,
                       elasticsearch_connections: Optional[Sequence[ElasticsearchIndexElasticsearchConnectionArgs]] = None,
                       final_pipeline: Optional[str] = None,
                       gc_deletes: Optional[str] = None,
                       highlight_max_analyzed_offset: Optional[float] = None,
                       indexing_slowlog_level: Optional[str] = None,
                       indexing_slowlog_source: Optional[str] = None,
                       indexing_slowlog_threshold_index_debug: Optional[str] = None,
                       indexing_slowlog_threshold_index_info: Optional[str] = None,
                       indexing_slowlog_threshold_index_trace: Optional[str] = None,
                       indexing_slowlog_threshold_index_warn: Optional[str] = None,
                       load_fixed_bitset_filters_eagerly: Optional[bool] = None,
                       mapping_coerce: Optional[bool] = None,
                       mappings: Optional[str] = None,
                       master_timeout: Optional[str] = None,
                       max_docvalue_fields_search: Optional[float] = None,
                       max_inner_result_window: Optional[float] = None,
                       max_ngram_diff: Optional[float] = None,
                       max_refresh_listeners: Optional[float] = None,
                       max_regex_length: Optional[float] = None,
                       max_rescore_window: Optional[float] = None,
                       max_result_window: Optional[float] = None,
                       max_script_fields: Optional[float] = None,
                       max_shingle_diff: Optional[float] = None,
                       max_terms_count: Optional[float] = None,
                       name: Optional[str] = None,
                       number_of_replicas: Optional[float] = None,
                       number_of_routing_shards: Optional[float] = None,
                       number_of_shards: Optional[float] = None,
                       query_default_fields: Optional[Sequence[str]] = None,
                       refresh_interval: Optional[str] = None,
                       routing_allocation_enable: Optional[str] = None,
                       routing_partition_size: Optional[float] = None,
                       routing_rebalance_enable: Optional[str] = None,
                       search_idle_after: Optional[str] = None,
                       search_slowlog_level: Optional[str] = None,
                       search_slowlog_threshold_fetch_debug: Optional[str] = None,
                       search_slowlog_threshold_fetch_info: Optional[str] = None,
                       search_slowlog_threshold_fetch_trace: Optional[str] = None,
                       search_slowlog_threshold_fetch_warn: Optional[str] = None,
                       search_slowlog_threshold_query_debug: Optional[str] = None,
                       search_slowlog_threshold_query_info: Optional[str] = None,
                       search_slowlog_threshold_query_trace: Optional[str] = None,
                       search_slowlog_threshold_query_warn: Optional[str] = None,
                       settings: Optional[Sequence[ElasticsearchIndexSettingArgs]] = None,
                       shard_check_on_startup: Optional[str] = None,
                       sort_fields: Optional[Sequence[str]] = None,
                       sort_orders: Optional[Sequence[str]] = None,
                       timeout: Optional[str] = None,
                       unassigned_node_left_delayed_timeout: Optional[str] = None,
                       wait_for_active_shards: Optional[str] = None)
func NewElasticsearchIndex(ctx *Context, name string, args *ElasticsearchIndexArgs, opts ...ResourceOption) (*ElasticsearchIndex, error)
public ElasticsearchIndex(string name, ElasticsearchIndexArgs? args = null, CustomResourceOptions? opts = null)
public ElasticsearchIndex(String name, ElasticsearchIndexArgs args)
public ElasticsearchIndex(String name, ElasticsearchIndexArgs args, CustomResourceOptions options)

type: elasticstack:ElasticsearchIndex
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args ElasticsearchIndexArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args ElasticsearchIndexArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args ElasticsearchIndexArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args ElasticsearchIndexArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ElasticsearchIndexArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var elasticsearchIndexResource = new Elasticstack.ElasticsearchIndex("elasticsearchIndexResource", new()
{
    Aliases = new[]
    {
        new Elasticstack.Inputs.ElasticsearchIndexAliasArgs
        {
            Name = "string",
            Filter = "string",
            IndexRouting = "string",
            IsHidden = false,
            IsWriteIndex = false,
            Routing = "string",
            SearchRouting = "string",
        },
    },
    AnalysisAnalyzer = "string",
    AnalysisCharFilter = "string",
    AnalysisFilter = "string",
    AnalysisNormalizer = "string",
    AnalysisTokenizer = "string",
    AnalyzeMaxTokenCount = 0,
    AutoExpandReplicas = "string",
    BlocksMetadata = false,
    BlocksRead = false,
    BlocksReadOnly = false,
    BlocksReadOnlyAllowDelete = false,
    BlocksWrite = false,
    Codec = "string",
    DefaultPipeline = "string",
    DeletionProtection = false,
    FinalPipeline = "string",
    GcDeletes = "string",
    HighlightMaxAnalyzedOffset = 0,
    IndexingSlowlogLevel = "string",
    IndexingSlowlogSource = "string",
    IndexingSlowlogThresholdIndexDebug = "string",
    IndexingSlowlogThresholdIndexInfo = "string",
    IndexingSlowlogThresholdIndexTrace = "string",
    IndexingSlowlogThresholdIndexWarn = "string",
    LoadFixedBitsetFiltersEagerly = false,
    MappingCoerce = false,
    Mappings = "string",
    MasterTimeout = "string",
    MaxDocvalueFieldsSearch = 0,
    MaxInnerResultWindow = 0,
    MaxNgramDiff = 0,
    MaxRefreshListeners = 0,
    MaxRegexLength = 0,
    MaxRescoreWindow = 0,
    MaxResultWindow = 0,
    MaxScriptFields = 0,
    MaxShingleDiff = 0,
    MaxTermsCount = 0,
    Name = "string",
    NumberOfReplicas = 0,
    NumberOfRoutingShards = 0,
    NumberOfShards = 0,
    QueryDefaultFields = new[]
    {
        "string",
    },
    RefreshInterval = "string",
    RoutingAllocationEnable = "string",
    RoutingPartitionSize = 0,
    RoutingRebalanceEnable = "string",
    SearchIdleAfter = "string",
    SearchSlowlogLevel = "string",
    SearchSlowlogThresholdFetchDebug = "string",
    SearchSlowlogThresholdFetchInfo = "string",
    SearchSlowlogThresholdFetchTrace = "string",
    SearchSlowlogThresholdFetchWarn = "string",
    SearchSlowlogThresholdQueryDebug = "string",
    SearchSlowlogThresholdQueryInfo = "string",
    SearchSlowlogThresholdQueryTrace = "string",
    SearchSlowlogThresholdQueryWarn = "string",
    ShardCheckOnStartup = "string",
    SortFields = new[]
    {
        "string",
    },
    SortOrders = new[]
    {
        "string",
    },
    Timeout = "string",
    UnassignedNodeLeftDelayedTimeout = "string",
    WaitForActiveShards = "string",
});
Copy
example, err := elasticstack.NewElasticsearchIndex(ctx, "elasticsearchIndexResource", &elasticstack.ElasticsearchIndexArgs{
Aliases: .ElasticsearchIndexAliasArray{
&.ElasticsearchIndexAliasArgs{
Name: pulumi.String("string"),
Filter: pulumi.String("string"),
IndexRouting: pulumi.String("string"),
IsHidden: pulumi.Bool(false),
IsWriteIndex: pulumi.Bool(false),
Routing: pulumi.String("string"),
SearchRouting: pulumi.String("string"),
},
},
AnalysisAnalyzer: pulumi.String("string"),
AnalysisCharFilter: pulumi.String("string"),
AnalysisFilter: pulumi.String("string"),
AnalysisNormalizer: pulumi.String("string"),
AnalysisTokenizer: pulumi.String("string"),
AnalyzeMaxTokenCount: pulumi.Float64(0),
AutoExpandReplicas: pulumi.String("string"),
BlocksMetadata: pulumi.Bool(false),
BlocksRead: pulumi.Bool(false),
BlocksReadOnly: pulumi.Bool(false),
BlocksReadOnlyAllowDelete: pulumi.Bool(false),
BlocksWrite: pulumi.Bool(false),
Codec: pulumi.String("string"),
DefaultPipeline: pulumi.String("string"),
DeletionProtection: pulumi.Bool(false),
FinalPipeline: pulumi.String("string"),
GcDeletes: pulumi.String("string"),
HighlightMaxAnalyzedOffset: pulumi.Float64(0),
IndexingSlowlogLevel: pulumi.String("string"),
IndexingSlowlogSource: pulumi.String("string"),
IndexingSlowlogThresholdIndexDebug: pulumi.String("string"),
IndexingSlowlogThresholdIndexInfo: pulumi.String("string"),
IndexingSlowlogThresholdIndexTrace: pulumi.String("string"),
IndexingSlowlogThresholdIndexWarn: pulumi.String("string"),
LoadFixedBitsetFiltersEagerly: pulumi.Bool(false),
MappingCoerce: pulumi.Bool(false),
Mappings: pulumi.String("string"),
MasterTimeout: pulumi.String("string"),
MaxDocvalueFieldsSearch: pulumi.Float64(0),
MaxInnerResultWindow: pulumi.Float64(0),
MaxNgramDiff: pulumi.Float64(0),
MaxRefreshListeners: pulumi.Float64(0),
MaxRegexLength: pulumi.Float64(0),
MaxRescoreWindow: pulumi.Float64(0),
MaxResultWindow: pulumi.Float64(0),
MaxScriptFields: pulumi.Float64(0),
MaxShingleDiff: pulumi.Float64(0),
MaxTermsCount: pulumi.Float64(0),
Name: pulumi.String("string"),
NumberOfReplicas: pulumi.Float64(0),
NumberOfRoutingShards: pulumi.Float64(0),
NumberOfShards: pulumi.Float64(0),
QueryDefaultFields: pulumi.StringArray{
pulumi.String("string"),
},
RefreshInterval: pulumi.String("string"),
RoutingAllocationEnable: pulumi.String("string"),
RoutingPartitionSize: pulumi.Float64(0),
RoutingRebalanceEnable: pulumi.String("string"),
SearchIdleAfter: pulumi.String("string"),
SearchSlowlogLevel: pulumi.String("string"),
SearchSlowlogThresholdFetchDebug: pulumi.String("string"),
SearchSlowlogThresholdFetchInfo: pulumi.String("string"),
SearchSlowlogThresholdFetchTrace: pulumi.String("string"),
SearchSlowlogThresholdFetchWarn: pulumi.String("string"),
SearchSlowlogThresholdQueryDebug: pulumi.String("string"),
SearchSlowlogThresholdQueryInfo: pulumi.String("string"),
SearchSlowlogThresholdQueryTrace: pulumi.String("string"),
SearchSlowlogThresholdQueryWarn: pulumi.String("string"),
ShardCheckOnStartup: pulumi.String("string"),
SortFields: pulumi.StringArray{
pulumi.String("string"),
},
SortOrders: pulumi.StringArray{
pulumi.String("string"),
},
Timeout: pulumi.String("string"),
UnassignedNodeLeftDelayedTimeout: pulumi.String("string"),
WaitForActiveShards: pulumi.String("string"),
})
Copy
var elasticsearchIndexResource = new ElasticsearchIndex("elasticsearchIndexResource", ElasticsearchIndexArgs.builder()
    .aliases(ElasticsearchIndexAliasArgs.builder()
        .name("string")
        .filter("string")
        .indexRouting("string")
        .isHidden(false)
        .isWriteIndex(false)
        .routing("string")
        .searchRouting("string")
        .build())
    .analysisAnalyzer("string")
    .analysisCharFilter("string")
    .analysisFilter("string")
    .analysisNormalizer("string")
    .analysisTokenizer("string")
    .analyzeMaxTokenCount(0)
    .autoExpandReplicas("string")
    .blocksMetadata(false)
    .blocksRead(false)
    .blocksReadOnly(false)
    .blocksReadOnlyAllowDelete(false)
    .blocksWrite(false)
    .codec("string")
    .defaultPipeline("string")
    .deletionProtection(false)
    .finalPipeline("string")
    .gcDeletes("string")
    .highlightMaxAnalyzedOffset(0)
    .indexingSlowlogLevel("string")
    .indexingSlowlogSource("string")
    .indexingSlowlogThresholdIndexDebug("string")
    .indexingSlowlogThresholdIndexInfo("string")
    .indexingSlowlogThresholdIndexTrace("string")
    .indexingSlowlogThresholdIndexWarn("string")
    .loadFixedBitsetFiltersEagerly(false)
    .mappingCoerce(false)
    .mappings("string")
    .masterTimeout("string")
    .maxDocvalueFieldsSearch(0)
    .maxInnerResultWindow(0)
    .maxNgramDiff(0)
    .maxRefreshListeners(0)
    .maxRegexLength(0)
    .maxRescoreWindow(0)
    .maxResultWindow(0)
    .maxScriptFields(0)
    .maxShingleDiff(0)
    .maxTermsCount(0)
    .name("string")
    .numberOfReplicas(0)
    .numberOfRoutingShards(0)
    .numberOfShards(0)
    .queryDefaultFields("string")
    .refreshInterval("string")
    .routingAllocationEnable("string")
    .routingPartitionSize(0)
    .routingRebalanceEnable("string")
    .searchIdleAfter("string")
    .searchSlowlogLevel("string")
    .searchSlowlogThresholdFetchDebug("string")
    .searchSlowlogThresholdFetchInfo("string")
    .searchSlowlogThresholdFetchTrace("string")
    .searchSlowlogThresholdFetchWarn("string")
    .searchSlowlogThresholdQueryDebug("string")
    .searchSlowlogThresholdQueryInfo("string")
    .searchSlowlogThresholdQueryTrace("string")
    .searchSlowlogThresholdQueryWarn("string")
    .shardCheckOnStartup("string")
    .sortFields("string")
    .sortOrders("string")
    .timeout("string")
    .unassignedNodeLeftDelayedTimeout("string")
    .waitForActiveShards("string")
    .build());
Copy
elasticsearch_index_resource = elasticstack.ElasticsearchIndex("elasticsearchIndexResource",
    aliases=[{
        "name": "string",
        "filter": "string",
        "index_routing": "string",
        "is_hidden": False,
        "is_write_index": False,
        "routing": "string",
        "search_routing": "string",
    }],
    analysis_analyzer="string",
    analysis_char_filter="string",
    analysis_filter="string",
    analysis_normalizer="string",
    analysis_tokenizer="string",
    analyze_max_token_count=0,
    auto_expand_replicas="string",
    blocks_metadata=False,
    blocks_read=False,
    blocks_read_only=False,
    blocks_read_only_allow_delete=False,
    blocks_write=False,
    codec="string",
    default_pipeline="string",
    deletion_protection=False,
    final_pipeline="string",
    gc_deletes="string",
    highlight_max_analyzed_offset=0,
    indexing_slowlog_level="string",
    indexing_slowlog_source="string",
    indexing_slowlog_threshold_index_debug="string",
    indexing_slowlog_threshold_index_info="string",
    indexing_slowlog_threshold_index_trace="string",
    indexing_slowlog_threshold_index_warn="string",
    load_fixed_bitset_filters_eagerly=False,
    mapping_coerce=False,
    mappings="string",
    master_timeout="string",
    max_docvalue_fields_search=0,
    max_inner_result_window=0,
    max_ngram_diff=0,
    max_refresh_listeners=0,
    max_regex_length=0,
    max_rescore_window=0,
    max_result_window=0,
    max_script_fields=0,
    max_shingle_diff=0,
    max_terms_count=0,
    name="string",
    number_of_replicas=0,
    number_of_routing_shards=0,
    number_of_shards=0,
    query_default_fields=["string"],
    refresh_interval="string",
    routing_allocation_enable="string",
    routing_partition_size=0,
    routing_rebalance_enable="string",
    search_idle_after="string",
    search_slowlog_level="string",
    search_slowlog_threshold_fetch_debug="string",
    search_slowlog_threshold_fetch_info="string",
    search_slowlog_threshold_fetch_trace="string",
    search_slowlog_threshold_fetch_warn="string",
    search_slowlog_threshold_query_debug="string",
    search_slowlog_threshold_query_info="string",
    search_slowlog_threshold_query_trace="string",
    search_slowlog_threshold_query_warn="string",
    shard_check_on_startup="string",
    sort_fields=["string"],
    sort_orders=["string"],
    timeout="string",
    unassigned_node_left_delayed_timeout="string",
    wait_for_active_shards="string")
Copy
const elasticsearchIndexResource = new elasticstack.ElasticsearchIndex("elasticsearchIndexResource", {
    aliases: [{
        name: "string",
        filter: "string",
        indexRouting: "string",
        isHidden: false,
        isWriteIndex: false,
        routing: "string",
        searchRouting: "string",
    }],
    analysisAnalyzer: "string",
    analysisCharFilter: "string",
    analysisFilter: "string",
    analysisNormalizer: "string",
    analysisTokenizer: "string",
    analyzeMaxTokenCount: 0,
    autoExpandReplicas: "string",
    blocksMetadata: false,
    blocksRead: false,
    blocksReadOnly: false,
    blocksReadOnlyAllowDelete: false,
    blocksWrite: false,
    codec: "string",
    defaultPipeline: "string",
    deletionProtection: false,
    finalPipeline: "string",
    gcDeletes: "string",
    highlightMaxAnalyzedOffset: 0,
    indexingSlowlogLevel: "string",
    indexingSlowlogSource: "string",
    indexingSlowlogThresholdIndexDebug: "string",
    indexingSlowlogThresholdIndexInfo: "string",
    indexingSlowlogThresholdIndexTrace: "string",
    indexingSlowlogThresholdIndexWarn: "string",
    loadFixedBitsetFiltersEagerly: false,
    mappingCoerce: false,
    mappings: "string",
    masterTimeout: "string",
    maxDocvalueFieldsSearch: 0,
    maxInnerResultWindow: 0,
    maxNgramDiff: 0,
    maxRefreshListeners: 0,
    maxRegexLength: 0,
    maxRescoreWindow: 0,
    maxResultWindow: 0,
    maxScriptFields: 0,
    maxShingleDiff: 0,
    maxTermsCount: 0,
    name: "string",
    numberOfReplicas: 0,
    numberOfRoutingShards: 0,
    numberOfShards: 0,
    queryDefaultFields: ["string"],
    refreshInterval: "string",
    routingAllocationEnable: "string",
    routingPartitionSize: 0,
    routingRebalanceEnable: "string",
    searchIdleAfter: "string",
    searchSlowlogLevel: "string",
    searchSlowlogThresholdFetchDebug: "string",
    searchSlowlogThresholdFetchInfo: "string",
    searchSlowlogThresholdFetchTrace: "string",
    searchSlowlogThresholdFetchWarn: "string",
    searchSlowlogThresholdQueryDebug: "string",
    searchSlowlogThresholdQueryInfo: "string",
    searchSlowlogThresholdQueryTrace: "string",
    searchSlowlogThresholdQueryWarn: "string",
    shardCheckOnStartup: "string",
    sortFields: ["string"],
    sortOrders: ["string"],
    timeout: "string",
    unassignedNodeLeftDelayedTimeout: "string",
    waitForActiveShards: "string",
});
Copy
type: elasticstack:ElasticsearchIndex
properties:
    aliases:
        - filter: string
          indexRouting: string
          isHidden: false
          isWriteIndex: false
          name: string
          routing: string
          searchRouting: string
    analysisAnalyzer: string
    analysisCharFilter: string
    analysisFilter: string
    analysisNormalizer: string
    analysisTokenizer: string
    analyzeMaxTokenCount: 0
    autoExpandReplicas: string
    blocksMetadata: false
    blocksRead: false
    blocksReadOnly: false
    blocksReadOnlyAllowDelete: false
    blocksWrite: false
    codec: string
    defaultPipeline: string
    deletionProtection: false
    finalPipeline: string
    gcDeletes: string
    highlightMaxAnalyzedOffset: 0
    indexingSlowlogLevel: string
    indexingSlowlogSource: string
    indexingSlowlogThresholdIndexDebug: string
    indexingSlowlogThresholdIndexInfo: string
    indexingSlowlogThresholdIndexTrace: string
    indexingSlowlogThresholdIndexWarn: string
    loadFixedBitsetFiltersEagerly: false
    mappingCoerce: false
    mappings: string
    masterTimeout: string
    maxDocvalueFieldsSearch: 0
    maxInnerResultWindow: 0
    maxNgramDiff: 0
    maxRefreshListeners: 0
    maxRegexLength: 0
    maxRescoreWindow: 0
    maxResultWindow: 0
    maxScriptFields: 0
    maxShingleDiff: 0
    maxTermsCount: 0
    name: string
    numberOfReplicas: 0
    numberOfRoutingShards: 0
    numberOfShards: 0
    queryDefaultFields:
        - string
    refreshInterval: string
    routingAllocationEnable: string
    routingPartitionSize: 0
    routingRebalanceEnable: string
    searchIdleAfter: string
    searchSlowlogLevel: string
    searchSlowlogThresholdFetchDebug: string
    searchSlowlogThresholdFetchInfo: string
    searchSlowlogThresholdFetchTrace: string
    searchSlowlogThresholdFetchWarn: string
    searchSlowlogThresholdQueryDebug: string
    searchSlowlogThresholdQueryInfo: string
    searchSlowlogThresholdQueryTrace: string
    searchSlowlogThresholdQueryWarn: string
    shardCheckOnStartup: string
    sortFields:
        - string
    sortOrders:
        - string
    timeout: string
    unassignedNodeLeftDelayedTimeout: string
    waitForActiveShards: string
Copy

ElasticsearchIndex Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ElasticsearchIndex resource accepts the following input properties:

Aliases List<ElasticsearchIndexAlias>
Aliases for the index.
AnalysisAnalyzer string
A JSON string describing the analyzers applied to the index.
AnalysisCharFilter string
A JSON string describing the char_filters applied to the index.
AnalysisFilter string
A JSON string describing the filters applied to the index.
AnalysisNormalizer string
A JSON string describing the normalizers applied to the index.
AnalysisTokenizer string
A JSON string describing the tokenizers applied to the index.
AnalyzeMaxTokenCount double
The maximum number of tokens that can be produced using _analyze API.
AutoExpandReplicas string
Set the number of replicas to the node count in the cluster. Set to a dash delimited lower and upper bound (e.g. 0-5) or use all for the upper bound (e.g. 0-all)
BlocksMetadata bool
Set to true to disable index metadata reads and writes.
BlocksRead bool
Set to true to disable read operations against the index.
BlocksReadOnly bool
Set to true to make the index and index metadata read only, false to allow writes and metadata changes.
BlocksReadOnlyAllowDelete bool
Identical to index.blocks.read_only but allows deleting the index to free up resources.
BlocksWrite bool
Set to true to disable data write operations against the index. This setting does not affect metadata.
Codec string
The default value compresses stored data with LZ4 compression, but this can be set to best_compression which uses DEFLATE for a higher compression ratio. This can be set only on creation.
DefaultPipeline string
The default ingest node pipeline for this index. Index requests will fail if the default pipeline is set and the pipeline does not exist.
DeletionProtection bool
ElasticsearchConnections List<ElasticsearchIndexElasticsearchConnection>
Elasticsearch connection configuration block.

Deprecated: Deprecated

FinalPipeline string
Final ingest pipeline for the index. Indexing requests will fail if the final pipeline is set and the pipeline does not exist. The final pipeline always runs after the request pipeline (if specified) and the default pipeline (if it exists). The special pipeline name _none indicates no ingest pipeline will run.
GcDeletes string
The length of time that a deleted document's version number remains available for further versioned operations.
HighlightMaxAnalyzedOffset double
The maximum number of characters that will be analyzed for a highlight request.
IndexingSlowlogLevel string
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
IndexingSlowlogSource string
Set the number of characters of the _source to include in the slowlog lines, false or 0 will skip logging the source entirely and setting it to true will log the entire source regardless of size. The original _source is reformatted by default to make sure that it fits on a single log line.
IndexingSlowlogThresholdIndexDebug string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 2s
IndexingSlowlogThresholdIndexInfo string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 5s
IndexingSlowlogThresholdIndexTrace string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 500ms
IndexingSlowlogThresholdIndexWarn string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 10s
LoadFixedBitsetFiltersEagerly bool
Indicates whether cached filters are pre-loaded for nested queries. This can be set only on creation.
MappingCoerce bool
Set index level coercion setting that is applied to all mapping types.
Mappings string
Mapping for fields in the index. If specified, this mapping can include: field names, field data types, mapping parameters. NOTE: - Changing datatypes in the existing mappings will force index to be re-created. - Removing field will be ignored by default same as elasticsearch. You need to recreate the index to remove field completely.
MasterTimeout string
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s. This value is ignored when running against Serverless projects.
MaxDocvalueFieldsSearch double
The maximum number of docvalue_fields that are allowed in a query.
MaxInnerResultWindow double
The maximum value of from + size for inner hits definition and top hits aggregations to this index.
MaxNgramDiff double
The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
MaxRefreshListeners double
Maximum number of refresh listeners available on each shard of the index.
MaxRegexLength double
The maximum length of regex that can be used in Regexp Query.
MaxRescoreWindow double
The maximum value of window_size for rescore requests in searches of this index.
MaxResultWindow double
The maximum value of from + size for searches to this index.
MaxScriptFields double
The maximum number of script_fields that are allowed in a query.
MaxShingleDiff double
The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
MaxTermsCount double
The maximum number of terms that can be used in Terms Query.
Name string
Name of the index you wish to create.
NumberOfReplicas double
Number of shard replicas.
NumberOfRoutingShards double
Value used with numberofshards to route documents to a primary shard. This can be set only on creation.
NumberOfShards double
Number of shards for the index. This can be set only on creation.
QueryDefaultFields List<string>
Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
RefreshInterval string
How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to -1 to disable refresh.
RoutingAllocationEnable string
Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
RoutingPartitionSize double
The number of shards a custom routing value can go to. This can be set only on creation.
RoutingRebalanceEnable string
Enables shard rebalancing for this index. It can be set to: all, primaries , replicas , none.
SearchIdleAfter string
How long a shard can not receive a search or get request until it’s considered search idle.
SearchSlowlogLevel string
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
SearchSlowlogThresholdFetchDebug string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 2s
SearchSlowlogThresholdFetchInfo string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 5s
SearchSlowlogThresholdFetchTrace string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 500ms
SearchSlowlogThresholdFetchWarn string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 10s
SearchSlowlogThresholdQueryDebug string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 2s
SearchSlowlogThresholdQueryInfo string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 5s
SearchSlowlogThresholdQueryTrace string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 500ms
SearchSlowlogThresholdQueryWarn string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 10s
Settings List<ElasticsearchIndexSetting>
DEPRECATED: Please use dedicated setting field. Configuration options for the index. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-modules-settings. NOTE: Static index settings (see: https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#staticindex_settings) can be only set on the index creation and later cannot be removed or updated - apply will return error

Deprecated: Deprecated

ShardCheckOnStartup string
Whether or not shards should be checked for corruption before opening. When corruption is detected, it will prevent the shard from being opened. Accepts false, true, checksum.
SortFields List<string>
The field to sort shards in this index by.
SortOrders List<string>
The direction to sort shards in. Accepts asc, desc.
Timeout string
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.
UnassignedNodeLeftDelayedTimeout string
Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g. 10s
WaitForActiveShards string
The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (numberofreplicas+1). Default: 1, the primary shard. This value is ignored when running against Serverless projects.
Aliases []ElasticsearchIndexAliasArgs
Aliases for the index.
AnalysisAnalyzer string
A JSON string describing the analyzers applied to the index.
AnalysisCharFilter string
A JSON string describing the char_filters applied to the index.
AnalysisFilter string
A JSON string describing the filters applied to the index.
AnalysisNormalizer string
A JSON string describing the normalizers applied to the index.
AnalysisTokenizer string
A JSON string describing the tokenizers applied to the index.
AnalyzeMaxTokenCount float64
The maximum number of tokens that can be produced using _analyze API.
AutoExpandReplicas string
Set the number of replicas to the node count in the cluster. Set to a dash delimited lower and upper bound (e.g. 0-5) or use all for the upper bound (e.g. 0-all)
BlocksMetadata bool
Set to true to disable index metadata reads and writes.
BlocksRead bool
Set to true to disable read operations against the index.
BlocksReadOnly bool
Set to true to make the index and index metadata read only, false to allow writes and metadata changes.
BlocksReadOnlyAllowDelete bool
Identical to index.blocks.read_only but allows deleting the index to free up resources.
BlocksWrite bool
Set to true to disable data write operations against the index. This setting does not affect metadata.
Codec string
The default value compresses stored data with LZ4 compression, but this can be set to best_compression which uses DEFLATE for a higher compression ratio. This can be set only on creation.
DefaultPipeline string
The default ingest node pipeline for this index. Index requests will fail if the default pipeline is set and the pipeline does not exist.
DeletionProtection bool
ElasticsearchConnections []ElasticsearchIndexElasticsearchConnectionArgs
Elasticsearch connection configuration block.

Deprecated: Deprecated

FinalPipeline string
Final ingest pipeline for the index. Indexing requests will fail if the final pipeline is set and the pipeline does not exist. The final pipeline always runs after the request pipeline (if specified) and the default pipeline (if it exists). The special pipeline name _none indicates no ingest pipeline will run.
GcDeletes string
The length of time that a deleted document's version number remains available for further versioned operations.
HighlightMaxAnalyzedOffset float64
The maximum number of characters that will be analyzed for a highlight request.
IndexingSlowlogLevel string
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
IndexingSlowlogSource string
Set the number of characters of the _source to include in the slowlog lines, false or 0 will skip logging the source entirely and setting it to true will log the entire source regardless of size. The original _source is reformatted by default to make sure that it fits on a single log line.
IndexingSlowlogThresholdIndexDebug string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 2s
IndexingSlowlogThresholdIndexInfo string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 5s
IndexingSlowlogThresholdIndexTrace string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 500ms
IndexingSlowlogThresholdIndexWarn string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 10s
LoadFixedBitsetFiltersEagerly bool
Indicates whether cached filters are pre-loaded for nested queries. This can be set only on creation.
MappingCoerce bool
Set index level coercion setting that is applied to all mapping types.
Mappings string
Mapping for fields in the index. If specified, this mapping can include: field names, field data types, mapping parameters. NOTE: - Changing datatypes in the existing mappings will force index to be re-created. - Removing field will be ignored by default same as elasticsearch. You need to recreate the index to remove field completely.
MasterTimeout string
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s. This value is ignored when running against Serverless projects.
MaxDocvalueFieldsSearch float64
The maximum number of docvalue_fields that are allowed in a query.
MaxInnerResultWindow float64
The maximum value of from + size for inner hits definition and top hits aggregations to this index.
MaxNgramDiff float64
The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
MaxRefreshListeners float64
Maximum number of refresh listeners available on each shard of the index.
MaxRegexLength float64
The maximum length of regex that can be used in Regexp Query.
MaxRescoreWindow float64
The maximum value of window_size for rescore requests in searches of this index.
MaxResultWindow float64
The maximum value of from + size for searches to this index.
MaxScriptFields float64
The maximum number of script_fields that are allowed in a query.
MaxShingleDiff float64
The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
MaxTermsCount float64
The maximum number of terms that can be used in Terms Query.
Name string
Name of the index you wish to create.
NumberOfReplicas float64
Number of shard replicas.
NumberOfRoutingShards float64
Value used with numberofshards to route documents to a primary shard. This can be set only on creation.
NumberOfShards float64
Number of shards for the index. This can be set only on creation.
QueryDefaultFields []string
Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
RefreshInterval string
How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to -1 to disable refresh.
RoutingAllocationEnable string
Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
RoutingPartitionSize float64
The number of shards a custom routing value can go to. This can be set only on creation.
RoutingRebalanceEnable string
Enables shard rebalancing for this index. It can be set to: all, primaries , replicas , none.
SearchIdleAfter string
How long a shard can not receive a search or get request until it’s considered search idle.
SearchSlowlogLevel string
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
SearchSlowlogThresholdFetchDebug string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 2s
SearchSlowlogThresholdFetchInfo string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 5s
SearchSlowlogThresholdFetchTrace string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 500ms
SearchSlowlogThresholdFetchWarn string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 10s
SearchSlowlogThresholdQueryDebug string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 2s
SearchSlowlogThresholdQueryInfo string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 5s
SearchSlowlogThresholdQueryTrace string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 500ms
SearchSlowlogThresholdQueryWarn string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 10s
Settings []ElasticsearchIndexSettingArgs
DEPRECATED: Please use dedicated setting field. Configuration options for the index. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-modules-settings. NOTE: Static index settings (see: https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#staticindex_settings) can be only set on the index creation and later cannot be removed or updated - apply will return error

Deprecated: Deprecated

ShardCheckOnStartup string
Whether or not shards should be checked for corruption before opening. When corruption is detected, it will prevent the shard from being opened. Accepts false, true, checksum.
SortFields []string
The field to sort shards in this index by.
SortOrders []string
The direction to sort shards in. Accepts asc, desc.
Timeout string
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.
UnassignedNodeLeftDelayedTimeout string
Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g. 10s
WaitForActiveShards string
The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (numberofreplicas+1). Default: 1, the primary shard. This value is ignored when running against Serverless projects.
aliases List<ElasticsearchIndexAlias>
Aliases for the index.
analysisAnalyzer String
A JSON string describing the analyzers applied to the index.
analysisCharFilter String
A JSON string describing the char_filters applied to the index.
analysisFilter String
A JSON string describing the filters applied to the index.
analysisNormalizer String
A JSON string describing the normalizers applied to the index.
analysisTokenizer String
A JSON string describing the tokenizers applied to the index.
analyzeMaxTokenCount Double
The maximum number of tokens that can be produced using _analyze API.
autoExpandReplicas String
Set the number of replicas to the node count in the cluster. Set to a dash delimited lower and upper bound (e.g. 0-5) or use all for the upper bound (e.g. 0-all)
blocksMetadata Boolean
Set to true to disable index metadata reads and writes.
blocksRead Boolean
Set to true to disable read operations against the index.
blocksReadOnly Boolean
Set to true to make the index and index metadata read only, false to allow writes and metadata changes.
blocksReadOnlyAllowDelete Boolean
Identical to index.blocks.read_only but allows deleting the index to free up resources.
blocksWrite Boolean
Set to true to disable data write operations against the index. This setting does not affect metadata.
codec String
The default value compresses stored data with LZ4 compression, but this can be set to best_compression which uses DEFLATE for a higher compression ratio. This can be set only on creation.
defaultPipeline String
The default ingest node pipeline for this index. Index requests will fail if the default pipeline is set and the pipeline does not exist.
deletionProtection Boolean
elasticsearchConnections List<ElasticsearchIndexElasticsearchConnection>
Elasticsearch connection configuration block.

Deprecated: Deprecated

finalPipeline String
Final ingest pipeline for the index. Indexing requests will fail if the final pipeline is set and the pipeline does not exist. The final pipeline always runs after the request pipeline (if specified) and the default pipeline (if it exists). The special pipeline name _none indicates no ingest pipeline will run.
gcDeletes String
The length of time that a deleted document's version number remains available for further versioned operations.
highlightMaxAnalyzedOffset Double
The maximum number of characters that will be analyzed for a highlight request.
indexingSlowlogLevel String
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
indexingSlowlogSource String
Set the number of characters of the _source to include in the slowlog lines, false or 0 will skip logging the source entirely and setting it to true will log the entire source regardless of size. The original _source is reformatted by default to make sure that it fits on a single log line.
indexingSlowlogThresholdIndexDebug String
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 2s
indexingSlowlogThresholdIndexInfo String
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 5s
indexingSlowlogThresholdIndexTrace String
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 500ms
indexingSlowlogThresholdIndexWarn String
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 10s
loadFixedBitsetFiltersEagerly Boolean
Indicates whether cached filters are pre-loaded for nested queries. This can be set only on creation.
mappingCoerce Boolean
Set index level coercion setting that is applied to all mapping types.
mappings String
Mapping for fields in the index. If specified, this mapping can include: field names, field data types, mapping parameters. NOTE: - Changing datatypes in the existing mappings will force index to be re-created. - Removing field will be ignored by default same as elasticsearch. You need to recreate the index to remove field completely.
masterTimeout String
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s. This value is ignored when running against Serverless projects.
maxDocvalueFieldsSearch Double
The maximum number of docvalue_fields that are allowed in a query.
maxInnerResultWindow Double
The maximum value of from + size for inner hits definition and top hits aggregations to this index.
maxNgramDiff Double
The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
maxRefreshListeners Double
Maximum number of refresh listeners available on each shard of the index.
maxRegexLength Double
The maximum length of regex that can be used in Regexp Query.
maxRescoreWindow Double
The maximum value of window_size for rescore requests in searches of this index.
maxResultWindow Double
The maximum value of from + size for searches to this index.
maxScriptFields Double
The maximum number of script_fields that are allowed in a query.
maxShingleDiff Double
The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
maxTermsCount Double
The maximum number of terms that can be used in Terms Query.
name String
Name of the index you wish to create.
numberOfReplicas Double
Number of shard replicas.
numberOfRoutingShards Double
Value used with numberofshards to route documents to a primary shard. This can be set only on creation.
numberOfShards Double
Number of shards for the index. This can be set only on creation.
queryDefaultFields List<String>
Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
refreshInterval String
How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to -1 to disable refresh.
routingAllocationEnable String
Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
routingPartitionSize Double
The number of shards a custom routing value can go to. This can be set only on creation.
routingRebalanceEnable String
Enables shard rebalancing for this index. It can be set to: all, primaries , replicas , none.
searchIdleAfter String
How long a shard can not receive a search or get request until it’s considered search idle.
searchSlowlogLevel String
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
searchSlowlogThresholdFetchDebug String
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 2s
searchSlowlogThresholdFetchInfo String
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 5s
searchSlowlogThresholdFetchTrace String
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 500ms
searchSlowlogThresholdFetchWarn String
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 10s
searchSlowlogThresholdQueryDebug String
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 2s
searchSlowlogThresholdQueryInfo String
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 5s
searchSlowlogThresholdQueryTrace String
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 500ms
searchSlowlogThresholdQueryWarn String
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 10s
settings List<ElasticsearchIndexSetting>
DEPRECATED: Please use dedicated setting field. Configuration options for the index. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-modules-settings. NOTE: Static index settings (see: https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#staticindex_settings) can be only set on the index creation and later cannot be removed or updated - apply will return error

Deprecated: Deprecated

shardCheckOnStartup String
Whether or not shards should be checked for corruption before opening. When corruption is detected, it will prevent the shard from being opened. Accepts false, true, checksum.
sortFields List<String>
The field to sort shards in this index by.
sortOrders List<String>
The direction to sort shards in. Accepts asc, desc.
timeout String
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.
unassignedNodeLeftDelayedTimeout String
Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g. 10s
waitForActiveShards String
The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (numberofreplicas+1). Default: 1, the primary shard. This value is ignored when running against Serverless projects.
aliases ElasticsearchIndexAlias[]
Aliases for the index.
analysisAnalyzer string
A JSON string describing the analyzers applied to the index.
analysisCharFilter string
A JSON string describing the char_filters applied to the index.
analysisFilter string
A JSON string describing the filters applied to the index.
analysisNormalizer string
A JSON string describing the normalizers applied to the index.
analysisTokenizer string
A JSON string describing the tokenizers applied to the index.
analyzeMaxTokenCount number
The maximum number of tokens that can be produced using _analyze API.
autoExpandReplicas string
Set the number of replicas to the node count in the cluster. Set to a dash delimited lower and upper bound (e.g. 0-5) or use all for the upper bound (e.g. 0-all)
blocksMetadata boolean
Set to true to disable index metadata reads and writes.
blocksRead boolean
Set to true to disable read operations against the index.
blocksReadOnly boolean
Set to true to make the index and index metadata read only, false to allow writes and metadata changes.
blocksReadOnlyAllowDelete boolean
Identical to index.blocks.read_only but allows deleting the index to free up resources.
blocksWrite boolean
Set to true to disable data write operations against the index. This setting does not affect metadata.
codec string
The default value compresses stored data with LZ4 compression, but this can be set to best_compression which uses DEFLATE for a higher compression ratio. This can be set only on creation.
defaultPipeline string
The default ingest node pipeline for this index. Index requests will fail if the default pipeline is set and the pipeline does not exist.
deletionProtection boolean
elasticsearchConnections ElasticsearchIndexElasticsearchConnection[]
Elasticsearch connection configuration block.

Deprecated: Deprecated

finalPipeline string
Final ingest pipeline for the index. Indexing requests will fail if the final pipeline is set and the pipeline does not exist. The final pipeline always runs after the request pipeline (if specified) and the default pipeline (if it exists). The special pipeline name _none indicates no ingest pipeline will run.
gcDeletes string
The length of time that a deleted document's version number remains available for further versioned operations.
highlightMaxAnalyzedOffset number
The maximum number of characters that will be analyzed for a highlight request.
indexingSlowlogLevel string
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
indexingSlowlogSource string
Set the number of characters of the _source to include in the slowlog lines, false or 0 will skip logging the source entirely and setting it to true will log the entire source regardless of size. The original _source is reformatted by default to make sure that it fits on a single log line.
indexingSlowlogThresholdIndexDebug string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 2s
indexingSlowlogThresholdIndexInfo string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 5s
indexingSlowlogThresholdIndexTrace string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 500ms
indexingSlowlogThresholdIndexWarn string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 10s
loadFixedBitsetFiltersEagerly boolean
Indicates whether cached filters are pre-loaded for nested queries. This can be set only on creation.
mappingCoerce boolean
Set index level coercion setting that is applied to all mapping types.
mappings string
Mapping for fields in the index. If specified, this mapping can include: field names, field data types, mapping parameters. NOTE: - Changing datatypes in the existing mappings will force index to be re-created. - Removing field will be ignored by default same as elasticsearch. You need to recreate the index to remove field completely.
masterTimeout string
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s. This value is ignored when running against Serverless projects.
maxDocvalueFieldsSearch number
The maximum number of docvalue_fields that are allowed in a query.
maxInnerResultWindow number
The maximum value of from + size for inner hits definition and top hits aggregations to this index.
maxNgramDiff number
The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
maxRefreshListeners number
Maximum number of refresh listeners available on each shard of the index.
maxRegexLength number
The maximum length of regex that can be used in Regexp Query.
maxRescoreWindow number
The maximum value of window_size for rescore requests in searches of this index.
maxResultWindow number
The maximum value of from + size for searches to this index.
maxScriptFields number
The maximum number of script_fields that are allowed in a query.
maxShingleDiff number
The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
maxTermsCount number
The maximum number of terms that can be used in Terms Query.
name string
Name of the index you wish to create.
numberOfReplicas number
Number of shard replicas.
numberOfRoutingShards number
Value used with numberofshards to route documents to a primary shard. This can be set only on creation.
numberOfShards number
Number of shards for the index. This can be set only on creation.
queryDefaultFields string[]
Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
refreshInterval string
How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to -1 to disable refresh.
routingAllocationEnable string
Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
routingPartitionSize number
The number of shards a custom routing value can go to. This can be set only on creation.
routingRebalanceEnable string
Enables shard rebalancing for this index. It can be set to: all, primaries , replicas , none.
searchIdleAfter string
How long a shard can not receive a search or get request until it’s considered search idle.
searchSlowlogLevel string
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
searchSlowlogThresholdFetchDebug string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 2s
searchSlowlogThresholdFetchInfo string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 5s
searchSlowlogThresholdFetchTrace string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 500ms
searchSlowlogThresholdFetchWarn string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 10s
searchSlowlogThresholdQueryDebug string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 2s
searchSlowlogThresholdQueryInfo string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 5s
searchSlowlogThresholdQueryTrace string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 500ms
searchSlowlogThresholdQueryWarn string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 10s
settings ElasticsearchIndexSetting[]
DEPRECATED: Please use dedicated setting field. Configuration options for the index. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-modules-settings. NOTE: Static index settings (see: https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#staticindex_settings) can be only set on the index creation and later cannot be removed or updated - apply will return error

Deprecated: Deprecated

shardCheckOnStartup string
Whether or not shards should be checked for corruption before opening. When corruption is detected, it will prevent the shard from being opened. Accepts false, true, checksum.
sortFields string[]
The field to sort shards in this index by.
sortOrders string[]
The direction to sort shards in. Accepts asc, desc.
timeout string
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.
unassignedNodeLeftDelayedTimeout string
Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g. 10s
waitForActiveShards string
The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (numberofreplicas+1). Default: 1, the primary shard. This value is ignored when running against Serverless projects.
aliases Sequence[ElasticsearchIndexAliasArgs]
Aliases for the index.
analysis_analyzer str
A JSON string describing the analyzers applied to the index.
analysis_char_filter str
A JSON string describing the char_filters applied to the index.
analysis_filter str
A JSON string describing the filters applied to the index.
analysis_normalizer str
A JSON string describing the normalizers applied to the index.
analysis_tokenizer str
A JSON string describing the tokenizers applied to the index.
analyze_max_token_count float
The maximum number of tokens that can be produced using _analyze API.
auto_expand_replicas str
Set the number of replicas to the node count in the cluster. Set to a dash delimited lower and upper bound (e.g. 0-5) or use all for the upper bound (e.g. 0-all)
blocks_metadata bool
Set to true to disable index metadata reads and writes.
blocks_read bool
Set to true to disable read operations against the index.
blocks_read_only bool
Set to true to make the index and index metadata read only, false to allow writes and metadata changes.
blocks_read_only_allow_delete bool
Identical to index.blocks.read_only but allows deleting the index to free up resources.
blocks_write bool
Set to true to disable data write operations against the index. This setting does not affect metadata.
codec str
The default value compresses stored data with LZ4 compression, but this can be set to best_compression which uses DEFLATE for a higher compression ratio. This can be set only on creation.
default_pipeline str
The default ingest node pipeline for this index. Index requests will fail if the default pipeline is set and the pipeline does not exist.
deletion_protection bool
elasticsearch_connections Sequence[ElasticsearchIndexElasticsearchConnectionArgs]
Elasticsearch connection configuration block.

Deprecated: Deprecated

final_pipeline str
Final ingest pipeline for the index. Indexing requests will fail if the final pipeline is set and the pipeline does not exist. The final pipeline always runs after the request pipeline (if specified) and the default pipeline (if it exists). The special pipeline name _none indicates no ingest pipeline will run.
gc_deletes str
The length of time that a deleted document's version number remains available for further versioned operations.
highlight_max_analyzed_offset float
The maximum number of characters that will be analyzed for a highlight request.
indexing_slowlog_level str
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
indexing_slowlog_source str
Set the number of characters of the _source to include in the slowlog lines, false or 0 will skip logging the source entirely and setting it to true will log the entire source regardless of size. The original _source is reformatted by default to make sure that it fits on a single log line.
indexing_slowlog_threshold_index_debug str
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 2s
indexing_slowlog_threshold_index_info str
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 5s
indexing_slowlog_threshold_index_trace str
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 500ms
indexing_slowlog_threshold_index_warn str
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 10s
load_fixed_bitset_filters_eagerly bool
Indicates whether cached filters are pre-loaded for nested queries. This can be set only on creation.
mapping_coerce bool
Set index level coercion setting that is applied to all mapping types.
mappings str
Mapping for fields in the index. If specified, this mapping can include: field names, field data types, mapping parameters. NOTE: - Changing datatypes in the existing mappings will force index to be re-created. - Removing field will be ignored by default same as elasticsearch. You need to recreate the index to remove field completely.
master_timeout str
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s. This value is ignored when running against Serverless projects.
max_docvalue_fields_search float
The maximum number of docvalue_fields that are allowed in a query.
max_inner_result_window float
The maximum value of from + size for inner hits definition and top hits aggregations to this index.
max_ngram_diff float
The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
max_refresh_listeners float
Maximum number of refresh listeners available on each shard of the index.
max_regex_length float
The maximum length of regex that can be used in Regexp Query.
max_rescore_window float
The maximum value of window_size for rescore requests in searches of this index.
max_result_window float
The maximum value of from + size for searches to this index.
max_script_fields float
The maximum number of script_fields that are allowed in a query.
max_shingle_diff float
The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
max_terms_count float
The maximum number of terms that can be used in Terms Query.
name str
Name of the index you wish to create.
number_of_replicas float
Number of shard replicas.
number_of_routing_shards float
Value used with numberofshards to route documents to a primary shard. This can be set only on creation.
number_of_shards float
Number of shards for the index. This can be set only on creation.
query_default_fields Sequence[str]
Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
refresh_interval str
How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to -1 to disable refresh.
routing_allocation_enable str
Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
routing_partition_size float
The number of shards a custom routing value can go to. This can be set only on creation.
routing_rebalance_enable str
Enables shard rebalancing for this index. It can be set to: all, primaries , replicas , none.
search_idle_after str
How long a shard can not receive a search or get request until it’s considered search idle.
search_slowlog_level str
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
search_slowlog_threshold_fetch_debug str
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 2s
search_slowlog_threshold_fetch_info str
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 5s
search_slowlog_threshold_fetch_trace str
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 500ms
search_slowlog_threshold_fetch_warn str
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 10s
search_slowlog_threshold_query_debug str
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 2s
search_slowlog_threshold_query_info str
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 5s
search_slowlog_threshold_query_trace str
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 500ms
search_slowlog_threshold_query_warn str
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 10s
settings Sequence[ElasticsearchIndexSettingArgs]
DEPRECATED: Please use dedicated setting field. Configuration options for the index. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-modules-settings. NOTE: Static index settings (see: https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#staticindex_settings) can be only set on the index creation and later cannot be removed or updated - apply will return error

Deprecated: Deprecated

shard_check_on_startup str
Whether or not shards should be checked for corruption before opening. When corruption is detected, it will prevent the shard from being opened. Accepts false, true, checksum.
sort_fields Sequence[str]
The field to sort shards in this index by.
sort_orders Sequence[str]
The direction to sort shards in. Accepts asc, desc.
timeout str
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.
unassigned_node_left_delayed_timeout str
Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g. 10s
wait_for_active_shards str
The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (numberofreplicas+1). Default: 1, the primary shard. This value is ignored when running against Serverless projects.
aliases List<Property Map>
Aliases for the index.
analysisAnalyzer String
A JSON string describing the analyzers applied to the index.
analysisCharFilter String
A JSON string describing the char_filters applied to the index.
analysisFilter String
A JSON string describing the filters applied to the index.
analysisNormalizer String
A JSON string describing the normalizers applied to the index.
analysisTokenizer String
A JSON string describing the tokenizers applied to the index.
analyzeMaxTokenCount Number
The maximum number of tokens that can be produced using _analyze API.
autoExpandReplicas String
Set the number of replicas to the node count in the cluster. Set to a dash delimited lower and upper bound (e.g. 0-5) or use all for the upper bound (e.g. 0-all)
blocksMetadata Boolean
Set to true to disable index metadata reads and writes.
blocksRead Boolean
Set to true to disable read operations against the index.
blocksReadOnly Boolean
Set to true to make the index and index metadata read only, false to allow writes and metadata changes.
blocksReadOnlyAllowDelete Boolean
Identical to index.blocks.read_only but allows deleting the index to free up resources.
blocksWrite Boolean
Set to true to disable data write operations against the index. This setting does not affect metadata.
codec String
The default value compresses stored data with LZ4 compression, but this can be set to best_compression which uses DEFLATE for a higher compression ratio. This can be set only on creation.
defaultPipeline String
The default ingest node pipeline for this index. Index requests will fail if the default pipeline is set and the pipeline does not exist.
deletionProtection Boolean
elasticsearchConnections List<Property Map>
Elasticsearch connection configuration block.

Deprecated: Deprecated

finalPipeline String
Final ingest pipeline for the index. Indexing requests will fail if the final pipeline is set and the pipeline does not exist. The final pipeline always runs after the request pipeline (if specified) and the default pipeline (if it exists). The special pipeline name _none indicates no ingest pipeline will run.
gcDeletes String
The length of time that a deleted document's version number remains available for further versioned operations.
highlightMaxAnalyzedOffset Number
The maximum number of characters that will be analyzed for a highlight request.
indexingSlowlogLevel String
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
indexingSlowlogSource String
Set the number of characters of the _source to include in the slowlog lines, false or 0 will skip logging the source entirely and setting it to true will log the entire source regardless of size. The original _source is reformatted by default to make sure that it fits on a single log line.
indexingSlowlogThresholdIndexDebug String
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 2s
indexingSlowlogThresholdIndexInfo String
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 5s
indexingSlowlogThresholdIndexTrace String
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 500ms
indexingSlowlogThresholdIndexWarn String
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 10s
loadFixedBitsetFiltersEagerly Boolean
Indicates whether cached filters are pre-loaded for nested queries. This can be set only on creation.
mappingCoerce Boolean
Set index level coercion setting that is applied to all mapping types.
mappings String
Mapping for fields in the index. If specified, this mapping can include: field names, field data types, mapping parameters. NOTE: - Changing datatypes in the existing mappings will force index to be re-created. - Removing field will be ignored by default same as elasticsearch. You need to recreate the index to remove field completely.
masterTimeout String
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s. This value is ignored when running against Serverless projects.
maxDocvalueFieldsSearch Number
The maximum number of docvalue_fields that are allowed in a query.
maxInnerResultWindow Number
The maximum value of from + size for inner hits definition and top hits aggregations to this index.
maxNgramDiff Number
The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
maxRefreshListeners Number
Maximum number of refresh listeners available on each shard of the index.
maxRegexLength Number
The maximum length of regex that can be used in Regexp Query.
maxRescoreWindow Number
The maximum value of window_size for rescore requests in searches of this index.
maxResultWindow Number
The maximum value of from + size for searches to this index.
maxScriptFields Number
The maximum number of script_fields that are allowed in a query.
maxShingleDiff Number
The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
maxTermsCount Number
The maximum number of terms that can be used in Terms Query.
name String
Name of the index you wish to create.
numberOfReplicas Number
Number of shard replicas.
numberOfRoutingShards Number
Value used with numberofshards to route documents to a primary shard. This can be set only on creation.
numberOfShards Number
Number of shards for the index. This can be set only on creation.
queryDefaultFields List<String>
Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
refreshInterval String
How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to -1 to disable refresh.
routingAllocationEnable String
Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
routingPartitionSize Number
The number of shards a custom routing value can go to. This can be set only on creation.
routingRebalanceEnable String
Enables shard rebalancing for this index. It can be set to: all, primaries , replicas , none.
searchIdleAfter String
How long a shard can not receive a search or get request until it’s considered search idle.
searchSlowlogLevel String
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
searchSlowlogThresholdFetchDebug String
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 2s
searchSlowlogThresholdFetchInfo String
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 5s
searchSlowlogThresholdFetchTrace String
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 500ms
searchSlowlogThresholdFetchWarn String
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 10s
searchSlowlogThresholdQueryDebug String
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 2s
searchSlowlogThresholdQueryInfo String
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 5s
searchSlowlogThresholdQueryTrace String
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 500ms
searchSlowlogThresholdQueryWarn String
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 10s
settings List<Property Map>
DEPRECATED: Please use dedicated setting field. Configuration options for the index. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-modules-settings. NOTE: Static index settings (see: https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#staticindex_settings) can be only set on the index creation and later cannot be removed or updated - apply will return error

Deprecated: Deprecated

shardCheckOnStartup String
Whether or not shards should be checked for corruption before opening. When corruption is detected, it will prevent the shard from being opened. Accepts false, true, checksum.
sortFields List<String>
The field to sort shards in this index by.
sortOrders List<String>
The direction to sort shards in. Accepts asc, desc.
timeout String
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.
unassignedNodeLeftDelayedTimeout String
Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g. 10s
waitForActiveShards String
The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (numberofreplicas+1). Default: 1, the primary shard. This value is ignored when running against Serverless projects.

Outputs

All input properties are implicitly available as output properties. Additionally, the ElasticsearchIndex resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
SettingsRaw string
All raw settings fetched from the cluster.
Id string
The provider-assigned unique ID for this managed resource.
SettingsRaw string
All raw settings fetched from the cluster.
id String
The provider-assigned unique ID for this managed resource.
settingsRaw String
All raw settings fetched from the cluster.
id string
The provider-assigned unique ID for this managed resource.
settingsRaw string
All raw settings fetched from the cluster.
id str
The provider-assigned unique ID for this managed resource.
settings_raw str
All raw settings fetched from the cluster.
id String
The provider-assigned unique ID for this managed resource.
settingsRaw String
All raw settings fetched from the cluster.

Look up Existing ElasticsearchIndex Resource

Get an existing ElasticsearchIndex resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ElasticsearchIndexState, opts?: CustomResourceOptions): ElasticsearchIndex
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aliases: Optional[Sequence[ElasticsearchIndexAliasArgs]] = None,
        analysis_analyzer: Optional[str] = None,
        analysis_char_filter: Optional[str] = None,
        analysis_filter: Optional[str] = None,
        analysis_normalizer: Optional[str] = None,
        analysis_tokenizer: Optional[str] = None,
        analyze_max_token_count: Optional[float] = None,
        auto_expand_replicas: Optional[str] = None,
        blocks_metadata: Optional[bool] = None,
        blocks_read: Optional[bool] = None,
        blocks_read_only: Optional[bool] = None,
        blocks_read_only_allow_delete: Optional[bool] = None,
        blocks_write: Optional[bool] = None,
        codec: Optional[str] = None,
        default_pipeline: Optional[str] = None,
        deletion_protection: Optional[bool] = None,
        elasticsearch_connections: Optional[Sequence[ElasticsearchIndexElasticsearchConnectionArgs]] = None,
        final_pipeline: Optional[str] = None,
        gc_deletes: Optional[str] = None,
        highlight_max_analyzed_offset: Optional[float] = None,
        indexing_slowlog_level: Optional[str] = None,
        indexing_slowlog_source: Optional[str] = None,
        indexing_slowlog_threshold_index_debug: Optional[str] = None,
        indexing_slowlog_threshold_index_info: Optional[str] = None,
        indexing_slowlog_threshold_index_trace: Optional[str] = None,
        indexing_slowlog_threshold_index_warn: Optional[str] = None,
        load_fixed_bitset_filters_eagerly: Optional[bool] = None,
        mapping_coerce: Optional[bool] = None,
        mappings: Optional[str] = None,
        master_timeout: Optional[str] = None,
        max_docvalue_fields_search: Optional[float] = None,
        max_inner_result_window: Optional[float] = None,
        max_ngram_diff: Optional[float] = None,
        max_refresh_listeners: Optional[float] = None,
        max_regex_length: Optional[float] = None,
        max_rescore_window: Optional[float] = None,
        max_result_window: Optional[float] = None,
        max_script_fields: Optional[float] = None,
        max_shingle_diff: Optional[float] = None,
        max_terms_count: Optional[float] = None,
        name: Optional[str] = None,
        number_of_replicas: Optional[float] = None,
        number_of_routing_shards: Optional[float] = None,
        number_of_shards: Optional[float] = None,
        query_default_fields: Optional[Sequence[str]] = None,
        refresh_interval: Optional[str] = None,
        routing_allocation_enable: Optional[str] = None,
        routing_partition_size: Optional[float] = None,
        routing_rebalance_enable: Optional[str] = None,
        search_idle_after: Optional[str] = None,
        search_slowlog_level: Optional[str] = None,
        search_slowlog_threshold_fetch_debug: Optional[str] = None,
        search_slowlog_threshold_fetch_info: Optional[str] = None,
        search_slowlog_threshold_fetch_trace: Optional[str] = None,
        search_slowlog_threshold_fetch_warn: Optional[str] = None,
        search_slowlog_threshold_query_debug: Optional[str] = None,
        search_slowlog_threshold_query_info: Optional[str] = None,
        search_slowlog_threshold_query_trace: Optional[str] = None,
        search_slowlog_threshold_query_warn: Optional[str] = None,
        settings: Optional[Sequence[ElasticsearchIndexSettingArgs]] = None,
        settings_raw: Optional[str] = None,
        shard_check_on_startup: Optional[str] = None,
        sort_fields: Optional[Sequence[str]] = None,
        sort_orders: Optional[Sequence[str]] = None,
        timeout: Optional[str] = None,
        unassigned_node_left_delayed_timeout: Optional[str] = None,
        wait_for_active_shards: Optional[str] = None) -> ElasticsearchIndex
func GetElasticsearchIndex(ctx *Context, name string, id IDInput, state *ElasticsearchIndexState, opts ...ResourceOption) (*ElasticsearchIndex, error)
public static ElasticsearchIndex Get(string name, Input<string> id, ElasticsearchIndexState? state, CustomResourceOptions? opts = null)
public static ElasticsearchIndex get(String name, Output<String> id, ElasticsearchIndexState state, CustomResourceOptions options)
resources:  _:    type: elasticstack:ElasticsearchIndex    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Aliases List<ElasticsearchIndexAlias>
Aliases for the index.
AnalysisAnalyzer string
A JSON string describing the analyzers applied to the index.
AnalysisCharFilter string
A JSON string describing the char_filters applied to the index.
AnalysisFilter string
A JSON string describing the filters applied to the index.
AnalysisNormalizer string
A JSON string describing the normalizers applied to the index.
AnalysisTokenizer string
A JSON string describing the tokenizers applied to the index.
AnalyzeMaxTokenCount double
The maximum number of tokens that can be produced using _analyze API.
AutoExpandReplicas string
Set the number of replicas to the node count in the cluster. Set to a dash delimited lower and upper bound (e.g. 0-5) or use all for the upper bound (e.g. 0-all)
BlocksMetadata bool
Set to true to disable index metadata reads and writes.
BlocksRead bool
Set to true to disable read operations against the index.
BlocksReadOnly bool
Set to true to make the index and index metadata read only, false to allow writes and metadata changes.
BlocksReadOnlyAllowDelete bool
Identical to index.blocks.read_only but allows deleting the index to free up resources.
BlocksWrite bool
Set to true to disable data write operations against the index. This setting does not affect metadata.
Codec string
The default value compresses stored data with LZ4 compression, but this can be set to best_compression which uses DEFLATE for a higher compression ratio. This can be set only on creation.
DefaultPipeline string
The default ingest node pipeline for this index. Index requests will fail if the default pipeline is set and the pipeline does not exist.
DeletionProtection bool
ElasticsearchConnections List<ElasticsearchIndexElasticsearchConnection>
Elasticsearch connection configuration block.

Deprecated: Deprecated

FinalPipeline string
Final ingest pipeline for the index. Indexing requests will fail if the final pipeline is set and the pipeline does not exist. The final pipeline always runs after the request pipeline (if specified) and the default pipeline (if it exists). The special pipeline name _none indicates no ingest pipeline will run.
GcDeletes string
The length of time that a deleted document's version number remains available for further versioned operations.
HighlightMaxAnalyzedOffset double
The maximum number of characters that will be analyzed for a highlight request.
IndexingSlowlogLevel string
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
IndexingSlowlogSource string
Set the number of characters of the _source to include in the slowlog lines, false or 0 will skip logging the source entirely and setting it to true will log the entire source regardless of size. The original _source is reformatted by default to make sure that it fits on a single log line.
IndexingSlowlogThresholdIndexDebug string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 2s
IndexingSlowlogThresholdIndexInfo string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 5s
IndexingSlowlogThresholdIndexTrace string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 500ms
IndexingSlowlogThresholdIndexWarn string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 10s
LoadFixedBitsetFiltersEagerly bool
Indicates whether cached filters are pre-loaded for nested queries. This can be set only on creation.
MappingCoerce bool
Set index level coercion setting that is applied to all mapping types.
Mappings string
Mapping for fields in the index. If specified, this mapping can include: field names, field data types, mapping parameters. NOTE: - Changing datatypes in the existing mappings will force index to be re-created. - Removing field will be ignored by default same as elasticsearch. You need to recreate the index to remove field completely.
MasterTimeout string
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s. This value is ignored when running against Serverless projects.
MaxDocvalueFieldsSearch double
The maximum number of docvalue_fields that are allowed in a query.
MaxInnerResultWindow double
The maximum value of from + size for inner hits definition and top hits aggregations to this index.
MaxNgramDiff double
The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
MaxRefreshListeners double
Maximum number of refresh listeners available on each shard of the index.
MaxRegexLength double
The maximum length of regex that can be used in Regexp Query.
MaxRescoreWindow double
The maximum value of window_size for rescore requests in searches of this index.
MaxResultWindow double
The maximum value of from + size for searches to this index.
MaxScriptFields double
The maximum number of script_fields that are allowed in a query.
MaxShingleDiff double
The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
MaxTermsCount double
The maximum number of terms that can be used in Terms Query.
Name string
Name of the index you wish to create.
NumberOfReplicas double
Number of shard replicas.
NumberOfRoutingShards double
Value used with numberofshards to route documents to a primary shard. This can be set only on creation.
NumberOfShards double
Number of shards for the index. This can be set only on creation.
QueryDefaultFields List<string>
Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
RefreshInterval string
How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to -1 to disable refresh.
RoutingAllocationEnable string
Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
RoutingPartitionSize double
The number of shards a custom routing value can go to. This can be set only on creation.
RoutingRebalanceEnable string
Enables shard rebalancing for this index. It can be set to: all, primaries , replicas , none.
SearchIdleAfter string
How long a shard can not receive a search or get request until it’s considered search idle.
SearchSlowlogLevel string
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
SearchSlowlogThresholdFetchDebug string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 2s
SearchSlowlogThresholdFetchInfo string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 5s
SearchSlowlogThresholdFetchTrace string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 500ms
SearchSlowlogThresholdFetchWarn string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 10s
SearchSlowlogThresholdQueryDebug string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 2s
SearchSlowlogThresholdQueryInfo string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 5s
SearchSlowlogThresholdQueryTrace string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 500ms
SearchSlowlogThresholdQueryWarn string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 10s
Settings List<ElasticsearchIndexSetting>
DEPRECATED: Please use dedicated setting field. Configuration options for the index. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-modules-settings. NOTE: Static index settings (see: https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#staticindex_settings) can be only set on the index creation and later cannot be removed or updated - apply will return error

Deprecated: Deprecated

SettingsRaw string
All raw settings fetched from the cluster.
ShardCheckOnStartup string
Whether or not shards should be checked for corruption before opening. When corruption is detected, it will prevent the shard from being opened. Accepts false, true, checksum.
SortFields List<string>
The field to sort shards in this index by.
SortOrders List<string>
The direction to sort shards in. Accepts asc, desc.
Timeout string
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.
UnassignedNodeLeftDelayedTimeout string
Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g. 10s
WaitForActiveShards string
The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (numberofreplicas+1). Default: 1, the primary shard. This value is ignored when running against Serverless projects.
Aliases []ElasticsearchIndexAliasArgs
Aliases for the index.
AnalysisAnalyzer string
A JSON string describing the analyzers applied to the index.
AnalysisCharFilter string
A JSON string describing the char_filters applied to the index.
AnalysisFilter string
A JSON string describing the filters applied to the index.
AnalysisNormalizer string
A JSON string describing the normalizers applied to the index.
AnalysisTokenizer string
A JSON string describing the tokenizers applied to the index.
AnalyzeMaxTokenCount float64
The maximum number of tokens that can be produced using _analyze API.
AutoExpandReplicas string
Set the number of replicas to the node count in the cluster. Set to a dash delimited lower and upper bound (e.g. 0-5) or use all for the upper bound (e.g. 0-all)
BlocksMetadata bool
Set to true to disable index metadata reads and writes.
BlocksRead bool
Set to true to disable read operations against the index.
BlocksReadOnly bool
Set to true to make the index and index metadata read only, false to allow writes and metadata changes.
BlocksReadOnlyAllowDelete bool
Identical to index.blocks.read_only but allows deleting the index to free up resources.
BlocksWrite bool
Set to true to disable data write operations against the index. This setting does not affect metadata.
Codec string
The default value compresses stored data with LZ4 compression, but this can be set to best_compression which uses DEFLATE for a higher compression ratio. This can be set only on creation.
DefaultPipeline string
The default ingest node pipeline for this index. Index requests will fail if the default pipeline is set and the pipeline does not exist.
DeletionProtection bool
ElasticsearchConnections []ElasticsearchIndexElasticsearchConnectionArgs
Elasticsearch connection configuration block.

Deprecated: Deprecated

FinalPipeline string
Final ingest pipeline for the index. Indexing requests will fail if the final pipeline is set and the pipeline does not exist. The final pipeline always runs after the request pipeline (if specified) and the default pipeline (if it exists). The special pipeline name _none indicates no ingest pipeline will run.
GcDeletes string
The length of time that a deleted document's version number remains available for further versioned operations.
HighlightMaxAnalyzedOffset float64
The maximum number of characters that will be analyzed for a highlight request.
IndexingSlowlogLevel string
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
IndexingSlowlogSource string
Set the number of characters of the _source to include in the slowlog lines, false or 0 will skip logging the source entirely and setting it to true will log the entire source regardless of size. The original _source is reformatted by default to make sure that it fits on a single log line.
IndexingSlowlogThresholdIndexDebug string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 2s
IndexingSlowlogThresholdIndexInfo string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 5s
IndexingSlowlogThresholdIndexTrace string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 500ms
IndexingSlowlogThresholdIndexWarn string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 10s
LoadFixedBitsetFiltersEagerly bool
Indicates whether cached filters are pre-loaded for nested queries. This can be set only on creation.
MappingCoerce bool
Set index level coercion setting that is applied to all mapping types.
Mappings string
Mapping for fields in the index. If specified, this mapping can include: field names, field data types, mapping parameters. NOTE: - Changing datatypes in the existing mappings will force index to be re-created. - Removing field will be ignored by default same as elasticsearch. You need to recreate the index to remove field completely.
MasterTimeout string
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s. This value is ignored when running against Serverless projects.
MaxDocvalueFieldsSearch float64
The maximum number of docvalue_fields that are allowed in a query.
MaxInnerResultWindow float64
The maximum value of from + size for inner hits definition and top hits aggregations to this index.
MaxNgramDiff float64
The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
MaxRefreshListeners float64
Maximum number of refresh listeners available on each shard of the index.
MaxRegexLength float64
The maximum length of regex that can be used in Regexp Query.
MaxRescoreWindow float64
The maximum value of window_size for rescore requests in searches of this index.
MaxResultWindow float64
The maximum value of from + size for searches to this index.
MaxScriptFields float64
The maximum number of script_fields that are allowed in a query.
MaxShingleDiff float64
The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
MaxTermsCount float64
The maximum number of terms that can be used in Terms Query.
Name string
Name of the index you wish to create.
NumberOfReplicas float64
Number of shard replicas.
NumberOfRoutingShards float64
Value used with numberofshards to route documents to a primary shard. This can be set only on creation.
NumberOfShards float64
Number of shards for the index. This can be set only on creation.
QueryDefaultFields []string
Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
RefreshInterval string
How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to -1 to disable refresh.
RoutingAllocationEnable string
Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
RoutingPartitionSize float64
The number of shards a custom routing value can go to. This can be set only on creation.
RoutingRebalanceEnable string
Enables shard rebalancing for this index. It can be set to: all, primaries , replicas , none.
SearchIdleAfter string
How long a shard can not receive a search or get request until it’s considered search idle.
SearchSlowlogLevel string
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
SearchSlowlogThresholdFetchDebug string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 2s
SearchSlowlogThresholdFetchInfo string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 5s
SearchSlowlogThresholdFetchTrace string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 500ms
SearchSlowlogThresholdFetchWarn string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 10s
SearchSlowlogThresholdQueryDebug string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 2s
SearchSlowlogThresholdQueryInfo string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 5s
SearchSlowlogThresholdQueryTrace string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 500ms
SearchSlowlogThresholdQueryWarn string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 10s
Settings []ElasticsearchIndexSettingArgs
DEPRECATED: Please use dedicated setting field. Configuration options for the index. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-modules-settings. NOTE: Static index settings (see: https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#staticindex_settings) can be only set on the index creation and later cannot be removed or updated - apply will return error

Deprecated: Deprecated

SettingsRaw string
All raw settings fetched from the cluster.
ShardCheckOnStartup string
Whether or not shards should be checked for corruption before opening. When corruption is detected, it will prevent the shard from being opened. Accepts false, true, checksum.
SortFields []string
The field to sort shards in this index by.
SortOrders []string
The direction to sort shards in. Accepts asc, desc.
Timeout string
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.
UnassignedNodeLeftDelayedTimeout string
Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g. 10s
WaitForActiveShards string
The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (numberofreplicas+1). Default: 1, the primary shard. This value is ignored when running against Serverless projects.
aliases List<ElasticsearchIndexAlias>
Aliases for the index.
analysisAnalyzer String
A JSON string describing the analyzers applied to the index.
analysisCharFilter String
A JSON string describing the char_filters applied to the index.
analysisFilter String
A JSON string describing the filters applied to the index.
analysisNormalizer String
A JSON string describing the normalizers applied to the index.
analysisTokenizer String
A JSON string describing the tokenizers applied to the index.
analyzeMaxTokenCount Double
The maximum number of tokens that can be produced using _analyze API.
autoExpandReplicas String
Set the number of replicas to the node count in the cluster. Set to a dash delimited lower and upper bound (e.g. 0-5) or use all for the upper bound (e.g. 0-all)
blocksMetadata Boolean
Set to true to disable index metadata reads and writes.
blocksRead Boolean
Set to true to disable read operations against the index.
blocksReadOnly Boolean
Set to true to make the index and index metadata read only, false to allow writes and metadata changes.
blocksReadOnlyAllowDelete Boolean
Identical to index.blocks.read_only but allows deleting the index to free up resources.
blocksWrite Boolean
Set to true to disable data write operations against the index. This setting does not affect metadata.
codec String
The default value compresses stored data with LZ4 compression, but this can be set to best_compression which uses DEFLATE for a higher compression ratio. This can be set only on creation.
defaultPipeline String
The default ingest node pipeline for this index. Index requests will fail if the default pipeline is set and the pipeline does not exist.
deletionProtection Boolean
elasticsearchConnections List<ElasticsearchIndexElasticsearchConnection>
Elasticsearch connection configuration block.

Deprecated: Deprecated

finalPipeline String
Final ingest pipeline for the index. Indexing requests will fail if the final pipeline is set and the pipeline does not exist. The final pipeline always runs after the request pipeline (if specified) and the default pipeline (if it exists). The special pipeline name _none indicates no ingest pipeline will run.
gcDeletes String
The length of time that a deleted document's version number remains available for further versioned operations.
highlightMaxAnalyzedOffset Double
The maximum number of characters that will be analyzed for a highlight request.
indexingSlowlogLevel String
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
indexingSlowlogSource String
Set the number of characters of the _source to include in the slowlog lines, false or 0 will skip logging the source entirely and setting it to true will log the entire source regardless of size. The original _source is reformatted by default to make sure that it fits on a single log line.
indexingSlowlogThresholdIndexDebug String
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 2s
indexingSlowlogThresholdIndexInfo String
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 5s
indexingSlowlogThresholdIndexTrace String
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 500ms
indexingSlowlogThresholdIndexWarn String
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 10s
loadFixedBitsetFiltersEagerly Boolean
Indicates whether cached filters are pre-loaded for nested queries. This can be set only on creation.
mappingCoerce Boolean
Set index level coercion setting that is applied to all mapping types.
mappings String
Mapping for fields in the index. If specified, this mapping can include: field names, field data types, mapping parameters. NOTE: - Changing datatypes in the existing mappings will force index to be re-created. - Removing field will be ignored by default same as elasticsearch. You need to recreate the index to remove field completely.
masterTimeout String
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s. This value is ignored when running against Serverless projects.
maxDocvalueFieldsSearch Double
The maximum number of docvalue_fields that are allowed in a query.
maxInnerResultWindow Double
The maximum value of from + size for inner hits definition and top hits aggregations to this index.
maxNgramDiff Double
The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
maxRefreshListeners Double
Maximum number of refresh listeners available on each shard of the index.
maxRegexLength Double
The maximum length of regex that can be used in Regexp Query.
maxRescoreWindow Double
The maximum value of window_size for rescore requests in searches of this index.
maxResultWindow Double
The maximum value of from + size for searches to this index.
maxScriptFields Double
The maximum number of script_fields that are allowed in a query.
maxShingleDiff Double
The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
maxTermsCount Double
The maximum number of terms that can be used in Terms Query.
name String
Name of the index you wish to create.
numberOfReplicas Double
Number of shard replicas.
numberOfRoutingShards Double
Value used with numberofshards to route documents to a primary shard. This can be set only on creation.
numberOfShards Double
Number of shards for the index. This can be set only on creation.
queryDefaultFields List<String>
Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
refreshInterval String
How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to -1 to disable refresh.
routingAllocationEnable String
Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
routingPartitionSize Double
The number of shards a custom routing value can go to. This can be set only on creation.
routingRebalanceEnable String
Enables shard rebalancing for this index. It can be set to: all, primaries , replicas , none.
searchIdleAfter String
How long a shard can not receive a search or get request until it’s considered search idle.
searchSlowlogLevel String
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
searchSlowlogThresholdFetchDebug String
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 2s
searchSlowlogThresholdFetchInfo String
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 5s
searchSlowlogThresholdFetchTrace String
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 500ms
searchSlowlogThresholdFetchWarn String
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 10s
searchSlowlogThresholdQueryDebug String
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 2s
searchSlowlogThresholdQueryInfo String
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 5s
searchSlowlogThresholdQueryTrace String
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 500ms
searchSlowlogThresholdQueryWarn String
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 10s
settings List<ElasticsearchIndexSetting>
DEPRECATED: Please use dedicated setting field. Configuration options for the index. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-modules-settings. NOTE: Static index settings (see: https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#staticindex_settings) can be only set on the index creation and later cannot be removed or updated - apply will return error

Deprecated: Deprecated

settingsRaw String
All raw settings fetched from the cluster.
shardCheckOnStartup String
Whether or not shards should be checked for corruption before opening. When corruption is detected, it will prevent the shard from being opened. Accepts false, true, checksum.
sortFields List<String>
The field to sort shards in this index by.
sortOrders List<String>
The direction to sort shards in. Accepts asc, desc.
timeout String
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.
unassignedNodeLeftDelayedTimeout String
Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g. 10s
waitForActiveShards String
The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (numberofreplicas+1). Default: 1, the primary shard. This value is ignored when running against Serverless projects.
aliases ElasticsearchIndexAlias[]
Aliases for the index.
analysisAnalyzer string
A JSON string describing the analyzers applied to the index.
analysisCharFilter string
A JSON string describing the char_filters applied to the index.
analysisFilter string
A JSON string describing the filters applied to the index.
analysisNormalizer string
A JSON string describing the normalizers applied to the index.
analysisTokenizer string
A JSON string describing the tokenizers applied to the index.
analyzeMaxTokenCount number
The maximum number of tokens that can be produced using _analyze API.
autoExpandReplicas string
Set the number of replicas to the node count in the cluster. Set to a dash delimited lower and upper bound (e.g. 0-5) or use all for the upper bound (e.g. 0-all)
blocksMetadata boolean
Set to true to disable index metadata reads and writes.
blocksRead boolean
Set to true to disable read operations against the index.
blocksReadOnly boolean
Set to true to make the index and index metadata read only, false to allow writes and metadata changes.
blocksReadOnlyAllowDelete boolean
Identical to index.blocks.read_only but allows deleting the index to free up resources.
blocksWrite boolean
Set to true to disable data write operations against the index. This setting does not affect metadata.
codec string
The default value compresses stored data with LZ4 compression, but this can be set to best_compression which uses DEFLATE for a higher compression ratio. This can be set only on creation.
defaultPipeline string
The default ingest node pipeline for this index. Index requests will fail if the default pipeline is set and the pipeline does not exist.
deletionProtection boolean
elasticsearchConnections ElasticsearchIndexElasticsearchConnection[]
Elasticsearch connection configuration block.

Deprecated: Deprecated

finalPipeline string
Final ingest pipeline for the index. Indexing requests will fail if the final pipeline is set and the pipeline does not exist. The final pipeline always runs after the request pipeline (if specified) and the default pipeline (if it exists). The special pipeline name _none indicates no ingest pipeline will run.
gcDeletes string
The length of time that a deleted document's version number remains available for further versioned operations.
highlightMaxAnalyzedOffset number
The maximum number of characters that will be analyzed for a highlight request.
indexingSlowlogLevel string
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
indexingSlowlogSource string
Set the number of characters of the _source to include in the slowlog lines, false or 0 will skip logging the source entirely and setting it to true will log the entire source regardless of size. The original _source is reformatted by default to make sure that it fits on a single log line.
indexingSlowlogThresholdIndexDebug string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 2s
indexingSlowlogThresholdIndexInfo string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 5s
indexingSlowlogThresholdIndexTrace string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 500ms
indexingSlowlogThresholdIndexWarn string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 10s
loadFixedBitsetFiltersEagerly boolean
Indicates whether cached filters are pre-loaded for nested queries. This can be set only on creation.
mappingCoerce boolean
Set index level coercion setting that is applied to all mapping types.
mappings string
Mapping for fields in the index. If specified, this mapping can include: field names, field data types, mapping parameters. NOTE: - Changing datatypes in the existing mappings will force index to be re-created. - Removing field will be ignored by default same as elasticsearch. You need to recreate the index to remove field completely.
masterTimeout string
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s. This value is ignored when running against Serverless projects.
maxDocvalueFieldsSearch number
The maximum number of docvalue_fields that are allowed in a query.
maxInnerResultWindow number
The maximum value of from + size for inner hits definition and top hits aggregations to this index.
maxNgramDiff number
The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
maxRefreshListeners number
Maximum number of refresh listeners available on each shard of the index.
maxRegexLength number
The maximum length of regex that can be used in Regexp Query.
maxRescoreWindow number
The maximum value of window_size for rescore requests in searches of this index.
maxResultWindow number
The maximum value of from + size for searches to this index.
maxScriptFields number
The maximum number of script_fields that are allowed in a query.
maxShingleDiff number
The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
maxTermsCount number
The maximum number of terms that can be used in Terms Query.
name string
Name of the index you wish to create.
numberOfReplicas number
Number of shard replicas.
numberOfRoutingShards number
Value used with numberofshards to route documents to a primary shard. This can be set only on creation.
numberOfShards number
Number of shards for the index. This can be set only on creation.
queryDefaultFields string[]
Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
refreshInterval string
How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to -1 to disable refresh.
routingAllocationEnable string
Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
routingPartitionSize number
The number of shards a custom routing value can go to. This can be set only on creation.
routingRebalanceEnable string
Enables shard rebalancing for this index. It can be set to: all, primaries , replicas , none.
searchIdleAfter string
How long a shard can not receive a search or get request until it’s considered search idle.
searchSlowlogLevel string
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
searchSlowlogThresholdFetchDebug string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 2s
searchSlowlogThresholdFetchInfo string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 5s
searchSlowlogThresholdFetchTrace string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 500ms
searchSlowlogThresholdFetchWarn string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 10s
searchSlowlogThresholdQueryDebug string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 2s
searchSlowlogThresholdQueryInfo string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 5s
searchSlowlogThresholdQueryTrace string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 500ms
searchSlowlogThresholdQueryWarn string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 10s
settings ElasticsearchIndexSetting[]
DEPRECATED: Please use dedicated setting field. Configuration options for the index. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-modules-settings. NOTE: Static index settings (see: https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#staticindex_settings) can be only set on the index creation and later cannot be removed or updated - apply will return error

Deprecated: Deprecated

settingsRaw string
All raw settings fetched from the cluster.
shardCheckOnStartup string
Whether or not shards should be checked for corruption before opening. When corruption is detected, it will prevent the shard from being opened. Accepts false, true, checksum.
sortFields string[]
The field to sort shards in this index by.
sortOrders string[]
The direction to sort shards in. Accepts asc, desc.
timeout string
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.
unassignedNodeLeftDelayedTimeout string
Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g. 10s
waitForActiveShards string
The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (numberofreplicas+1). Default: 1, the primary shard. This value is ignored when running against Serverless projects.
aliases Sequence[ElasticsearchIndexAliasArgs]
Aliases for the index.
analysis_analyzer str
A JSON string describing the analyzers applied to the index.
analysis_char_filter str
A JSON string describing the char_filters applied to the index.
analysis_filter str
A JSON string describing the filters applied to the index.
analysis_normalizer str
A JSON string describing the normalizers applied to the index.
analysis_tokenizer str
A JSON string describing the tokenizers applied to the index.
analyze_max_token_count float
The maximum number of tokens that can be produced using _analyze API.
auto_expand_replicas str
Set the number of replicas to the node count in the cluster. Set to a dash delimited lower and upper bound (e.g. 0-5) or use all for the upper bound (e.g. 0-all)
blocks_metadata bool
Set to true to disable index metadata reads and writes.
blocks_read bool
Set to true to disable read operations against the index.
blocks_read_only bool
Set to true to make the index and index metadata read only, false to allow writes and metadata changes.
blocks_read_only_allow_delete bool
Identical to index.blocks.read_only but allows deleting the index to free up resources.
blocks_write bool
Set to true to disable data write operations against the index. This setting does not affect metadata.
codec str
The default value compresses stored data with LZ4 compression, but this can be set to best_compression which uses DEFLATE for a higher compression ratio. This can be set only on creation.
default_pipeline str
The default ingest node pipeline for this index. Index requests will fail if the default pipeline is set and the pipeline does not exist.
deletion_protection bool
elasticsearch_connections Sequence[ElasticsearchIndexElasticsearchConnectionArgs]
Elasticsearch connection configuration block.

Deprecated: Deprecated

final_pipeline str
Final ingest pipeline for the index. Indexing requests will fail if the final pipeline is set and the pipeline does not exist. The final pipeline always runs after the request pipeline (if specified) and the default pipeline (if it exists). The special pipeline name _none indicates no ingest pipeline will run.
gc_deletes str
The length of time that a deleted document's version number remains available for further versioned operations.
highlight_max_analyzed_offset float
The maximum number of characters that will be analyzed for a highlight request.
indexing_slowlog_level str
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
indexing_slowlog_source str
Set the number of characters of the _source to include in the slowlog lines, false or 0 will skip logging the source entirely and setting it to true will log the entire source regardless of size. The original _source is reformatted by default to make sure that it fits on a single log line.
indexing_slowlog_threshold_index_debug str
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 2s
indexing_slowlog_threshold_index_info str
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 5s
indexing_slowlog_threshold_index_trace str
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 500ms
indexing_slowlog_threshold_index_warn str
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 10s
load_fixed_bitset_filters_eagerly bool
Indicates whether cached filters are pre-loaded for nested queries. This can be set only on creation.
mapping_coerce bool
Set index level coercion setting that is applied to all mapping types.
mappings str
Mapping for fields in the index. If specified, this mapping can include: field names, field data types, mapping parameters. NOTE: - Changing datatypes in the existing mappings will force index to be re-created. - Removing field will be ignored by default same as elasticsearch. You need to recreate the index to remove field completely.
master_timeout str
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s. This value is ignored when running against Serverless projects.
max_docvalue_fields_search float
The maximum number of docvalue_fields that are allowed in a query.
max_inner_result_window float
The maximum value of from + size for inner hits definition and top hits aggregations to this index.
max_ngram_diff float
The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
max_refresh_listeners float
Maximum number of refresh listeners available on each shard of the index.
max_regex_length float
The maximum length of regex that can be used in Regexp Query.
max_rescore_window float
The maximum value of window_size for rescore requests in searches of this index.
max_result_window float
The maximum value of from + size for searches to this index.
max_script_fields float
The maximum number of script_fields that are allowed in a query.
max_shingle_diff float
The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
max_terms_count float
The maximum number of terms that can be used in Terms Query.
name str
Name of the index you wish to create.
number_of_replicas float
Number of shard replicas.
number_of_routing_shards float
Value used with numberofshards to route documents to a primary shard. This can be set only on creation.
number_of_shards float
Number of shards for the index. This can be set only on creation.
query_default_fields Sequence[str]
Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
refresh_interval str
How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to -1 to disable refresh.
routing_allocation_enable str
Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
routing_partition_size float
The number of shards a custom routing value can go to. This can be set only on creation.
routing_rebalance_enable str
Enables shard rebalancing for this index. It can be set to: all, primaries , replicas , none.
search_idle_after str
How long a shard can not receive a search or get request until it’s considered search idle.
search_slowlog_level str
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
search_slowlog_threshold_fetch_debug str
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 2s
search_slowlog_threshold_fetch_info str
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 5s
search_slowlog_threshold_fetch_trace str
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 500ms
search_slowlog_threshold_fetch_warn str
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 10s
search_slowlog_threshold_query_debug str
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 2s
search_slowlog_threshold_query_info str
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 5s
search_slowlog_threshold_query_trace str
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 500ms
search_slowlog_threshold_query_warn str
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 10s
settings Sequence[ElasticsearchIndexSettingArgs]
DEPRECATED: Please use dedicated setting field. Configuration options for the index. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-modules-settings. NOTE: Static index settings (see: https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#staticindex_settings) can be only set on the index creation and later cannot be removed or updated - apply will return error

Deprecated: Deprecated

settings_raw str
All raw settings fetched from the cluster.
shard_check_on_startup str
Whether or not shards should be checked for corruption before opening. When corruption is detected, it will prevent the shard from being opened. Accepts false, true, checksum.
sort_fields Sequence[str]
The field to sort shards in this index by.
sort_orders Sequence[str]
The direction to sort shards in. Accepts asc, desc.
timeout str
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.
unassigned_node_left_delayed_timeout str
Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g. 10s
wait_for_active_shards str
The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (numberofreplicas+1). Default: 1, the primary shard. This value is ignored when running against Serverless projects.
aliases List<Property Map>
Aliases for the index.
analysisAnalyzer String
A JSON string describing the analyzers applied to the index.
analysisCharFilter String
A JSON string describing the char_filters applied to the index.
analysisFilter String
A JSON string describing the filters applied to the index.
analysisNormalizer String
A JSON string describing the normalizers applied to the index.
analysisTokenizer String
A JSON string describing the tokenizers applied to the index.
analyzeMaxTokenCount Number
The maximum number of tokens that can be produced using _analyze API.
autoExpandReplicas String
Set the number of replicas to the node count in the cluster. Set to a dash delimited lower and upper bound (e.g. 0-5) or use all for the upper bound (e.g. 0-all)
blocksMetadata Boolean
Set to true to disable index metadata reads and writes.
blocksRead Boolean
Set to true to disable read operations against the index.
blocksReadOnly Boolean
Set to true to make the index and index metadata read only, false to allow writes and metadata changes.
blocksReadOnlyAllowDelete Boolean
Identical to index.blocks.read_only but allows deleting the index to free up resources.
blocksWrite Boolean
Set to true to disable data write operations against the index. This setting does not affect metadata.
codec String
The default value compresses stored data with LZ4 compression, but this can be set to best_compression which uses DEFLATE for a higher compression ratio. This can be set only on creation.
defaultPipeline String
The default ingest node pipeline for this index. Index requests will fail if the default pipeline is set and the pipeline does not exist.
deletionProtection Boolean
elasticsearchConnections List<Property Map>
Elasticsearch connection configuration block.

Deprecated: Deprecated

finalPipeline String
Final ingest pipeline for the index. Indexing requests will fail if the final pipeline is set and the pipeline does not exist. The final pipeline always runs after the request pipeline (if specified) and the default pipeline (if it exists). The special pipeline name _none indicates no ingest pipeline will run.
gcDeletes String
The length of time that a deleted document's version number remains available for further versioned operations.
highlightMaxAnalyzedOffset Number
The maximum number of characters that will be analyzed for a highlight request.
indexingSlowlogLevel String
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
indexingSlowlogSource String
Set the number of characters of the _source to include in the slowlog lines, false or 0 will skip logging the source entirely and setting it to true will log the entire source regardless of size. The original _source is reformatted by default to make sure that it fits on a single log line.
indexingSlowlogThresholdIndexDebug String
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 2s
indexingSlowlogThresholdIndexInfo String
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 5s
indexingSlowlogThresholdIndexTrace String
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 500ms
indexingSlowlogThresholdIndexWarn String
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 10s
loadFixedBitsetFiltersEagerly Boolean
Indicates whether cached filters are pre-loaded for nested queries. This can be set only on creation.
mappingCoerce Boolean
Set index level coercion setting that is applied to all mapping types.
mappings String
Mapping for fields in the index. If specified, this mapping can include: field names, field data types, mapping parameters. NOTE: - Changing datatypes in the existing mappings will force index to be re-created. - Removing field will be ignored by default same as elasticsearch. You need to recreate the index to remove field completely.
masterTimeout String
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s. This value is ignored when running against Serverless projects.
maxDocvalueFieldsSearch Number
The maximum number of docvalue_fields that are allowed in a query.
maxInnerResultWindow Number
The maximum value of from + size for inner hits definition and top hits aggregations to this index.
maxNgramDiff Number
The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
maxRefreshListeners Number
Maximum number of refresh listeners available on each shard of the index.
maxRegexLength Number
The maximum length of regex that can be used in Regexp Query.
maxRescoreWindow Number
The maximum value of window_size for rescore requests in searches of this index.
maxResultWindow Number
The maximum value of from + size for searches to this index.
maxScriptFields Number
The maximum number of script_fields that are allowed in a query.
maxShingleDiff Number
The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
maxTermsCount Number
The maximum number of terms that can be used in Terms Query.
name String
Name of the index you wish to create.
numberOfReplicas Number
Number of shard replicas.
numberOfRoutingShards Number
Value used with numberofshards to route documents to a primary shard. This can be set only on creation.
numberOfShards Number
Number of shards for the index. This can be set only on creation.
queryDefaultFields List<String>
Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
refreshInterval String
How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to -1 to disable refresh.
routingAllocationEnable String
Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
routingPartitionSize Number
The number of shards a custom routing value can go to. This can be set only on creation.
routingRebalanceEnable String
Enables shard rebalancing for this index. It can be set to: all, primaries , replicas , none.
searchIdleAfter String
How long a shard can not receive a search or get request until it’s considered search idle.
searchSlowlogLevel String
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
searchSlowlogThresholdFetchDebug String
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 2s
searchSlowlogThresholdFetchInfo String
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 5s
searchSlowlogThresholdFetchTrace String
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 500ms
searchSlowlogThresholdFetchWarn String
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 10s
searchSlowlogThresholdQueryDebug String
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 2s
searchSlowlogThresholdQueryInfo String
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 5s
searchSlowlogThresholdQueryTrace String
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 500ms
searchSlowlogThresholdQueryWarn String
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 10s
settings List<Property Map>
DEPRECATED: Please use dedicated setting field. Configuration options for the index. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-modules-settings. NOTE: Static index settings (see: https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#staticindex_settings) can be only set on the index creation and later cannot be removed or updated - apply will return error

Deprecated: Deprecated

settingsRaw String
All raw settings fetched from the cluster.
shardCheckOnStartup String
Whether or not shards should be checked for corruption before opening. When corruption is detected, it will prevent the shard from being opened. Accepts false, true, checksum.
sortFields List<String>
The field to sort shards in this index by.
sortOrders List<String>
The direction to sort shards in. Accepts asc, desc.
timeout String
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.
unassignedNodeLeftDelayedTimeout String
Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g. 10s
waitForActiveShards String
The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (numberofreplicas+1). Default: 1, the primary shard. This value is ignored when running against Serverless projects.

Supporting Types

ElasticsearchIndexAlias
, ElasticsearchIndexAliasArgs

Name This property is required. string
Index alias name.
Filter string
Query used to limit documents the alias can access.
IndexRouting string
Value used to route indexing operations to a specific shard. If specified, this overwrites the routing value for indexing operations.
IsHidden bool
If true, the alias is hidden.
IsWriteIndex bool
If true, the index is the write index for the alias.
Routing string
Value used to route indexing and search operations to a specific shard.
SearchRouting string
Value used to route search operations to a specific shard. If specified, this overwrites the routing value for search operations.
Name This property is required. string
Index alias name.
Filter string
Query used to limit documents the alias can access.
IndexRouting string
Value used to route indexing operations to a specific shard. If specified, this overwrites the routing value for indexing operations.
IsHidden bool
If true, the alias is hidden.
IsWriteIndex bool
If true, the index is the write index for the alias.
Routing string
Value used to route indexing and search operations to a specific shard.
SearchRouting string
Value used to route search operations to a specific shard. If specified, this overwrites the routing value for search operations.
name This property is required. String
Index alias name.
filter String
Query used to limit documents the alias can access.
indexRouting String
Value used to route indexing operations to a specific shard. If specified, this overwrites the routing value for indexing operations.
isHidden Boolean
If true, the alias is hidden.
isWriteIndex Boolean
If true, the index is the write index for the alias.
routing String
Value used to route indexing and search operations to a specific shard.
searchRouting String
Value used to route search operations to a specific shard. If specified, this overwrites the routing value for search operations.
name This property is required. string
Index alias name.
filter string
Query used to limit documents the alias can access.
indexRouting string
Value used to route indexing operations to a specific shard. If specified, this overwrites the routing value for indexing operations.
isHidden boolean
If true, the alias is hidden.
isWriteIndex boolean
If true, the index is the write index for the alias.
routing string
Value used to route indexing and search operations to a specific shard.
searchRouting string
Value used to route search operations to a specific shard. If specified, this overwrites the routing value for search operations.
name This property is required. str
Index alias name.
filter str
Query used to limit documents the alias can access.
index_routing str
Value used to route indexing operations to a specific shard. If specified, this overwrites the routing value for indexing operations.
is_hidden bool
If true, the alias is hidden.
is_write_index bool
If true, the index is the write index for the alias.
routing str
Value used to route indexing and search operations to a specific shard.
search_routing str
Value used to route search operations to a specific shard. If specified, this overwrites the routing value for search operations.
name This property is required. String
Index alias name.
filter String
Query used to limit documents the alias can access.
indexRouting String
Value used to route indexing operations to a specific shard. If specified, this overwrites the routing value for indexing operations.
isHidden Boolean
If true, the alias is hidden.
isWriteIndex Boolean
If true, the index is the write index for the alias.
routing String
Value used to route indexing and search operations to a specific shard.
searchRouting String
Value used to route search operations to a specific shard. If specified, this overwrites the routing value for search operations.

ElasticsearchIndexElasticsearchConnection
, ElasticsearchIndexElasticsearchConnectionArgs

ApiKey string
API Key to use for authentication to Elasticsearch
BearerToken string
Bearer Token to use for authentication to Elasticsearch
CaData string
PEM-encoded custom Certificate Authority certificate
CaFile string
Path to a custom Certificate Authority certificate
CertData string
PEM encoded certificate for client auth
CertFile string
Path to a file containing the PEM encoded certificate for client auth
Endpoints List<string>
EsClientAuthentication string
ES Client Authentication field to be used with the JWT token
Insecure bool
Disable TLS certificate validation
KeyData string
PEM encoded private key for client auth
KeyFile string
Path to a file containing the PEM encoded private key for client auth
Password string
Password to use for API authentication to Elasticsearch.
Username string
Username to use for API authentication to Elasticsearch.
ApiKey string
API Key to use for authentication to Elasticsearch
BearerToken string
Bearer Token to use for authentication to Elasticsearch
CaData string
PEM-encoded custom Certificate Authority certificate
CaFile string
Path to a custom Certificate Authority certificate
CertData string
PEM encoded certificate for client auth
CertFile string
Path to a file containing the PEM encoded certificate for client auth
Endpoints []string
EsClientAuthentication string
ES Client Authentication field to be used with the JWT token
Insecure bool
Disable TLS certificate validation
KeyData string
PEM encoded private key for client auth
KeyFile string
Path to a file containing the PEM encoded private key for client auth
Password string
Password to use for API authentication to Elasticsearch.
Username string
Username to use for API authentication to Elasticsearch.
apiKey String
API Key to use for authentication to Elasticsearch
bearerToken String
Bearer Token to use for authentication to Elasticsearch
caData String
PEM-encoded custom Certificate Authority certificate
caFile String
Path to a custom Certificate Authority certificate
certData String
PEM encoded certificate for client auth
certFile String
Path to a file containing the PEM encoded certificate for client auth
endpoints List<String>
esClientAuthentication String
ES Client Authentication field to be used with the JWT token
insecure Boolean
Disable TLS certificate validation
keyData String
PEM encoded private key for client auth
keyFile String
Path to a file containing the PEM encoded private key for client auth
password String
Password to use for API authentication to Elasticsearch.
username String
Username to use for API authentication to Elasticsearch.
apiKey string
API Key to use for authentication to Elasticsearch
bearerToken string
Bearer Token to use for authentication to Elasticsearch
caData string
PEM-encoded custom Certificate Authority certificate
caFile string
Path to a custom Certificate Authority certificate
certData string
PEM encoded certificate for client auth
certFile string
Path to a file containing the PEM encoded certificate for client auth
endpoints string[]
esClientAuthentication string
ES Client Authentication field to be used with the JWT token
insecure boolean
Disable TLS certificate validation
keyData string
PEM encoded private key for client auth
keyFile string
Path to a file containing the PEM encoded private key for client auth
password string
Password to use for API authentication to Elasticsearch.
username string
Username to use for API authentication to Elasticsearch.
api_key str
API Key to use for authentication to Elasticsearch
bearer_token str
Bearer Token to use for authentication to Elasticsearch
ca_data str
PEM-encoded custom Certificate Authority certificate
ca_file str
Path to a custom Certificate Authority certificate
cert_data str
PEM encoded certificate for client auth
cert_file str
Path to a file containing the PEM encoded certificate for client auth
endpoints Sequence[str]
es_client_authentication str
ES Client Authentication field to be used with the JWT token
insecure bool
Disable TLS certificate validation
key_data str
PEM encoded private key for client auth
key_file str
Path to a file containing the PEM encoded private key for client auth
password str
Password to use for API authentication to Elasticsearch.
username str
Username to use for API authentication to Elasticsearch.
apiKey String
API Key to use for authentication to Elasticsearch
bearerToken String
Bearer Token to use for authentication to Elasticsearch
caData String
PEM-encoded custom Certificate Authority certificate
caFile String
Path to a custom Certificate Authority certificate
certData String
PEM encoded certificate for client auth
certFile String
Path to a file containing the PEM encoded certificate for client auth
endpoints List<String>
esClientAuthentication String
ES Client Authentication field to be used with the JWT token
insecure Boolean
Disable TLS certificate validation
keyData String
PEM encoded private key for client auth
keyFile String
Path to a file containing the PEM encoded private key for client auth
password String
Password to use for API authentication to Elasticsearch.
username String
Username to use for API authentication to Elasticsearch.

ElasticsearchIndexSetting
, ElasticsearchIndexSettingArgs

Settings List<ElasticsearchIndexSettingSetting>
Defines the setting for the index.
Settings []ElasticsearchIndexSettingSetting
Defines the setting for the index.
settings List<ElasticsearchIndexSettingSetting>
Defines the setting for the index.
settings ElasticsearchIndexSettingSetting[]
Defines the setting for the index.
settings Sequence[ElasticsearchIndexSettingSetting]
Defines the setting for the index.
settings List<Property Map>
Defines the setting for the index.

ElasticsearchIndexSettingSetting
, ElasticsearchIndexSettingSettingArgs

Name This property is required. string
The name of the setting to set and track.
Value This property is required. string
The value of the setting to set and track.
Name This property is required. string
The name of the setting to set and track.
Value This property is required. string
The value of the setting to set and track.
name This property is required. String
The name of the setting to set and track.
value This property is required. String
The value of the setting to set and track.
name This property is required. string
The name of the setting to set and track.
value This property is required. string
The value of the setting to set and track.
name This property is required. str
The name of the setting to set and track.
value This property is required. str
The value of the setting to set and track.
name This property is required. String
The name of the setting to set and track.
value This property is required. String
The value of the setting to set and track.

Import

You can later adjust the index configuration to account for those imported settings.

Some of the default settings, which could be imported are: index.number_of_replicas, index.number_of_shards and index.routing.allocation.include._tier_preference.

NOTE: while importing index resource, keep in mind, that some of the default index settings will be imported into the TF state too

You can later adjust the index configuration to account for those imported settings

$ pulumi import elasticstack:index/elasticsearchIndex:ElasticsearchIndex my_index <cluster_uuid>/<index_name>
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
elasticstack elastic/terraform-provider-elasticstack
License
Notes
This Pulumi package is based on the elasticstack Terraform Provider.
elasticstack 0.11.14 published on Monday, Apr 14, 2025 by elastic
elastic/terraform-provider-elasticstack