1. Packages
  2. Elasticstack Provider
  3. API Docs
  4. getElasticsearchIndices
elasticstack 0.11.14 published on Monday, Apr 14, 2025 by elastic

elasticstack.getElasticsearchIndices

Explore with Pulumi AI

Use this data source to retrieve and get information about existing Elasticsearch indices. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-index.html

Example Usage

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

const securityIndices = elasticstack.getElasticsearchIndices({
    target: ".security-*",
});
Copy
import pulumi
import pulumi_elasticstack as elasticstack

security_indices = elasticstack.get_elasticsearch_indices(target=".security-*")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := elasticstack.GetElasticsearchIndices(ctx, &elasticstack.GetElasticsearchIndicesArgs{
			Target: pulumi.StringRef(".security-*"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Elasticstack = Pulumi.Elasticstack;

return await Deployment.RunAsync(() => 
{
    var securityIndices = Elasticstack.GetElasticsearchIndices.Invoke(new()
    {
        Target = ".security-*",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.elasticstack.ElasticstackFunctions;
import com.pulumi.elasticstack.inputs.GetElasticsearchIndicesArgs;
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) {
        final var securityIndices = ElasticstackFunctions.getElasticsearchIndices(GetElasticsearchIndicesArgs.builder()
            .target(".security-*")
            .build());

    }
}
Copy
variables:
  securityIndices:
    fn::invoke:
      function: elasticstack:getElasticsearchIndices
      arguments:
        target: .security-*
Copy

Using getElasticsearchIndices

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getElasticsearchIndices(args: GetElasticsearchIndicesArgs, opts?: InvokeOptions): Promise<GetElasticsearchIndicesResult>
function getElasticsearchIndicesOutput(args: GetElasticsearchIndicesOutputArgs, opts?: InvokeOptions): Output<GetElasticsearchIndicesResult>
Copy
def get_elasticsearch_indices(target: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetElasticsearchIndicesResult
def get_elasticsearch_indices_output(target: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetElasticsearchIndicesResult]
Copy
func GetElasticsearchIndices(ctx *Context, args *GetElasticsearchIndicesArgs, opts ...InvokeOption) (*GetElasticsearchIndicesResult, error)
func GetElasticsearchIndicesOutput(ctx *Context, args *GetElasticsearchIndicesOutputArgs, opts ...InvokeOption) GetElasticsearchIndicesResultOutput
Copy

> Note: This function is named GetElasticsearchIndices in the Go SDK.

public static class GetElasticsearchIndices 
{
    public static Task<GetElasticsearchIndicesResult> InvokeAsync(GetElasticsearchIndicesArgs args, InvokeOptions? opts = null)
    public static Output<GetElasticsearchIndicesResult> Invoke(GetElasticsearchIndicesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetElasticsearchIndicesResult> getElasticsearchIndices(GetElasticsearchIndicesArgs args, InvokeOptions options)
public static Output<GetElasticsearchIndicesResult> getElasticsearchIndices(GetElasticsearchIndicesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: elasticstack:index/getElasticsearchIndices:getElasticsearchIndices
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Target string
Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this attribute or use * or _all.
Target string
Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this attribute or use * or _all.
target String
Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this attribute or use * or _all.
target string
Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this attribute or use * or _all.
target str
Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this attribute or use * or _all.
target String
Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this attribute or use * or _all.

getElasticsearchIndices Result

The following output properties are available:

Id string
Generated ID for the indices.
Indices List<GetElasticsearchIndicesIndex>
The list of indices.
Target string
Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this attribute or use * or _all.
Id string
Generated ID for the indices.
Indices []GetElasticsearchIndicesIndex
The list of indices.
Target string
Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this attribute or use * or _all.
id String
Generated ID for the indices.
indices List<GetElasticsearchIndicesIndex>
The list of indices.
target String
Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this attribute or use * or _all.
id string
Generated ID for the indices.
indices GetElasticsearchIndicesIndex[]
The list of indices.
target string
Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this attribute or use * or _all.
id str
Generated ID for the indices.
indices Sequence[GetElasticsearchIndicesIndex]
The list of indices.
target str
Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this attribute or use * or _all.
id String
Generated ID for the indices.
indices List<Property Map>
The list of indices.
target String
Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this attribute or use * or _all.

Supporting Types

GetElasticsearchIndicesIndex

DeletionProtection This property is required. bool
Id This property is required. string
Internal identifier of the resource.
Mappings This property is required. string
Mapping for fields in the index. If specified, this mapping can include: field names, field data types, mapping parameters. NOTE: - Changing datatypes in the existing mappings will force index to be re-created. - Removing field will be ignored by default same as elasticsearch. You need to recreate the index to remove field completely.
MasterTimeout This property is required. string
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s. This value is ignored when running against Serverless projects.
Name This property is required. string
Name of the index.
NumberOfReplicas This property is required. double
Number of shard replicas.
SettingsRaw This property is required. string
All raw settings fetched from the cluster.
Timeout This property is required. string
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.
WaitForActiveShards This property is required. string
The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (numberofreplicas+1). Default: 1, the primary shard. This value is ignored when running against Serverless projects.
Aliases List<GetElasticsearchIndicesIndexAlias>
Aliases for the index.
AnalysisAnalyzer string
A JSON string describing the analyzers applied to the index.
AnalysisCharFilter string
A JSON string describing the char_filters applied to the index.
AnalysisFilter string
A JSON string describing the filters applied to the index.
AnalysisNormalizer string
A JSON string describing the normalizers applied to the index.
AnalysisTokenizer string
A JSON string describing the tokenizers applied to the index.
AnalyzeMaxTokenCount double
The maximum number of tokens that can be produced using _analyze API.
AutoExpandReplicas string
Set the number of replicas to the node count in the cluster. Set to a dash delimited lower and upper bound (e.g. 0-5) or use all for the upper bound (e.g. 0-all)
BlocksMetadata bool
Set to true to disable index metadata reads and writes.
BlocksRead bool
Set to true to disable read operations against the index.
BlocksReadOnly bool
Set to true to make the index and index metadata read only, false to allow writes and metadata changes.
BlocksReadOnlyAllowDelete bool
Identical to index.blocks.read_only but allows deleting the index to free up resources.
BlocksWrite bool
Set to true to disable data write operations against the index. This setting does not affect metadata.
Codec string
The default value compresses stored data with LZ4 compression, but this can be set to best_compression which uses DEFLATE for a higher compression ratio. This can be set only on creation.
DefaultPipeline string
The default ingest node pipeline for this index. Index requests will fail if the default pipeline is set and the pipeline does not exist.
FinalPipeline string
Final ingest pipeline for the index. Indexing requests will fail if the final pipeline is set and the pipeline does not exist. The final pipeline always runs after the request pipeline (if specified) and the default pipeline (if it exists). The special pipeline name _none indicates no ingest pipeline will run.
GcDeletes string
The length of time that a deleted document's version number remains available for further versioned operations.
HighlightMaxAnalyzedOffset double
The maximum number of characters that will be analyzed for a highlight request.
IndexingSlowlogLevel string
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
IndexingSlowlogSource string
Set the number of characters of the _source to include in the slowlog lines, false or 0 will skip logging the source entirely and setting it to true will log the entire source regardless of size. The original _source is reformatted by default to make sure that it fits on a single log line.
IndexingSlowlogThresholdIndexDebug string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 2s
IndexingSlowlogThresholdIndexInfo string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 5s
IndexingSlowlogThresholdIndexTrace string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 500ms
IndexingSlowlogThresholdIndexWarn string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 10s
LoadFixedBitsetFiltersEagerly bool
Indicates whether cached filters are pre-loaded for nested queries. This can be set only on creation.
MappingCoerce bool
Set index level coercion setting that is applied to all mapping types.
MaxDocvalueFieldsSearch double
The maximum number of docvalue_fields that are allowed in a query.
MaxInnerResultWindow double
The maximum value of from + size for inner hits definition and top hits aggregations to this index.
MaxNgramDiff double
The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
MaxRefreshListeners double
Maximum number of refresh listeners available on each shard of the index.
MaxRegexLength double
The maximum length of regex that can be used in Regexp Query.
MaxRescoreWindow double
The maximum value of window_size for rescore requests in searches of this index.
MaxResultWindow double
The maximum value of from + size for searches to this index.
MaxScriptFields double
The maximum number of script_fields that are allowed in a query.
MaxShingleDiff double
The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
MaxTermsCount double
The maximum number of terms that can be used in Terms Query.
NumberOfRoutingShards double
Value used with numberofshards to route documents to a primary shard. This can be set only on creation.
NumberOfShards double
Number of shards for the index. This can be set only on creation.
QueryDefaultFields List<string>
Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
RefreshInterval string
How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to -1 to disable refresh.
RoutingAllocationEnable string
Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
RoutingPartitionSize double
The number of shards a custom routing value can go to. This can be set only on creation.
RoutingRebalanceEnable string
Enables shard rebalancing for this index. It can be set to: all, primaries , replicas , none.
SearchIdleAfter string
How long a shard can not receive a search or get request until it’s considered search idle.
SearchSlowlogLevel string
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
SearchSlowlogThresholdFetchDebug string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 2s
SearchSlowlogThresholdFetchInfo string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 5s
SearchSlowlogThresholdFetchTrace string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 500ms
SearchSlowlogThresholdFetchWarn string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 10s
SearchSlowlogThresholdQueryDebug string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 2s
SearchSlowlogThresholdQueryInfo string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 5s
SearchSlowlogThresholdQueryTrace string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 500ms
SearchSlowlogThresholdQueryWarn string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 10s
ShardCheckOnStartup string
Whether or not shards should be checked for corruption before opening. When corruption is detected, it will prevent the shard from being opened. Accepts false, true, checksum.
SortFields List<string>
The field to sort shards in this index by.
SortOrders List<string>
The direction to sort shards in. Accepts asc, desc.
UnassignedNodeLeftDelayedTimeout string
Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g. 10s
DeletionProtection This property is required. bool
Id This property is required. string
Internal identifier of the resource.
Mappings This property is required. string
Mapping for fields in the index. If specified, this mapping can include: field names, field data types, mapping parameters. NOTE: - Changing datatypes in the existing mappings will force index to be re-created. - Removing field will be ignored by default same as elasticsearch. You need to recreate the index to remove field completely.
MasterTimeout This property is required. string
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s. This value is ignored when running against Serverless projects.
Name This property is required. string
Name of the index.
NumberOfReplicas This property is required. float64
Number of shard replicas.
SettingsRaw This property is required. string
All raw settings fetched from the cluster.
Timeout This property is required. string
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.
WaitForActiveShards This property is required. string
The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (numberofreplicas+1). Default: 1, the primary shard. This value is ignored when running against Serverless projects.
Aliases []GetElasticsearchIndicesIndexAlias
Aliases for the index.
AnalysisAnalyzer string
A JSON string describing the analyzers applied to the index.
AnalysisCharFilter string
A JSON string describing the char_filters applied to the index.
AnalysisFilter string
A JSON string describing the filters applied to the index.
AnalysisNormalizer string
A JSON string describing the normalizers applied to the index.
AnalysisTokenizer string
A JSON string describing the tokenizers applied to the index.
AnalyzeMaxTokenCount float64
The maximum number of tokens that can be produced using _analyze API.
AutoExpandReplicas string
Set the number of replicas to the node count in the cluster. Set to a dash delimited lower and upper bound (e.g. 0-5) or use all for the upper bound (e.g. 0-all)
BlocksMetadata bool
Set to true to disable index metadata reads and writes.
BlocksRead bool
Set to true to disable read operations against the index.
BlocksReadOnly bool
Set to true to make the index and index metadata read only, false to allow writes and metadata changes.
BlocksReadOnlyAllowDelete bool
Identical to index.blocks.read_only but allows deleting the index to free up resources.
BlocksWrite bool
Set to true to disable data write operations against the index. This setting does not affect metadata.
Codec string
The default value compresses stored data with LZ4 compression, but this can be set to best_compression which uses DEFLATE for a higher compression ratio. This can be set only on creation.
DefaultPipeline string
The default ingest node pipeline for this index. Index requests will fail if the default pipeline is set and the pipeline does not exist.
FinalPipeline string
Final ingest pipeline for the index. Indexing requests will fail if the final pipeline is set and the pipeline does not exist. The final pipeline always runs after the request pipeline (if specified) and the default pipeline (if it exists). The special pipeline name _none indicates no ingest pipeline will run.
GcDeletes string
The length of time that a deleted document's version number remains available for further versioned operations.
HighlightMaxAnalyzedOffset float64
The maximum number of characters that will be analyzed for a highlight request.
IndexingSlowlogLevel string
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
IndexingSlowlogSource string
Set the number of characters of the _source to include in the slowlog lines, false or 0 will skip logging the source entirely and setting it to true will log the entire source regardless of size. The original _source is reformatted by default to make sure that it fits on a single log line.
IndexingSlowlogThresholdIndexDebug string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 2s
IndexingSlowlogThresholdIndexInfo string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 5s
IndexingSlowlogThresholdIndexTrace string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 500ms
IndexingSlowlogThresholdIndexWarn string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 10s
LoadFixedBitsetFiltersEagerly bool
Indicates whether cached filters are pre-loaded for nested queries. This can be set only on creation.
MappingCoerce bool
Set index level coercion setting that is applied to all mapping types.
MaxDocvalueFieldsSearch float64
The maximum number of docvalue_fields that are allowed in a query.
MaxInnerResultWindow float64
The maximum value of from + size for inner hits definition and top hits aggregations to this index.
MaxNgramDiff float64
The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
MaxRefreshListeners float64
Maximum number of refresh listeners available on each shard of the index.
MaxRegexLength float64
The maximum length of regex that can be used in Regexp Query.
MaxRescoreWindow float64
The maximum value of window_size for rescore requests in searches of this index.
MaxResultWindow float64
The maximum value of from + size for searches to this index.
MaxScriptFields float64
The maximum number of script_fields that are allowed in a query.
MaxShingleDiff float64
The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
MaxTermsCount float64
The maximum number of terms that can be used in Terms Query.
NumberOfRoutingShards float64
Value used with numberofshards to route documents to a primary shard. This can be set only on creation.
NumberOfShards float64
Number of shards for the index. This can be set only on creation.
QueryDefaultFields []string
Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
RefreshInterval string
How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to -1 to disable refresh.
RoutingAllocationEnable string
Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
RoutingPartitionSize float64
The number of shards a custom routing value can go to. This can be set only on creation.
RoutingRebalanceEnable string
Enables shard rebalancing for this index. It can be set to: all, primaries , replicas , none.
SearchIdleAfter string
How long a shard can not receive a search or get request until it’s considered search idle.
SearchSlowlogLevel string
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
SearchSlowlogThresholdFetchDebug string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 2s
SearchSlowlogThresholdFetchInfo string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 5s
SearchSlowlogThresholdFetchTrace string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 500ms
SearchSlowlogThresholdFetchWarn string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 10s
SearchSlowlogThresholdQueryDebug string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 2s
SearchSlowlogThresholdQueryInfo string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 5s
SearchSlowlogThresholdQueryTrace string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 500ms
SearchSlowlogThresholdQueryWarn string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 10s
ShardCheckOnStartup string
Whether or not shards should be checked for corruption before opening. When corruption is detected, it will prevent the shard from being opened. Accepts false, true, checksum.
SortFields []string
The field to sort shards in this index by.
SortOrders []string
The direction to sort shards in. Accepts asc, desc.
UnassignedNodeLeftDelayedTimeout string
Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g. 10s
deletionProtection This property is required. Boolean
id This property is required. String
Internal identifier of the resource.
mappings This property is required. String
Mapping for fields in the index. If specified, this mapping can include: field names, field data types, mapping parameters. NOTE: - Changing datatypes in the existing mappings will force index to be re-created. - Removing field will be ignored by default same as elasticsearch. You need to recreate the index to remove field completely.
masterTimeout This property is required. String
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s. This value is ignored when running against Serverless projects.
name This property is required. String
Name of the index.
numberOfReplicas This property is required. Double
Number of shard replicas.
settingsRaw This property is required. String
All raw settings fetched from the cluster.
timeout This property is required. String
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.
waitForActiveShards This property is required. String
The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (numberofreplicas+1). Default: 1, the primary shard. This value is ignored when running against Serverless projects.
aliases List<GetElasticsearchIndicesIndexAlias>
Aliases for the index.
analysisAnalyzer String
A JSON string describing the analyzers applied to the index.
analysisCharFilter String
A JSON string describing the char_filters applied to the index.
analysisFilter String
A JSON string describing the filters applied to the index.
analysisNormalizer String
A JSON string describing the normalizers applied to the index.
analysisTokenizer String
A JSON string describing the tokenizers applied to the index.
analyzeMaxTokenCount Double
The maximum number of tokens that can be produced using _analyze API.
autoExpandReplicas String
Set the number of replicas to the node count in the cluster. Set to a dash delimited lower and upper bound (e.g. 0-5) or use all for the upper bound (e.g. 0-all)
blocksMetadata Boolean
Set to true to disable index metadata reads and writes.
blocksRead Boolean
Set to true to disable read operations against the index.
blocksReadOnly Boolean
Set to true to make the index and index metadata read only, false to allow writes and metadata changes.
blocksReadOnlyAllowDelete Boolean
Identical to index.blocks.read_only but allows deleting the index to free up resources.
blocksWrite Boolean
Set to true to disable data write operations against the index. This setting does not affect metadata.
codec String
The default value compresses stored data with LZ4 compression, but this can be set to best_compression which uses DEFLATE for a higher compression ratio. This can be set only on creation.
defaultPipeline String
The default ingest node pipeline for this index. Index requests will fail if the default pipeline is set and the pipeline does not exist.
finalPipeline String
Final ingest pipeline for the index. Indexing requests will fail if the final pipeline is set and the pipeline does not exist. The final pipeline always runs after the request pipeline (if specified) and the default pipeline (if it exists). The special pipeline name _none indicates no ingest pipeline will run.
gcDeletes String
The length of time that a deleted document's version number remains available for further versioned operations.
highlightMaxAnalyzedOffset Double
The maximum number of characters that will be analyzed for a highlight request.
indexingSlowlogLevel String
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
indexingSlowlogSource String
Set the number of characters of the _source to include in the slowlog lines, false or 0 will skip logging the source entirely and setting it to true will log the entire source regardless of size. The original _source is reformatted by default to make sure that it fits on a single log line.
indexingSlowlogThresholdIndexDebug String
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 2s
indexingSlowlogThresholdIndexInfo String
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 5s
indexingSlowlogThresholdIndexTrace String
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 500ms
indexingSlowlogThresholdIndexWarn String
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 10s
loadFixedBitsetFiltersEagerly Boolean
Indicates whether cached filters are pre-loaded for nested queries. This can be set only on creation.
mappingCoerce Boolean
Set index level coercion setting that is applied to all mapping types.
maxDocvalueFieldsSearch Double
The maximum number of docvalue_fields that are allowed in a query.
maxInnerResultWindow Double
The maximum value of from + size for inner hits definition and top hits aggregations to this index.
maxNgramDiff Double
The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
maxRefreshListeners Double
Maximum number of refresh listeners available on each shard of the index.
maxRegexLength Double
The maximum length of regex that can be used in Regexp Query.
maxRescoreWindow Double
The maximum value of window_size for rescore requests in searches of this index.
maxResultWindow Double
The maximum value of from + size for searches to this index.
maxScriptFields Double
The maximum number of script_fields that are allowed in a query.
maxShingleDiff Double
The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
maxTermsCount Double
The maximum number of terms that can be used in Terms Query.
numberOfRoutingShards Double
Value used with numberofshards to route documents to a primary shard. This can be set only on creation.
numberOfShards Double
Number of shards for the index. This can be set only on creation.
queryDefaultFields List<String>
Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
refreshInterval String
How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to -1 to disable refresh.
routingAllocationEnable String
Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
routingPartitionSize Double
The number of shards a custom routing value can go to. This can be set only on creation.
routingRebalanceEnable String
Enables shard rebalancing for this index. It can be set to: all, primaries , replicas , none.
searchIdleAfter String
How long a shard can not receive a search or get request until it’s considered search idle.
searchSlowlogLevel String
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
searchSlowlogThresholdFetchDebug String
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 2s
searchSlowlogThresholdFetchInfo String
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 5s
searchSlowlogThresholdFetchTrace String
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 500ms
searchSlowlogThresholdFetchWarn String
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 10s
searchSlowlogThresholdQueryDebug String
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 2s
searchSlowlogThresholdQueryInfo String
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 5s
searchSlowlogThresholdQueryTrace String
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 500ms
searchSlowlogThresholdQueryWarn String
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 10s
shardCheckOnStartup String
Whether or not shards should be checked for corruption before opening. When corruption is detected, it will prevent the shard from being opened. Accepts false, true, checksum.
sortFields List<String>
The field to sort shards in this index by.
sortOrders List<String>
The direction to sort shards in. Accepts asc, desc.
unassignedNodeLeftDelayedTimeout String
Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g. 10s
deletionProtection This property is required. boolean
id This property is required. string
Internal identifier of the resource.
mappings This property is required. string
Mapping for fields in the index. If specified, this mapping can include: field names, field data types, mapping parameters. NOTE: - Changing datatypes in the existing mappings will force index to be re-created. - Removing field will be ignored by default same as elasticsearch. You need to recreate the index to remove field completely.
masterTimeout This property is required. string
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s. This value is ignored when running against Serverless projects.
name This property is required. string
Name of the index.
numberOfReplicas This property is required. number
Number of shard replicas.
settingsRaw This property is required. string
All raw settings fetched from the cluster.
timeout This property is required. string
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.
waitForActiveShards This property is required. string
The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (numberofreplicas+1). Default: 1, the primary shard. This value is ignored when running against Serverless projects.
aliases GetElasticsearchIndicesIndexAlias[]
Aliases for the index.
analysisAnalyzer string
A JSON string describing the analyzers applied to the index.
analysisCharFilter string
A JSON string describing the char_filters applied to the index.
analysisFilter string
A JSON string describing the filters applied to the index.
analysisNormalizer string
A JSON string describing the normalizers applied to the index.
analysisTokenizer string
A JSON string describing the tokenizers applied to the index.
analyzeMaxTokenCount number
The maximum number of tokens that can be produced using _analyze API.
autoExpandReplicas string
Set the number of replicas to the node count in the cluster. Set to a dash delimited lower and upper bound (e.g. 0-5) or use all for the upper bound (e.g. 0-all)
blocksMetadata boolean
Set to true to disable index metadata reads and writes.
blocksRead boolean
Set to true to disable read operations against the index.
blocksReadOnly boolean
Set to true to make the index and index metadata read only, false to allow writes and metadata changes.
blocksReadOnlyAllowDelete boolean
Identical to index.blocks.read_only but allows deleting the index to free up resources.
blocksWrite boolean
Set to true to disable data write operations against the index. This setting does not affect metadata.
codec string
The default value compresses stored data with LZ4 compression, but this can be set to best_compression which uses DEFLATE for a higher compression ratio. This can be set only on creation.
defaultPipeline string
The default ingest node pipeline for this index. Index requests will fail if the default pipeline is set and the pipeline does not exist.
finalPipeline string
Final ingest pipeline for the index. Indexing requests will fail if the final pipeline is set and the pipeline does not exist. The final pipeline always runs after the request pipeline (if specified) and the default pipeline (if it exists). The special pipeline name _none indicates no ingest pipeline will run.
gcDeletes string
The length of time that a deleted document's version number remains available for further versioned operations.
highlightMaxAnalyzedOffset number
The maximum number of characters that will be analyzed for a highlight request.
indexingSlowlogLevel string
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
indexingSlowlogSource string
Set the number of characters of the _source to include in the slowlog lines, false or 0 will skip logging the source entirely and setting it to true will log the entire source regardless of size. The original _source is reformatted by default to make sure that it fits on a single log line.
indexingSlowlogThresholdIndexDebug string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 2s
indexingSlowlogThresholdIndexInfo string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 5s
indexingSlowlogThresholdIndexTrace string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 500ms
indexingSlowlogThresholdIndexWarn string
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 10s
loadFixedBitsetFiltersEagerly boolean
Indicates whether cached filters are pre-loaded for nested queries. This can be set only on creation.
mappingCoerce boolean
Set index level coercion setting that is applied to all mapping types.
maxDocvalueFieldsSearch number
The maximum number of docvalue_fields that are allowed in a query.
maxInnerResultWindow number
The maximum value of from + size for inner hits definition and top hits aggregations to this index.
maxNgramDiff number
The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
maxRefreshListeners number
Maximum number of refresh listeners available on each shard of the index.
maxRegexLength number
The maximum length of regex that can be used in Regexp Query.
maxRescoreWindow number
The maximum value of window_size for rescore requests in searches of this index.
maxResultWindow number
The maximum value of from + size for searches to this index.
maxScriptFields number
The maximum number of script_fields that are allowed in a query.
maxShingleDiff number
The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
maxTermsCount number
The maximum number of terms that can be used in Terms Query.
numberOfRoutingShards number
Value used with numberofshards to route documents to a primary shard. This can be set only on creation.
numberOfShards number
Number of shards for the index. This can be set only on creation.
queryDefaultFields string[]
Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
refreshInterval string
How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to -1 to disable refresh.
routingAllocationEnable string
Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
routingPartitionSize number
The number of shards a custom routing value can go to. This can be set only on creation.
routingRebalanceEnable string
Enables shard rebalancing for this index. It can be set to: all, primaries , replicas , none.
searchIdleAfter string
How long a shard can not receive a search or get request until it’s considered search idle.
searchSlowlogLevel string
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
searchSlowlogThresholdFetchDebug string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 2s
searchSlowlogThresholdFetchInfo string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 5s
searchSlowlogThresholdFetchTrace string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 500ms
searchSlowlogThresholdFetchWarn string
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 10s
searchSlowlogThresholdQueryDebug string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 2s
searchSlowlogThresholdQueryInfo string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 5s
searchSlowlogThresholdQueryTrace string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 500ms
searchSlowlogThresholdQueryWarn string
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 10s
shardCheckOnStartup string
Whether or not shards should be checked for corruption before opening. When corruption is detected, it will prevent the shard from being opened. Accepts false, true, checksum.
sortFields string[]
The field to sort shards in this index by.
sortOrders string[]
The direction to sort shards in. Accepts asc, desc.
unassignedNodeLeftDelayedTimeout string
Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g. 10s
deletion_protection This property is required. bool
id This property is required. str
Internal identifier of the resource.
mappings This property is required. str
Mapping for fields in the index. If specified, this mapping can include: field names, field data types, mapping parameters. NOTE: - Changing datatypes in the existing mappings will force index to be re-created. - Removing field will be ignored by default same as elasticsearch. You need to recreate the index to remove field completely.
master_timeout This property is required. str
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s. This value is ignored when running against Serverless projects.
name This property is required. str
Name of the index.
number_of_replicas This property is required. float
Number of shard replicas.
settings_raw This property is required. str
All raw settings fetched from the cluster.
timeout This property is required. str
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.
wait_for_active_shards This property is required. str
The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (numberofreplicas+1). Default: 1, the primary shard. This value is ignored when running against Serverless projects.
aliases Sequence[GetElasticsearchIndicesIndexAlias]
Aliases for the index.
analysis_analyzer str
A JSON string describing the analyzers applied to the index.
analysis_char_filter str
A JSON string describing the char_filters applied to the index.
analysis_filter str
A JSON string describing the filters applied to the index.
analysis_normalizer str
A JSON string describing the normalizers applied to the index.
analysis_tokenizer str
A JSON string describing the tokenizers applied to the index.
analyze_max_token_count float
The maximum number of tokens that can be produced using _analyze API.
auto_expand_replicas str
Set the number of replicas to the node count in the cluster. Set to a dash delimited lower and upper bound (e.g. 0-5) or use all for the upper bound (e.g. 0-all)
blocks_metadata bool
Set to true to disable index metadata reads and writes.
blocks_read bool
Set to true to disable read operations against the index.
blocks_read_only bool
Set to true to make the index and index metadata read only, false to allow writes and metadata changes.
blocks_read_only_allow_delete bool
Identical to index.blocks.read_only but allows deleting the index to free up resources.
blocks_write bool
Set to true to disable data write operations against the index. This setting does not affect metadata.
codec str
The default value compresses stored data with LZ4 compression, but this can be set to best_compression which uses DEFLATE for a higher compression ratio. This can be set only on creation.
default_pipeline str
The default ingest node pipeline for this index. Index requests will fail if the default pipeline is set and the pipeline does not exist.
final_pipeline str
Final ingest pipeline for the index. Indexing requests will fail if the final pipeline is set and the pipeline does not exist. The final pipeline always runs after the request pipeline (if specified) and the default pipeline (if it exists). The special pipeline name _none indicates no ingest pipeline will run.
gc_deletes str
The length of time that a deleted document's version number remains available for further versioned operations.
highlight_max_analyzed_offset float
The maximum number of characters that will be analyzed for a highlight request.
indexing_slowlog_level str
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
indexing_slowlog_source str
Set the number of characters of the _source to include in the slowlog lines, false or 0 will skip logging the source entirely and setting it to true will log the entire source regardless of size. The original _source is reformatted by default to make sure that it fits on a single log line.
indexing_slowlog_threshold_index_debug str
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 2s
indexing_slowlog_threshold_index_info str
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 5s
indexing_slowlog_threshold_index_trace str
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 500ms
indexing_slowlog_threshold_index_warn str
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 10s
load_fixed_bitset_filters_eagerly bool
Indicates whether cached filters are pre-loaded for nested queries. This can be set only on creation.
mapping_coerce bool
Set index level coercion setting that is applied to all mapping types.
max_docvalue_fields_search float
The maximum number of docvalue_fields that are allowed in a query.
max_inner_result_window float
The maximum value of from + size for inner hits definition and top hits aggregations to this index.
max_ngram_diff float
The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
max_refresh_listeners float
Maximum number of refresh listeners available on each shard of the index.
max_regex_length float
The maximum length of regex that can be used in Regexp Query.
max_rescore_window float
The maximum value of window_size for rescore requests in searches of this index.
max_result_window float
The maximum value of from + size for searches to this index.
max_script_fields float
The maximum number of script_fields that are allowed in a query.
max_shingle_diff float
The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
max_terms_count float
The maximum number of terms that can be used in Terms Query.
number_of_routing_shards float
Value used with numberofshards to route documents to a primary shard. This can be set only on creation.
number_of_shards float
Number of shards for the index. This can be set only on creation.
query_default_fields Sequence[str]
Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
refresh_interval str
How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to -1 to disable refresh.
routing_allocation_enable str
Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
routing_partition_size float
The number of shards a custom routing value can go to. This can be set only on creation.
routing_rebalance_enable str
Enables shard rebalancing for this index. It can be set to: all, primaries , replicas , none.
search_idle_after str
How long a shard can not receive a search or get request until it’s considered search idle.
search_slowlog_level str
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
search_slowlog_threshold_fetch_debug str
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 2s
search_slowlog_threshold_fetch_info str
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 5s
search_slowlog_threshold_fetch_trace str
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 500ms
search_slowlog_threshold_fetch_warn str
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 10s
search_slowlog_threshold_query_debug str
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 2s
search_slowlog_threshold_query_info str
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 5s
search_slowlog_threshold_query_trace str
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 500ms
search_slowlog_threshold_query_warn str
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 10s
shard_check_on_startup str
Whether or not shards should be checked for corruption before opening. When corruption is detected, it will prevent the shard from being opened. Accepts false, true, checksum.
sort_fields Sequence[str]
The field to sort shards in this index by.
sort_orders Sequence[str]
The direction to sort shards in. Accepts asc, desc.
unassigned_node_left_delayed_timeout str
Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g. 10s
deletionProtection This property is required. Boolean
id This property is required. String
Internal identifier of the resource.
mappings This property is required. String
Mapping for fields in the index. If specified, this mapping can include: field names, field data types, mapping parameters. NOTE: - Changing datatypes in the existing mappings will force index to be re-created. - Removing field will be ignored by default same as elasticsearch. You need to recreate the index to remove field completely.
masterTimeout This property is required. String
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s. This value is ignored when running against Serverless projects.
name This property is required. String
Name of the index.
numberOfReplicas This property is required. Number
Number of shard replicas.
settingsRaw This property is required. String
All raw settings fetched from the cluster.
timeout This property is required. String
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.
waitForActiveShards This property is required. String
The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (numberofreplicas+1). Default: 1, the primary shard. This value is ignored when running against Serverless projects.
aliases List<Property Map>
Aliases for the index.
analysisAnalyzer String
A JSON string describing the analyzers applied to the index.
analysisCharFilter String
A JSON string describing the char_filters applied to the index.
analysisFilter String
A JSON string describing the filters applied to the index.
analysisNormalizer String
A JSON string describing the normalizers applied to the index.
analysisTokenizer String
A JSON string describing the tokenizers applied to the index.
analyzeMaxTokenCount Number
The maximum number of tokens that can be produced using _analyze API.
autoExpandReplicas String
Set the number of replicas to the node count in the cluster. Set to a dash delimited lower and upper bound (e.g. 0-5) or use all for the upper bound (e.g. 0-all)
blocksMetadata Boolean
Set to true to disable index metadata reads and writes.
blocksRead Boolean
Set to true to disable read operations against the index.
blocksReadOnly Boolean
Set to true to make the index and index metadata read only, false to allow writes and metadata changes.
blocksReadOnlyAllowDelete Boolean
Identical to index.blocks.read_only but allows deleting the index to free up resources.
blocksWrite Boolean
Set to true to disable data write operations against the index. This setting does not affect metadata.
codec String
The default value compresses stored data with LZ4 compression, but this can be set to best_compression which uses DEFLATE for a higher compression ratio. This can be set only on creation.
defaultPipeline String
The default ingest node pipeline for this index. Index requests will fail if the default pipeline is set and the pipeline does not exist.
finalPipeline String
Final ingest pipeline for the index. Indexing requests will fail if the final pipeline is set and the pipeline does not exist. The final pipeline always runs after the request pipeline (if specified) and the default pipeline (if it exists). The special pipeline name _none indicates no ingest pipeline will run.
gcDeletes String
The length of time that a deleted document's version number remains available for further versioned operations.
highlightMaxAnalyzedOffset Number
The maximum number of characters that will be analyzed for a highlight request.
indexingSlowlogLevel String
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
indexingSlowlogSource String
Set the number of characters of the _source to include in the slowlog lines, false or 0 will skip logging the source entirely and setting it to true will log the entire source regardless of size. The original _source is reformatted by default to make sure that it fits on a single log line.
indexingSlowlogThresholdIndexDebug String
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 2s
indexingSlowlogThresholdIndexInfo String
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 5s
indexingSlowlogThresholdIndexTrace String
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 500ms
indexingSlowlogThresholdIndexWarn String
Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g. 10s
loadFixedBitsetFiltersEagerly Boolean
Indicates whether cached filters are pre-loaded for nested queries. This can be set only on creation.
mappingCoerce Boolean
Set index level coercion setting that is applied to all mapping types.
maxDocvalueFieldsSearch Number
The maximum number of docvalue_fields that are allowed in a query.
maxInnerResultWindow Number
The maximum value of from + size for inner hits definition and top hits aggregations to this index.
maxNgramDiff Number
The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
maxRefreshListeners Number
Maximum number of refresh listeners available on each shard of the index.
maxRegexLength Number
The maximum length of regex that can be used in Regexp Query.
maxRescoreWindow Number
The maximum value of window_size for rescore requests in searches of this index.
maxResultWindow Number
The maximum value of from + size for searches to this index.
maxScriptFields Number
The maximum number of script_fields that are allowed in a query.
maxShingleDiff Number
The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
maxTermsCount Number
The maximum number of terms that can be used in Terms Query.
numberOfRoutingShards Number
Value used with numberofshards to route documents to a primary shard. This can be set only on creation.
numberOfShards Number
Number of shards for the index. This can be set only on creation.
queryDefaultFields List<String>
Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
refreshInterval String
How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to -1 to disable refresh.
routingAllocationEnable String
Controls shard allocation for this index. It can be set to: all , primaries , new_primaries , none.
routingPartitionSize Number
The number of shards a custom routing value can go to. This can be set only on creation.
routingRebalanceEnable String
Enables shard rebalancing for this index. It can be set to: all, primaries , replicas , none.
searchIdleAfter String
How long a shard can not receive a search or get request until it’s considered search idle.
searchSlowlogLevel String
Set which logging level to use for the search slow log, can be: warn, info, debug, trace
searchSlowlogThresholdFetchDebug String
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 2s
searchSlowlogThresholdFetchInfo String
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 5s
searchSlowlogThresholdFetchTrace String
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 500ms
searchSlowlogThresholdFetchWarn String
Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g. 10s
searchSlowlogThresholdQueryDebug String
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 2s
searchSlowlogThresholdQueryInfo String
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 5s
searchSlowlogThresholdQueryTrace String
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 500ms
searchSlowlogThresholdQueryWarn String
Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g. 10s
shardCheckOnStartup String
Whether or not shards should be checked for corruption before opening. When corruption is detected, it will prevent the shard from being opened. Accepts false, true, checksum.
sortFields List<String>
The field to sort shards in this index by.
sortOrders List<String>
The direction to sort shards in. Accepts asc, desc.
unassignedNodeLeftDelayedTimeout String
Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g. 10s

GetElasticsearchIndicesIndexAlias

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

Package Details

Repository
elasticstack elastic/terraform-provider-elasticstack
License
Notes
This Pulumi package is based on the elasticstack Terraform Provider.