Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Opensearch Provider
  3. API Docs
  4. Index
opensearch 2.3.1 published on Monday, Apr 14, 2025 by opensearch-project
opensearch-project/terraform-provider-opensearch

opensearch.Index

Explore with Pulumi AI

opensearch logo
opensearch 2.3.1 published on Monday, Apr 14, 2025 by opensearch-project
opensearch-project/terraform-provider-opensearch

    Provides an OpenSearch index resource.

    Example Usage

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

// Create a simple index
const test_simple_index = new opensearch.Index("test-simple-index", {
    numberOfShards: "1",
    numberOfReplicas: "1",
    mappings: `{
  "properties": {
    "name": {
      "type": "text"
    }
  }
}
`,
});
//# Index with aliases
const index = new opensearch.Index("index", {
    aliases: JSON.stringify({
        log: {
            is_write_index: true,
        },
    }),
    numberOfReplicas: "1",
    numberOfShards: "1",
    mappings: JSON.stringify({
        properties: {
            age: {
                type: "integer",
            },
        },
    }),
});

    import pulumi
import json
import pulumi_opensearch as opensearch

# Create a simple index
test_simple_index = opensearch.Index("test-simple-index",
    number_of_shards="1",
    number_of_replicas="1",
    mappings="""{
  "properties": {
    "name": {
      "type": "text"
    }
  }
}
""")
## Index with aliases
index = opensearch.Index("index",
    aliases=json.dumps({
        "log": {
            "is_write_index": True,
        },
    }),
    number_of_replicas="1",
    number_of_shards="1",
    mappings=json.dumps({
        "properties": {
            "age": {
                "type": "integer",
            },
        },
    }))

    package main

import (
	"encoding/json"

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create a simple index
		_, err := opensearch.NewIndex(ctx, "test-simple-index", &opensearch.IndexArgs{
			NumberOfShards:   pulumi.String("1"),
			NumberOfReplicas: pulumi.String("1"),
			Mappings: pulumi.String(`{
  "properties": {
    "name": {
      "type": "text"
    }
  }
}
`),
		})
		if err != nil {
			return err
		}
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"log": map[string]interface{}{
				"is_write_index": true,
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		tmpJSON1, err := json.Marshal(map[string]interface{}{
			"properties": map[string]interface{}{
				"age": map[string]interface{}{
					"type": "integer",
				},
			},
		})
		if err != nil {
			return err
		}
		json1 := string(tmpJSON1)
		// # Index with aliases
		_, err = opensearch.NewIndex(ctx, "index", &opensearch.IndexArgs{
			Aliases:          pulumi.String(json0),
			NumberOfReplicas: pulumi.String("1"),
			NumberOfShards:   pulumi.String("1"),
			Mappings:         pulumi.String(json1),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Opensearch = Pulumi.Opensearch;

return await Deployment.RunAsync(() => 
{
    // Create a simple index
    var test_simple_index = new Opensearch.Index("test-simple-index", new()
    {
        NumberOfShards = "1",
        NumberOfReplicas = "1",
        Mappings = @"{
  ""properties"": {
    ""name"": {
      ""type"": ""text""
    }
  }
}
",
    });

    //# Index with aliases
    var index = new Opensearch.Index("index", new()
    {
        Aliases = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["log"] = new Dictionary<string, object?>
            {
                ["is_write_index"] = true,
            },
        }),
        NumberOfReplicas = "1",
        NumberOfShards = "1",
        Mappings = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["properties"] = new Dictionary<string, object?>
            {
                ["age"] = new Dictionary<string, object?>
                {
                    ["type"] = "integer",
                },
            },
        }),
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opensearch.Index;
import com.pulumi.opensearch.IndexArgs;
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) {
        // Create a simple index
        var test_simple_index = new Index("test-simple-index", IndexArgs.builder()
            .numberOfShards("1")
            .numberOfReplicas("1")
            .mappings("""
{
  "properties": {
    "name": {
      "type": "text"
    }
  }
}
            """)
            .build());

        //# Index with aliases
        var index = new Index("index", IndexArgs.builder()
            .aliases(serializeJson(
                jsonObject(
                    jsonProperty("log", jsonObject(
                        jsonProperty("is_write_index", true)
                    ))
                )))
            .numberOfReplicas("1")
            .numberOfShards("1")
            .mappings(serializeJson(
                jsonObject(
                    jsonProperty("properties", jsonObject(
                        jsonProperty("age", jsonObject(
                            jsonProperty("type", "integer")
                        ))
                    ))
                )))
            .build());

    }
}

    resources:
  # Create a simple index
  test-simple-index:
    type: opensearch:Index
    properties:
      numberOfShards: '1'
      numberOfReplicas: '1'
      mappings: |
        {
          "properties": {
            "name": {
              "type": "text"
            }
          }
        }        
  ## Index with aliases
  index:
    type: opensearch:Index
    properties:
      aliases:
        fn::toJSON:
          log:
            is_write_index: true
      numberOfReplicas: '1'
      numberOfShards: '1'
      mappings:
        fn::toJSON:
          properties:
            age:
              type: integer

    Create Index Resource

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

    Constructor syntax

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

@overload
def Index(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          aliases: Optional[str] = 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[str] = 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,
          force_destroy: Optional[bool] = None,
          gc_deletes: Optional[str] = None,
          highlight_max_analyzed_offset: Optional[str] = None,
          include_type_name: Optional[str] = None,
          index_id: Optional[str] = None,
          index_knn: Optional[bool] = None,
          index_knn_algo_param_ef_search: Optional[str] = None,
          index_similarity_default: Optional[str] = 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,
          mappings: Optional[str] = None,
          max_docvalue_fields_search: Optional[str] = None,
          max_inner_result_window: Optional[str] = None,
          max_ngram_diff: Optional[str] = None,
          max_refresh_listeners: Optional[str] = None,
          max_regex_length: Optional[str] = None,
          max_rescore_window: Optional[str] = None,
          max_result_window: Optional[str] = None,
          max_script_fields: Optional[str] = None,
          max_shingle_diff: Optional[str] = None,
          max_terms_count: Optional[str] = None,
          name: Optional[str] = None,
          number_of_replicas: Optional[str] = None,
          number_of_routing_shards: Optional[str] = None,
          number_of_shards: Optional[str] = None,
          refresh_interval: Optional[str] = None,
          rollover_alias: Optional[str] = None,
          routing_allocation_enable: Optional[str] = None,
          routing_partition_size: Optional[str] = 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,
          shard_check_on_startup: Optional[str] = None,
          sort_field: Optional[str] = None,
          sort_order: Optional[str] = None)
    func NewIndex(ctx *Context, name string, args *IndexArgs, opts ...ResourceOption) (*Index, error)
    public Index(string name, IndexArgs? args = null, CustomResourceOptions? opts = null)
    public Index(String name, IndexArgs args)
public Index(String name, IndexArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args IndexArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args IndexArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args IndexArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IndexArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IndexArgs
    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 indexResource = new Opensearch.Index("indexResource", new()
{
    Aliases = "string",
    AnalysisAnalyzer = "string",
    AnalysisCharFilter = "string",
    AnalysisFilter = "string",
    AnalysisNormalizer = "string",
    AnalysisTokenizer = "string",
    AnalyzeMaxTokenCount = "string",
    AutoExpandReplicas = "string",
    BlocksMetadata = false,
    BlocksRead = false,
    BlocksReadOnly = false,
    BlocksReadOnlyAllowDelete = false,
    BlocksWrite = false,
    Codec = "string",
    DefaultPipeline = "string",
    ForceDestroy = false,
    GcDeletes = "string",
    HighlightMaxAnalyzedOffset = "string",
    IncludeTypeName = "string",
    IndexId = "string",
    IndexKnn = false,
    IndexKnnAlgoParamEfSearch = "string",
    IndexSimilarityDefault = "string",
    IndexingSlowlogLevel = "string",
    IndexingSlowlogSource = "string",
    IndexingSlowlogThresholdIndexDebug = "string",
    IndexingSlowlogThresholdIndexInfo = "string",
    IndexingSlowlogThresholdIndexTrace = "string",
    IndexingSlowlogThresholdIndexWarn = "string",
    LoadFixedBitsetFiltersEagerly = false,
    Mappings = "string",
    MaxDocvalueFieldsSearch = "string",
    MaxInnerResultWindow = "string",
    MaxNgramDiff = "string",
    MaxRefreshListeners = "string",
    MaxRegexLength = "string",
    MaxRescoreWindow = "string",
    MaxResultWindow = "string",
    MaxScriptFields = "string",
    MaxShingleDiff = "string",
    MaxTermsCount = "string",
    Name = "string",
    NumberOfReplicas = "string",
    NumberOfRoutingShards = "string",
    NumberOfShards = "string",
    RefreshInterval = "string",
    RolloverAlias = "string",
    RoutingAllocationEnable = "string",
    RoutingPartitionSize = "string",
    RoutingRebalanceEnable = "string",
    SearchIdleAfter = "string",
    SearchSlowlogLevel = "string",
    SearchSlowlogThresholdFetchDebug = "string",
    SearchSlowlogThresholdFetchInfo = "string",
    SearchSlowlogThresholdFetchTrace = "string",
    SearchSlowlogThresholdFetchWarn = "string",
    SearchSlowlogThresholdQueryDebug = "string",
    SearchSlowlogThresholdQueryInfo = "string",
    SearchSlowlogThresholdQueryTrace = "string",
    SearchSlowlogThresholdQueryWarn = "string",
    ShardCheckOnStartup = "string",
    SortField = "string",
    SortOrder = "string",
});

    example, err := opensearch.NewIndex(ctx, "indexResource", &opensearch.IndexArgs{
	Aliases:                            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.String("string"),
	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"),
	ForceDestroy:                       pulumi.Bool(false),
	GcDeletes:                          pulumi.String("string"),
	HighlightMaxAnalyzedOffset:         pulumi.String("string"),
	IncludeTypeName:                    pulumi.String("string"),
	IndexId:                            pulumi.String("string"),
	IndexKnn:                           pulumi.Bool(false),
	IndexKnnAlgoParamEfSearch:          pulumi.String("string"),
	IndexSimilarityDefault:             pulumi.String("string"),
	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),
	Mappings:                           pulumi.String("string"),
	MaxDocvalueFieldsSearch:            pulumi.String("string"),
	MaxInnerResultWindow:               pulumi.String("string"),
	MaxNgramDiff:                       pulumi.String("string"),
	MaxRefreshListeners:                pulumi.String("string"),
	MaxRegexLength:                     pulumi.String("string"),
	MaxRescoreWindow:                   pulumi.String("string"),
	MaxResultWindow:                    pulumi.String("string"),
	MaxScriptFields:                    pulumi.String("string"),
	MaxShingleDiff:                     pulumi.String("string"),
	MaxTermsCount:                      pulumi.String("string"),
	Name:                               pulumi.String("string"),
	NumberOfReplicas:                   pulumi.String("string"),
	NumberOfRoutingShards:              pulumi.String("string"),
	NumberOfShards:                     pulumi.String("string"),
	RefreshInterval:                    pulumi.String("string"),
	RolloverAlias:                      pulumi.String("string"),
	RoutingAllocationEnable:            pulumi.String("string"),
	RoutingPartitionSize:               pulumi.String("string"),
	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"),
	SortField:                          pulumi.String("string"),
	SortOrder:                          pulumi.String("string"),
})

    var indexResource = new Index("indexResource", IndexArgs.builder()
    .aliases("string")
    .analysisAnalyzer("string")
    .analysisCharFilter("string")
    .analysisFilter("string")
    .analysisNormalizer("string")
    .analysisTokenizer("string")
    .analyzeMaxTokenCount("string")
    .autoExpandReplicas("string")
    .blocksMetadata(false)
    .blocksRead(false)
    .blocksReadOnly(false)
    .blocksReadOnlyAllowDelete(false)
    .blocksWrite(false)
    .codec("string")
    .defaultPipeline("string")
    .forceDestroy(false)
    .gcDeletes("string")
    .highlightMaxAnalyzedOffset("string")
    .includeTypeName("string")
    .indexId("string")
    .indexKnn(false)
    .indexKnnAlgoParamEfSearch("string")
    .indexSimilarityDefault("string")
    .indexingSlowlogLevel("string")
    .indexingSlowlogSource("string")
    .indexingSlowlogThresholdIndexDebug("string")
    .indexingSlowlogThresholdIndexInfo("string")
    .indexingSlowlogThresholdIndexTrace("string")
    .indexingSlowlogThresholdIndexWarn("string")
    .loadFixedBitsetFiltersEagerly(false)
    .mappings("string")
    .maxDocvalueFieldsSearch("string")
    .maxInnerResultWindow("string")
    .maxNgramDiff("string")
    .maxRefreshListeners("string")
    .maxRegexLength("string")
    .maxRescoreWindow("string")
    .maxResultWindow("string")
    .maxScriptFields("string")
    .maxShingleDiff("string")
    .maxTermsCount("string")
    .name("string")
    .numberOfReplicas("string")
    .numberOfRoutingShards("string")
    .numberOfShards("string")
    .refreshInterval("string")
    .rolloverAlias("string")
    .routingAllocationEnable("string")
    .routingPartitionSize("string")
    .routingRebalanceEnable("string")
    .searchIdleAfter("string")
    .searchSlowlogLevel("string")
    .searchSlowlogThresholdFetchDebug("string")
    .searchSlowlogThresholdFetchInfo("string")
    .searchSlowlogThresholdFetchTrace("string")
    .searchSlowlogThresholdFetchWarn("string")
    .searchSlowlogThresholdQueryDebug("string")
    .searchSlowlogThresholdQueryInfo("string")
    .searchSlowlogThresholdQueryTrace("string")
    .searchSlowlogThresholdQueryWarn("string")
    .shardCheckOnStartup("string")
    .sortField("string")
    .sortOrder("string")
    .build());

    index_resource = opensearch.Index("indexResource",
    aliases="string",
    analysis_analyzer="string",
    analysis_char_filter="string",
    analysis_filter="string",
    analysis_normalizer="string",
    analysis_tokenizer="string",
    analyze_max_token_count="string",
    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",
    force_destroy=False,
    gc_deletes="string",
    highlight_max_analyzed_offset="string",
    include_type_name="string",
    index_id="string",
    index_knn=False,
    index_knn_algo_param_ef_search="string",
    index_similarity_default="string",
    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,
    mappings="string",
    max_docvalue_fields_search="string",
    max_inner_result_window="string",
    max_ngram_diff="string",
    max_refresh_listeners="string",
    max_regex_length="string",
    max_rescore_window="string",
    max_result_window="string",
    max_script_fields="string",
    max_shingle_diff="string",
    max_terms_count="string",
    name="string",
    number_of_replicas="string",
    number_of_routing_shards="string",
    number_of_shards="string",
    refresh_interval="string",
    rollover_alias="string",
    routing_allocation_enable="string",
    routing_partition_size="string",
    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_field="string",
    sort_order="string")

    const indexResource = new opensearch.Index("indexResource", {
    aliases: "string",
    analysisAnalyzer: "string",
    analysisCharFilter: "string",
    analysisFilter: "string",
    analysisNormalizer: "string",
    analysisTokenizer: "string",
    analyzeMaxTokenCount: "string",
    autoExpandReplicas: "string",
    blocksMetadata: false,
    blocksRead: false,
    blocksReadOnly: false,
    blocksReadOnlyAllowDelete: false,
    blocksWrite: false,
    codec: "string",
    defaultPipeline: "string",
    forceDestroy: false,
    gcDeletes: "string",
    highlightMaxAnalyzedOffset: "string",
    includeTypeName: "string",
    indexId: "string",
    indexKnn: false,
    indexKnnAlgoParamEfSearch: "string",
    indexSimilarityDefault: "string",
    indexingSlowlogLevel: "string",
    indexingSlowlogSource: "string",
    indexingSlowlogThresholdIndexDebug: "string",
    indexingSlowlogThresholdIndexInfo: "string",
    indexingSlowlogThresholdIndexTrace: "string",
    indexingSlowlogThresholdIndexWarn: "string",
    loadFixedBitsetFiltersEagerly: false,
    mappings: "string",
    maxDocvalueFieldsSearch: "string",
    maxInnerResultWindow: "string",
    maxNgramDiff: "string",
    maxRefreshListeners: "string",
    maxRegexLength: "string",
    maxRescoreWindow: "string",
    maxResultWindow: "string",
    maxScriptFields: "string",
    maxShingleDiff: "string",
    maxTermsCount: "string",
    name: "string",
    numberOfReplicas: "string",
    numberOfRoutingShards: "string",
    numberOfShards: "string",
    refreshInterval: "string",
    rolloverAlias: "string",
    routingAllocationEnable: "string",
    routingPartitionSize: "string",
    routingRebalanceEnable: "string",
    searchIdleAfter: "string",
    searchSlowlogLevel: "string",
    searchSlowlogThresholdFetchDebug: "string",
    searchSlowlogThresholdFetchInfo: "string",
    searchSlowlogThresholdFetchTrace: "string",
    searchSlowlogThresholdFetchWarn: "string",
    searchSlowlogThresholdQueryDebug: "string",
    searchSlowlogThresholdQueryInfo: "string",
    searchSlowlogThresholdQueryTrace: "string",
    searchSlowlogThresholdQueryWarn: "string",
    shardCheckOnStartup: "string",
    sortField: "string",
    sortOrder: "string",
});

    type: opensearch:Index
properties:
    aliases: string
    analysisAnalyzer: string
    analysisCharFilter: string
    analysisFilter: string
    analysisNormalizer: string
    analysisTokenizer: string
    analyzeMaxTokenCount: string
    autoExpandReplicas: string
    blocksMetadata: false
    blocksRead: false
    blocksReadOnly: false
    blocksReadOnlyAllowDelete: false
    blocksWrite: false
    codec: string
    defaultPipeline: string
    forceDestroy: false
    gcDeletes: string
    highlightMaxAnalyzedOffset: string
    includeTypeName: string
    indexId: string
    indexKnn: false
    indexKnnAlgoParamEfSearch: string
    indexSimilarityDefault: string
    indexingSlowlogLevel: string
    indexingSlowlogSource: string
    indexingSlowlogThresholdIndexDebug: string
    indexingSlowlogThresholdIndexInfo: string
    indexingSlowlogThresholdIndexTrace: string
    indexingSlowlogThresholdIndexWarn: string
    loadFixedBitsetFiltersEagerly: false
    mappings: string
    maxDocvalueFieldsSearch: string
    maxInnerResultWindow: string
    maxNgramDiff: string
    maxRefreshListeners: string
    maxRegexLength: string
    maxRescoreWindow: string
    maxResultWindow: string
    maxScriptFields: string
    maxShingleDiff: string
    maxTermsCount: string
    name: string
    numberOfReplicas: string
    numberOfRoutingShards: string
    numberOfShards: string
    refreshInterval: string
    rolloverAlias: string
    routingAllocationEnable: string
    routingPartitionSize: string
    routingRebalanceEnable: string
    searchIdleAfter: string
    searchSlowlogLevel: string
    searchSlowlogThresholdFetchDebug: string
    searchSlowlogThresholdFetchInfo: string
    searchSlowlogThresholdFetchTrace: string
    searchSlowlogThresholdFetchWarn: string
    searchSlowlogThresholdQueryDebug: string
    searchSlowlogThresholdQueryInfo: string
    searchSlowlogThresholdQueryTrace: string
    searchSlowlogThresholdQueryWarn: string
    shardCheckOnStartup: string
    sortField: string
    sortOrder: string

    Index 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 Index resource accepts the following input properties:

    Aliases string
    A JSON string describing a set of aliases. The index aliases API allows aliasing an index with a name, with all APIs automatically converting the alias name to the actual index name. An alias can also be mapped to more than one index, and when specifying it, the alias will automatically expand to the aliased indices.
    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 string
    The maximum number of tokens that can be produced using _analyze API. A stringified number.
    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.
    ForceDestroy bool
    A boolean that indicates that the index should be deleted even if it contains documents.
    GcDeletes string
    The length of time that a deleted document's version number remains available for further versioned operations.
    HighlightMaxAnalyzedOffset string
    The maximum number of characters that will be analyzed for a highlight request. A stringified number.
    IncludeTypeName string
    A string that indicates if and what we should pass to includetypename parameter. Set to "false" when trying to create an index on a v6 cluster without a doc type or set to "true" when trying to create an index on a v7 cluster with a doc type. Since mapping updates are not currently supported, this applies only on index create.
    IndexId string
    The ID of this resource.
    IndexKnn bool
    Indicates whether the index should build native library indices for the knnvector fields. If set to false, the knnvector fields will be stored in doc values, but Approximate k-NN search functionality will be disabled.
    IndexKnnAlgoParamEfSearch string
    The size of the dynamic list used during k-NN searches. Higher values lead to more accurate but slower searches. Only available for nmslib.
    IndexSimilarityDefault string
    A JSON string describing the default index similarity config.
    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.
    Mappings string
    A JSON string defining how documents in the index, and the fields they contain, are stored and indexed. To avoid the complexities of field mapping updates, updates of this field are not allowed via this provider.
    MaxDocvalueFieldsSearch string
    The maximum number of docvalue_fields that are allowed in a query. A stringified number.
    MaxInnerResultWindow string
    The maximum value of from + size for inner hits definition and top hits aggregations to this index. A stringified number.
    MaxNgramDiff string
    The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter. A stringified number.
    MaxRefreshListeners string
    Maximum number of refresh listeners available on each shard of the index. A stringified number.
    MaxRegexLength string
    The maximum length of regex that can be used in Regexp Query. A stringified number.
    MaxRescoreWindow string
    The maximum value of window_size for rescore requests in searches of this index. A stringified number.
    MaxResultWindow string
    The maximum value of from + size for searches to this index. A stringified number.
    MaxScriptFields string
    The maximum number of script_fields that are allowed in a query. A stringified number.
    MaxShingleDiff string
    The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter. A stringified number.
    MaxTermsCount string
    The maximum number of terms that can be used in Terms Query. A stringified number.
    Name string
    Name of the index to create
    NumberOfReplicas string
    Number of shard replicas. A stringified number.
    NumberOfRoutingShards string
    Value used with numberofshards to route documents to a primary shard. A stringified number. This can be set only on creation.
    NumberOfShards string
    Number of shards for the index. This can be set only on creation.
    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.
    RolloverAlias string
    RoutingAllocationEnable string
    Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
    RoutingPartitionSize string
    The number of shards a custom routing value can go to. A stringified number. 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
    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.
    SortField string
    The field to sort shards in this index by.
    SortOrder string
    The direction to sort shards in. Accepts asc, desc.
    Aliases string
    A JSON string describing a set of aliases. The index aliases API allows aliasing an index with a name, with all APIs automatically converting the alias name to the actual index name. An alias can also be mapped to more than one index, and when specifying it, the alias will automatically expand to the aliased indices.
    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 string
    The maximum number of tokens that can be produced using _analyze API. A stringified number.
    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.
    ForceDestroy bool
    A boolean that indicates that the index should be deleted even if it contains documents.
    GcDeletes string
    The length of time that a deleted document's version number remains available for further versioned operations.
    HighlightMaxAnalyzedOffset string
    The maximum number of characters that will be analyzed for a highlight request. A stringified number.
    IncludeTypeName string
    A string that indicates if and what we should pass to includetypename parameter. Set to "false" when trying to create an index on a v6 cluster without a doc type or set to "true" when trying to create an index on a v7 cluster with a doc type. Since mapping updates are not currently supported, this applies only on index create.
    IndexId string
    The ID of this resource.
    IndexKnn bool
    Indicates whether the index should build native library indices for the knnvector fields. If set to false, the knnvector fields will be stored in doc values, but Approximate k-NN search functionality will be disabled.
    IndexKnnAlgoParamEfSearch string
    The size of the dynamic list used during k-NN searches. Higher values lead to more accurate but slower searches. Only available for nmslib.
    IndexSimilarityDefault string
    A JSON string describing the default index similarity config.
    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.
    Mappings string
    A JSON string defining how documents in the index, and the fields they contain, are stored and indexed. To avoid the complexities of field mapping updates, updates of this field are not allowed via this provider.
    MaxDocvalueFieldsSearch string
    The maximum number of docvalue_fields that are allowed in a query. A stringified number.
    MaxInnerResultWindow string
    The maximum value of from + size for inner hits definition and top hits aggregations to this index. A stringified number.
    MaxNgramDiff string
    The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter. A stringified number.
    MaxRefreshListeners string
    Maximum number of refresh listeners available on each shard of the index. A stringified number.
    MaxRegexLength string
    The maximum length of regex that can be used in Regexp Query. A stringified number.
    MaxRescoreWindow string
    The maximum value of window_size for rescore requests in searches of this index. A stringified number.
    MaxResultWindow string
    The maximum value of from + size for searches to this index. A stringified number.
    MaxScriptFields string
    The maximum number of script_fields that are allowed in a query. A stringified number.
    MaxShingleDiff string
    The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter. A stringified number.
    MaxTermsCount string
    The maximum number of terms that can be used in Terms Query. A stringified number.
    Name string
    Name of the index to create
    NumberOfReplicas string
    Number of shard replicas. A stringified number.
    NumberOfRoutingShards string
    Value used with numberofshards to route documents to a primary shard. A stringified number. This can be set only on creation.
    NumberOfShards string
    Number of shards for the index. This can be set only on creation.
    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.
    RolloverAlias string
    RoutingAllocationEnable string
    Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
    RoutingPartitionSize string
    The number of shards a custom routing value can go to. A stringified number. 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
    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.
    SortField string
    The field to sort shards in this index by.
    SortOrder string
    The direction to sort shards in. Accepts asc, desc.
    aliases String
    A JSON string describing a set of aliases. The index aliases API allows aliasing an index with a name, with all APIs automatically converting the alias name to the actual index name. An alias can also be mapped to more than one index, and when specifying it, the alias will automatically expand to the aliased indices.
    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 String
    The maximum number of tokens that can be produced using _analyze API. A stringified number.
    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.
    forceDestroy Boolean
    A boolean that indicates that the index should be deleted even if it contains documents.
    gcDeletes String
    The length of time that a deleted document's version number remains available for further versioned operations.
    highlightMaxAnalyzedOffset String
    The maximum number of characters that will be analyzed for a highlight request. A stringified number.
    includeTypeName String
    A string that indicates if and what we should pass to includetypename parameter. Set to "false" when trying to create an index on a v6 cluster without a doc type or set to "true" when trying to create an index on a v7 cluster with a doc type. Since mapping updates are not currently supported, this applies only on index create.
    indexId String
    The ID of this resource.
    indexKnn Boolean
    Indicates whether the index should build native library indices for the knnvector fields. If set to false, the knnvector fields will be stored in doc values, but Approximate k-NN search functionality will be disabled.
    indexKnnAlgoParamEfSearch String
    The size of the dynamic list used during k-NN searches. Higher values lead to more accurate but slower searches. Only available for nmslib.
    indexSimilarityDefault String
    A JSON string describing the default index similarity config.
    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.
    mappings String
    A JSON string defining how documents in the index, and the fields they contain, are stored and indexed. To avoid the complexities of field mapping updates, updates of this field are not allowed via this provider.
    maxDocvalueFieldsSearch String
    The maximum number of docvalue_fields that are allowed in a query. A stringified number.
    maxInnerResultWindow String
    The maximum value of from + size for inner hits definition and top hits aggregations to this index. A stringified number.
    maxNgramDiff String
    The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter. A stringified number.
    maxRefreshListeners String
    Maximum number of refresh listeners available on each shard of the index. A stringified number.
    maxRegexLength String
    The maximum length of regex that can be used in Regexp Query. A stringified number.
    maxRescoreWindow String
    The maximum value of window_size for rescore requests in searches of this index. A stringified number.
    maxResultWindow String
    The maximum value of from + size for searches to this index. A stringified number.
    maxScriptFields String
    The maximum number of script_fields that are allowed in a query. A stringified number.
    maxShingleDiff String
    The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter. A stringified number.
    maxTermsCount String
    The maximum number of terms that can be used in Terms Query. A stringified number.
    name String
    Name of the index to create
    numberOfReplicas String
    Number of shard replicas. A stringified number.
    numberOfRoutingShards String
    Value used with numberofshards to route documents to a primary shard. A stringified number. This can be set only on creation.
    numberOfShards String
    Number of shards for the index. This can be set only on creation.
    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.
    rolloverAlias String
    routingAllocationEnable String
    Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
    routingPartitionSize String
    The number of shards a custom routing value can go to. A stringified number. 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
    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.
    sortField String
    The field to sort shards in this index by.
    sortOrder String
    The direction to sort shards in. Accepts asc, desc.
    aliases string
    A JSON string describing a set of aliases. The index aliases API allows aliasing an index with a name, with all APIs automatically converting the alias name to the actual index name. An alias can also be mapped to more than one index, and when specifying it, the alias will automatically expand to the aliased indices.
    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 string
    The maximum number of tokens that can be produced using _analyze API. A stringified number.
    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.
    forceDestroy boolean
    A boolean that indicates that the index should be deleted even if it contains documents.
    gcDeletes string
    The length of time that a deleted document's version number remains available for further versioned operations.
    highlightMaxAnalyzedOffset string
    The maximum number of characters that will be analyzed for a highlight request. A stringified number.
    includeTypeName string
    A string that indicates if and what we should pass to includetypename parameter. Set to "false" when trying to create an index on a v6 cluster without a doc type or set to "true" when trying to create an index on a v7 cluster with a doc type. Since mapping updates are not currently supported, this applies only on index create.
    indexId string
    The ID of this resource.
    indexKnn boolean
    Indicates whether the index should build native library indices for the knnvector fields. If set to false, the knnvector fields will be stored in doc values, but Approximate k-NN search functionality will be disabled.
    indexKnnAlgoParamEfSearch string
    The size of the dynamic list used during k-NN searches. Higher values lead to more accurate but slower searches. Only available for nmslib.
    indexSimilarityDefault string
    A JSON string describing the default index similarity config.
    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.
    mappings string
    A JSON string defining how documents in the index, and the fields they contain, are stored and indexed. To avoid the complexities of field mapping updates, updates of this field are not allowed via this provider.
    maxDocvalueFieldsSearch string
    The maximum number of docvalue_fields that are allowed in a query. A stringified number.
    maxInnerResultWindow string
    The maximum value of from + size for inner hits definition and top hits aggregations to this index. A stringified number.
    maxNgramDiff string
    The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter. A stringified number.
    maxRefreshListeners string
    Maximum number of refresh listeners available on each shard of the index. A stringified number.
    maxRegexLength string
    The maximum length of regex that can be used in Regexp Query. A stringified number.
    maxRescoreWindow string
    The maximum value of window_size for rescore requests in searches of this index. A stringified number.
    maxResultWindow string
    The maximum value of from + size for searches to this index. A stringified number.
    maxScriptFields string
    The maximum number of script_fields that are allowed in a query. A stringified number.
    maxShingleDiff string
    The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter. A stringified number.
    maxTermsCount string
    The maximum number of terms that can be used in Terms Query. A stringified number.
    name string
    Name of the index to create
    numberOfReplicas string
    Number of shard replicas. A stringified number.
    numberOfRoutingShards string
    Value used with numberofshards to route documents to a primary shard. A stringified number. This can be set only on creation.
    numberOfShards string
    Number of shards for the index. This can be set only on creation.
    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.
    rolloverAlias string
    routingAllocationEnable string
    Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
    routingPartitionSize string
    The number of shards a custom routing value can go to. A stringified number. 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
    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.
    sortField string
    The field to sort shards in this index by.
    sortOrder string
    The direction to sort shards in. Accepts asc, desc.
    aliases str
    A JSON string describing a set of aliases. The index aliases API allows aliasing an index with a name, with all APIs automatically converting the alias name to the actual index name. An alias can also be mapped to more than one index, and when specifying it, the alias will automatically expand to the aliased indices.
    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 str
    The maximum number of tokens that can be produced using _analyze API. A stringified number.
    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.
    force_destroy bool
    A boolean that indicates that the index should be deleted even if it contains documents.
    gc_deletes str
    The length of time that a deleted document's version number remains available for further versioned operations.
    highlight_max_analyzed_offset str
    The maximum number of characters that will be analyzed for a highlight request. A stringified number.
    include_type_name str
    A string that indicates if and what we should pass to includetypename parameter. Set to "false" when trying to create an index on a v6 cluster without a doc type or set to "true" when trying to create an index on a v7 cluster with a doc type. Since mapping updates are not currently supported, this applies only on index create.
    index_id str
    The ID of this resource.
    index_knn bool
    Indicates whether the index should build native library indices for the knnvector fields. If set to false, the knnvector fields will be stored in doc values, but Approximate k-NN search functionality will be disabled.
    index_knn_algo_param_ef_search str
    The size of the dynamic list used during k-NN searches. Higher values lead to more accurate but slower searches. Only available for nmslib.
    index_similarity_default str
    A JSON string describing the default index similarity config.
    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.
    mappings str
    A JSON string defining how documents in the index, and the fields they contain, are stored and indexed. To avoid the complexities of field mapping updates, updates of this field are not allowed via this provider.
    max_docvalue_fields_search str
    The maximum number of docvalue_fields that are allowed in a query. A stringified number.
    max_inner_result_window str
    The maximum value of from + size for inner hits definition and top hits aggregations to this index. A stringified number.
    max_ngram_diff str
    The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter. A stringified number.
    max_refresh_listeners str
    Maximum number of refresh listeners available on each shard of the index. A stringified number.
    max_regex_length str
    The maximum length of regex that can be used in Regexp Query. A stringified number.
    max_rescore_window str
    The maximum value of window_size for rescore requests in searches of this index. A stringified number.
    max_result_window str
    The maximum value of from + size for searches to this index. A stringified number.
    max_script_fields str
    The maximum number of script_fields that are allowed in a query. A stringified number.
    max_shingle_diff str
    The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter. A stringified number.
    max_terms_count str
    The maximum number of terms that can be used in Terms Query. A stringified number.
    name str
    Name of the index to create
    number_of_replicas str
    Number of shard replicas. A stringified number.
    number_of_routing_shards str
    Value used with numberofshards to route documents to a primary shard. A stringified number. This can be set only on creation.
    number_of_shards str
    Number of shards for the index. This can be set only on creation.
    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.
    rollover_alias str
    routing_allocation_enable str
    Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
    routing_partition_size str
    The number of shards a custom routing value can go to. A stringified number. 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
    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_field str
    The field to sort shards in this index by.
    sort_order str
    The direction to sort shards in. Accepts asc, desc.
    aliases String
    A JSON string describing a set of aliases. The index aliases API allows aliasing an index with a name, with all APIs automatically converting the alias name to the actual index name. An alias can also be mapped to more than one index, and when specifying it, the alias will automatically expand to the aliased indices.
    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 String
    The maximum number of tokens that can be produced using _analyze API. A stringified number.
    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.
    forceDestroy Boolean
    A boolean that indicates that the index should be deleted even if it contains documents.
    gcDeletes String
    The length of time that a deleted document's version number remains available for further versioned operations.
    highlightMaxAnalyzedOffset String
    The maximum number of characters that will be analyzed for a highlight request. A stringified number.
    includeTypeName String
    A string that indicates if and what we should pass to includetypename parameter. Set to "false" when trying to create an index on a v6 cluster without a doc type or set to "true" when trying to create an index on a v7 cluster with a doc type. Since mapping updates are not currently supported, this applies only on index create.
    indexId String
    The ID of this resource.
    indexKnn Boolean
    Indicates whether the index should build native library indices for the knnvector fields. If set to false, the knnvector fields will be stored in doc values, but Approximate k-NN search functionality will be disabled.
    indexKnnAlgoParamEfSearch String
    The size of the dynamic list used during k-NN searches. Higher values lead to more accurate but slower searches. Only available for nmslib.
    indexSimilarityDefault String
    A JSON string describing the default index similarity config.
    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.
    mappings String
    A JSON string defining how documents in the index, and the fields they contain, are stored and indexed. To avoid the complexities of field mapping updates, updates of this field are not allowed via this provider.
    maxDocvalueFieldsSearch String
    The maximum number of docvalue_fields that are allowed in a query. A stringified number.
    maxInnerResultWindow String
    The maximum value of from + size for inner hits definition and top hits aggregations to this index. A stringified number.
    maxNgramDiff String
    The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter. A stringified number.
    maxRefreshListeners String
    Maximum number of refresh listeners available on each shard of the index. A stringified number.
    maxRegexLength String
    The maximum length of regex that can be used in Regexp Query. A stringified number.
    maxRescoreWindow String
    The maximum value of window_size for rescore requests in searches of this index. A stringified number.
    maxResultWindow String
    The maximum value of from + size for searches to this index. A stringified number.
    maxScriptFields String
    The maximum number of script_fields that are allowed in a query. A stringified number.
    maxShingleDiff String
    The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter. A stringified number.
    maxTermsCount String
    The maximum number of terms that can be used in Terms Query. A stringified number.
    name String
    Name of the index to create
    numberOfReplicas String
    Number of shard replicas. A stringified number.
    numberOfRoutingShards String
    Value used with numberofshards to route documents to a primary shard. A stringified number. This can be set only on creation.
    numberOfShards String
    Number of shards for the index. This can be set only on creation.
    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.
    rolloverAlias String
    routingAllocationEnable String
    Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
    routingPartitionSize String
    The number of shards a custom routing value can go to. A stringified number. 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
    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.
    sortField String
    The field to sort shards in this index by.
    sortOrder String
    The direction to sort shards in. Accepts asc, desc.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Index Resource

    Get an existing Index 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?: IndexState, opts?: CustomResourceOptions): Index
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aliases: Optional[str] = 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[str] = 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,
        force_destroy: Optional[bool] = None,
        gc_deletes: Optional[str] = None,
        highlight_max_analyzed_offset: Optional[str] = None,
        include_type_name: Optional[str] = None,
        index_id: Optional[str] = None,
        index_knn: Optional[bool] = None,
        index_knn_algo_param_ef_search: Optional[str] = None,
        index_similarity_default: Optional[str] = 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,
        mappings: Optional[str] = None,
        max_docvalue_fields_search: Optional[str] = None,
        max_inner_result_window: Optional[str] = None,
        max_ngram_diff: Optional[str] = None,
        max_refresh_listeners: Optional[str] = None,
        max_regex_length: Optional[str] = None,
        max_rescore_window: Optional[str] = None,
        max_result_window: Optional[str] = None,
        max_script_fields: Optional[str] = None,
        max_shingle_diff: Optional[str] = None,
        max_terms_count: Optional[str] = None,
        name: Optional[str] = None,
        number_of_replicas: Optional[str] = None,
        number_of_routing_shards: Optional[str] = None,
        number_of_shards: Optional[str] = None,
        refresh_interval: Optional[str] = None,
        rollover_alias: Optional[str] = None,
        routing_allocation_enable: Optional[str] = None,
        routing_partition_size: Optional[str] = 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,
        shard_check_on_startup: Optional[str] = None,
        sort_field: Optional[str] = None,
        sort_order: Optional[str] = None) -> Index
    func GetIndex(ctx *Context, name string, id IDInput, state *IndexState, opts ...ResourceOption) (*Index, error)
    public static Index Get(string name, Input<string> id, IndexState? state, CustomResourceOptions? opts = null)
    public static Index get(String name, Output<String> id, IndexState state, CustomResourceOptions options)
    resources:  _:    type: opensearch:Index    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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 string
    A JSON string describing a set of aliases. The index aliases API allows aliasing an index with a name, with all APIs automatically converting the alias name to the actual index name. An alias can also be mapped to more than one index, and when specifying it, the alias will automatically expand to the aliased indices.
    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 string
    The maximum number of tokens that can be produced using _analyze API. A stringified number.
    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.
    ForceDestroy bool
    A boolean that indicates that the index should be deleted even if it contains documents.
    GcDeletes string
    The length of time that a deleted document's version number remains available for further versioned operations.
    HighlightMaxAnalyzedOffset string
    The maximum number of characters that will be analyzed for a highlight request. A stringified number.
    IncludeTypeName string
    A string that indicates if and what we should pass to includetypename parameter. Set to "false" when trying to create an index on a v6 cluster without a doc type or set to "true" when trying to create an index on a v7 cluster with a doc type. Since mapping updates are not currently supported, this applies only on index create.
    IndexId string
    The ID of this resource.
    IndexKnn bool
    Indicates whether the index should build native library indices for the knnvector fields. If set to false, the knnvector fields will be stored in doc values, but Approximate k-NN search functionality will be disabled.
    IndexKnnAlgoParamEfSearch string
    The size of the dynamic list used during k-NN searches. Higher values lead to more accurate but slower searches. Only available for nmslib.
    IndexSimilarityDefault string
    A JSON string describing the default index similarity config.
    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.
    Mappings string
    A JSON string defining how documents in the index, and the fields they contain, are stored and indexed. To avoid the complexities of field mapping updates, updates of this field are not allowed via this provider.
    MaxDocvalueFieldsSearch string
    The maximum number of docvalue_fields that are allowed in a query. A stringified number.
    MaxInnerResultWindow string
    The maximum value of from + size for inner hits definition and top hits aggregations to this index. A stringified number.
    MaxNgramDiff string
    The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter. A stringified number.
    MaxRefreshListeners string
    Maximum number of refresh listeners available on each shard of the index. A stringified number.
    MaxRegexLength string
    The maximum length of regex that can be used in Regexp Query. A stringified number.
    MaxRescoreWindow string
    The maximum value of window_size for rescore requests in searches of this index. A stringified number.
    MaxResultWindow string
    The maximum value of from + size for searches to this index. A stringified number.
    MaxScriptFields string
    The maximum number of script_fields that are allowed in a query. A stringified number.
    MaxShingleDiff string
    The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter. A stringified number.
    MaxTermsCount string
    The maximum number of terms that can be used in Terms Query. A stringified number.
    Name string
    Name of the index to create
    NumberOfReplicas string
    Number of shard replicas. A stringified number.
    NumberOfRoutingShards string
    Value used with numberofshards to route documents to a primary shard. A stringified number. This can be set only on creation.
    NumberOfShards string
    Number of shards for the index. This can be set only on creation.
    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.
    RolloverAlias string
    RoutingAllocationEnable string
    Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
    RoutingPartitionSize string
    The number of shards a custom routing value can go to. A stringified number. 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
    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.
    SortField string
    The field to sort shards in this index by.
    SortOrder string
    The direction to sort shards in. Accepts asc, desc.
    Aliases string
    A JSON string describing a set of aliases. The index aliases API allows aliasing an index with a name, with all APIs automatically converting the alias name to the actual index name. An alias can also be mapped to more than one index, and when specifying it, the alias will automatically expand to the aliased indices.
    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 string
    The maximum number of tokens that can be produced using _analyze API. A stringified number.
    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.
    ForceDestroy bool
    A boolean that indicates that the index should be deleted even if it contains documents.
    GcDeletes string
    The length of time that a deleted document's version number remains available for further versioned operations.
    HighlightMaxAnalyzedOffset string
    The maximum number of characters that will be analyzed for a highlight request. A stringified number.
    IncludeTypeName string
    A string that indicates if and what we should pass to includetypename parameter. Set to "false" when trying to create an index on a v6 cluster without a doc type or set to "true" when trying to create an index on a v7 cluster with a doc type. Since mapping updates are not currently supported, this applies only on index create.
    IndexId string
    The ID of this resource.
    IndexKnn bool
    Indicates whether the index should build native library indices for the knnvector fields. If set to false, the knnvector fields will be stored in doc values, but Approximate k-NN search functionality will be disabled.
    IndexKnnAlgoParamEfSearch string
    The size of the dynamic list used during k-NN searches. Higher values lead to more accurate but slower searches. Only available for nmslib.
    IndexSimilarityDefault string
    A JSON string describing the default index similarity config.
    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.
    Mappings string
    A JSON string defining how documents in the index, and the fields they contain, are stored and indexed. To avoid the complexities of field mapping updates, updates of this field are not allowed via this provider.
    MaxDocvalueFieldsSearch string
    The maximum number of docvalue_fields that are allowed in a query. A stringified number.
    MaxInnerResultWindow string
    The maximum value of from + size for inner hits definition and top hits aggregations to this index. A stringified number.
    MaxNgramDiff string
    The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter. A stringified number.
    MaxRefreshListeners string
    Maximum number of refresh listeners available on each shard of the index. A stringified number.
    MaxRegexLength string
    The maximum length of regex that can be used in Regexp Query. A stringified number.
    MaxRescoreWindow string
    The maximum value of window_size for rescore requests in searches of this index. A stringified number.
    MaxResultWindow string
    The maximum value of from + size for searches to this index. A stringified number.
    MaxScriptFields string
    The maximum number of script_fields that are allowed in a query. A stringified number.
    MaxShingleDiff string
    The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter. A stringified number.
    MaxTermsCount string
    The maximum number of terms that can be used in Terms Query. A stringified number.
    Name string
    Name of the index to create
    NumberOfReplicas string
    Number of shard replicas. A stringified number.
    NumberOfRoutingShards string
    Value used with numberofshards to route documents to a primary shard. A stringified number. This can be set only on creation.
    NumberOfShards string
    Number of shards for the index. This can be set only on creation.
    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.
    RolloverAlias string
    RoutingAllocationEnable string
    Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
    RoutingPartitionSize string
    The number of shards a custom routing value can go to. A stringified number. 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
    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.
    SortField string
    The field to sort shards in this index by.
    SortOrder string
    The direction to sort shards in. Accepts asc, desc.
    aliases String
    A JSON string describing a set of aliases. The index aliases API allows aliasing an index with a name, with all APIs automatically converting the alias name to the actual index name. An alias can also be mapped to more than one index, and when specifying it, the alias will automatically expand to the aliased indices.
    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 String
    The maximum number of tokens that can be produced using _analyze API. A stringified number.
    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.
    forceDestroy Boolean
    A boolean that indicates that the index should be deleted even if it contains documents.
    gcDeletes String
    The length of time that a deleted document's version number remains available for further versioned operations.
    highlightMaxAnalyzedOffset String
    The maximum number of characters that will be analyzed for a highlight request. A stringified number.
    includeTypeName String
    A string that indicates if and what we should pass to includetypename parameter. Set to "false" when trying to create an index on a v6 cluster without a doc type or set to "true" when trying to create an index on a v7 cluster with a doc type. Since mapping updates are not currently supported, this applies only on index create.
    indexId String
    The ID of this resource.
    indexKnn Boolean
    Indicates whether the index should build native library indices for the knnvector fields. If set to false, the knnvector fields will be stored in doc values, but Approximate k-NN search functionality will be disabled.
    indexKnnAlgoParamEfSearch String
    The size of the dynamic list used during k-NN searches. Higher values lead to more accurate but slower searches. Only available for nmslib.
    indexSimilarityDefault String
    A JSON string describing the default index similarity config.
    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.
    mappings String
    A JSON string defining how documents in the index, and the fields they contain, are stored and indexed. To avoid the complexities of field mapping updates, updates of this field are not allowed via this provider.
    maxDocvalueFieldsSearch String
    The maximum number of docvalue_fields that are allowed in a query. A stringified number.
    maxInnerResultWindow String
    The maximum value of from + size for inner hits definition and top hits aggregations to this index. A stringified number.
    maxNgramDiff String
    The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter. A stringified number.
    maxRefreshListeners String
    Maximum number of refresh listeners available on each shard of the index. A stringified number.
    maxRegexLength String
    The maximum length of regex that can be used in Regexp Query. A stringified number.
    maxRescoreWindow String
    The maximum value of window_size for rescore requests in searches of this index. A stringified number.
    maxResultWindow String
    The maximum value of from + size for searches to this index. A stringified number.
    maxScriptFields String
    The maximum number of script_fields that are allowed in a query. A stringified number.
    maxShingleDiff String
    The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter. A stringified number.
    maxTermsCount String
    The maximum number of terms that can be used in Terms Query. A stringified number.
    name String
    Name of the index to create
    numberOfReplicas String
    Number of shard replicas. A stringified number.
    numberOfRoutingShards String
    Value used with numberofshards to route documents to a primary shard. A stringified number. This can be set only on creation.
    numberOfShards String
    Number of shards for the index. This can be set only on creation.
    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.
    rolloverAlias String
    routingAllocationEnable String
    Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
    routingPartitionSize String
    The number of shards a custom routing value can go to. A stringified number. 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
    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.
    sortField String
    The field to sort shards in this index by.
    sortOrder String
    The direction to sort shards in. Accepts asc, desc.
    aliases string
    A JSON string describing a set of aliases. The index aliases API allows aliasing an index with a name, with all APIs automatically converting the alias name to the actual index name. An alias can also be mapped to more than one index, and when specifying it, the alias will automatically expand to the aliased indices.
    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 string
    The maximum number of tokens that can be produced using _analyze API. A stringified number.
    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.
    forceDestroy boolean
    A boolean that indicates that the index should be deleted even if it contains documents.
    gcDeletes string
    The length of time that a deleted document's version number remains available for further versioned operations.
    highlightMaxAnalyzedOffset string
    The maximum number of characters that will be analyzed for a highlight request. A stringified number.
    includeTypeName string
    A string that indicates if and what we should pass to includetypename parameter. Set to "false" when trying to create an index on a v6 cluster without a doc type or set to "true" when trying to create an index on a v7 cluster with a doc type. Since mapping updates are not currently supported, this applies only on index create.
    indexId string
    The ID of this resource.
    indexKnn boolean
    Indicates whether the index should build native library indices for the knnvector fields. If set to false, the knnvector fields will be stored in doc values, but Approximate k-NN search functionality will be disabled.
    indexKnnAlgoParamEfSearch string
    The size of the dynamic list used during k-NN searches. Higher values lead to more accurate but slower searches. Only available for nmslib.
    indexSimilarityDefault string
    A JSON string describing the default index similarity config.
    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.
    mappings string
    A JSON string defining how documents in the index, and the fields they contain, are stored and indexed. To avoid the complexities of field mapping updates, updates of this field are not allowed via this provider.
    maxDocvalueFieldsSearch string
    The maximum number of docvalue_fields that are allowed in a query. A stringified number.
    maxInnerResultWindow string
    The maximum value of from + size for inner hits definition and top hits aggregations to this index. A stringified number.
    maxNgramDiff string
    The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter. A stringified number.
    maxRefreshListeners string
    Maximum number of refresh listeners available on each shard of the index. A stringified number.
    maxRegexLength string
    The maximum length of regex that can be used in Regexp Query. A stringified number.
    maxRescoreWindow string
    The maximum value of window_size for rescore requests in searches of this index. A stringified number.
    maxResultWindow string
    The maximum value of from + size for searches to this index. A stringified number.
    maxScriptFields string
    The maximum number of script_fields that are allowed in a query. A stringified number.
    maxShingleDiff string
    The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter. A stringified number.
    maxTermsCount string
    The maximum number of terms that can be used in Terms Query. A stringified number.
    name string
    Name of the index to create
    numberOfReplicas string
    Number of shard replicas. A stringified number.
    numberOfRoutingShards string
    Value used with numberofshards to route documents to a primary shard. A stringified number. This can be set only on creation.
    numberOfShards string
    Number of shards for the index. This can be set only on creation.
    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.
    rolloverAlias string
    routingAllocationEnable string
    Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
    routingPartitionSize string
    The number of shards a custom routing value can go to. A stringified number. 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
    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.
    sortField string
    The field to sort shards in this index by.
    sortOrder string
    The direction to sort shards in. Accepts asc, desc.
    aliases str
    A JSON string describing a set of aliases. The index aliases API allows aliasing an index with a name, with all APIs automatically converting the alias name to the actual index name. An alias can also be mapped to more than one index, and when specifying it, the alias will automatically expand to the aliased indices.
    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 str
    The maximum number of tokens that can be produced using _analyze API. A stringified number.
    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.
    force_destroy bool
    A boolean that indicates that the index should be deleted even if it contains documents.
    gc_deletes str
    The length of time that a deleted document's version number remains available for further versioned operations.
    highlight_max_analyzed_offset str
    The maximum number of characters that will be analyzed for a highlight request. A stringified number.
    include_type_name str
    A string that indicates if and what we should pass to includetypename parameter. Set to "false" when trying to create an index on a v6 cluster without a doc type or set to "true" when trying to create an index on a v7 cluster with a doc type. Since mapping updates are not currently supported, this applies only on index create.
    index_id str
    The ID of this resource.
    index_knn bool
    Indicates whether the index should build native library indices for the knnvector fields. If set to false, the knnvector fields will be stored in doc values, but Approximate k-NN search functionality will be disabled.
    index_knn_algo_param_ef_search str
    The size of the dynamic list used during k-NN searches. Higher values lead to more accurate but slower searches. Only available for nmslib.
    index_similarity_default str
    A JSON string describing the default index similarity config.
    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.
    mappings str
    A JSON string defining how documents in the index, and the fields they contain, are stored and indexed. To avoid the complexities of field mapping updates, updates of this field are not allowed via this provider.
    max_docvalue_fields_search str
    The maximum number of docvalue_fields that are allowed in a query. A stringified number.
    max_inner_result_window str
    The maximum value of from + size for inner hits definition and top hits aggregations to this index. A stringified number.
    max_ngram_diff str
    The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter. A stringified number.
    max_refresh_listeners str
    Maximum number of refresh listeners available on each shard of the index. A stringified number.
    max_regex_length str
    The maximum length of regex that can be used in Regexp Query. A stringified number.
    max_rescore_window str
    The maximum value of window_size for rescore requests in searches of this index. A stringified number.
    max_result_window str
    The maximum value of from + size for searches to this index. A stringified number.
    max_script_fields str
    The maximum number of script_fields that are allowed in a query. A stringified number.
    max_shingle_diff str
    The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter. A stringified number.
    max_terms_count str
    The maximum number of terms that can be used in Terms Query. A stringified number.
    name str
    Name of the index to create
    number_of_replicas str
    Number of shard replicas. A stringified number.
    number_of_routing_shards str
    Value used with numberofshards to route documents to a primary shard. A stringified number. This can be set only on creation.
    number_of_shards str
    Number of shards for the index. This can be set only on creation.
    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.
    rollover_alias str
    routing_allocation_enable str
    Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
    routing_partition_size str
    The number of shards a custom routing value can go to. A stringified number. 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
    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_field str
    The field to sort shards in this index by.
    sort_order str
    The direction to sort shards in. Accepts asc, desc.
    aliases String
    A JSON string describing a set of aliases. The index aliases API allows aliasing an index with a name, with all APIs automatically converting the alias name to the actual index name. An alias can also be mapped to more than one index, and when specifying it, the alias will automatically expand to the aliased indices.
    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 String
    The maximum number of tokens that can be produced using _analyze API. A stringified number.
    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.
    forceDestroy Boolean
    A boolean that indicates that the index should be deleted even if it contains documents.
    gcDeletes String
    The length of time that a deleted document's version number remains available for further versioned operations.
    highlightMaxAnalyzedOffset String
    The maximum number of characters that will be analyzed for a highlight request. A stringified number.
    includeTypeName String
    A string that indicates if and what we should pass to includetypename parameter. Set to "false" when trying to create an index on a v6 cluster without a doc type or set to "true" when trying to create an index on a v7 cluster with a doc type. Since mapping updates are not currently supported, this applies only on index create.
    indexId String
    The ID of this resource.
    indexKnn Boolean
    Indicates whether the index should build native library indices for the knnvector fields. If set to false, the knnvector fields will be stored in doc values, but Approximate k-NN search functionality will be disabled.
    indexKnnAlgoParamEfSearch String
    The size of the dynamic list used during k-NN searches. Higher values lead to more accurate but slower searches. Only available for nmslib.
    indexSimilarityDefault String
    A JSON string describing the default index similarity config.
    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.
    mappings String
    A JSON string defining how documents in the index, and the fields they contain, are stored and indexed. To avoid the complexities of field mapping updates, updates of this field are not allowed via this provider.
    maxDocvalueFieldsSearch String
    The maximum number of docvalue_fields that are allowed in a query. A stringified number.
    maxInnerResultWindow String
    The maximum value of from + size for inner hits definition and top hits aggregations to this index. A stringified number.
    maxNgramDiff String
    The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter. A stringified number.
    maxRefreshListeners String
    Maximum number of refresh listeners available on each shard of the index. A stringified number.
    maxRegexLength String
    The maximum length of regex that can be used in Regexp Query. A stringified number.
    maxRescoreWindow String
    The maximum value of window_size for rescore requests in searches of this index. A stringified number.
    maxResultWindow String
    The maximum value of from + size for searches to this index. A stringified number.
    maxScriptFields String
    The maximum number of script_fields that are allowed in a query. A stringified number.
    maxShingleDiff String
    The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter. A stringified number.
    maxTermsCount String
    The maximum number of terms that can be used in Terms Query. A stringified number.
    name String
    Name of the index to create
    numberOfReplicas String
    Number of shard replicas. A stringified number.
    numberOfRoutingShards String
    Value used with numberofshards to route documents to a primary shard. A stringified number. This can be set only on creation.
    numberOfShards String
    Number of shards for the index. This can be set only on creation.
    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.
    rolloverAlias String
    routingAllocationEnable String
    Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
    routingPartitionSize String
    The number of shards a custom routing value can go to. A stringified number. 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
    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.
    sortField String
    The field to sort shards in this index by.
    sortOrder String
    The direction to sort shards in. Accepts asc, desc.

    Import

    Import by name

    $ pulumi import opensearch:index/index:Index test terraform-test

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

    Package Details

    Repository
    opensearch opensearch-project/terraform-provider-opensearch
    License
    Notes
    This Pulumi package is based on the opensearch Terraform Provider.
    opensearch logo
    opensearch 2.3.1 published on Monday, Apr 14, 2025 by opensearch-project
    opensearch-project/terraform-provider-opensearch