published on Tuesday, Nov 10, 2026 by elastic
published on Tuesday, Nov 10, 2026 by elastic
Manages the dynamic settings of an existing Elasticsearch index without managing the index itself. Changing or omitting a setting updates or resets it on the index; destroy does not revert settings and the index is left in place.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as elasticstack from "@pulumi/elasticstack";
const myIndexSettings = new elasticstack.ElasticsearchIndexSettings("my_index_settings", {
index: "my-index",
numberOfReplicas: 2,
refreshInterval: "30s",
settingsJson: JSON.stringify({
max_result_window: 20000,
}),
});
import pulumi
import json
import pulumi_elasticstack as elasticstack
my_index_settings = elasticstack.ElasticsearchIndexSettings("my_index_settings",
index="my-index",
number_of_replicas=2,
refresh_interval="30s",
settings_json=json.dumps({
"max_result_window": 20000,
}))
package main
import (
"encoding/json"
"github.com/pulumi/pulumi-terraform-provider/sdks/go/elasticstack/elasticstack"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
tmpJSON0, err := json.Marshal(map[string]interface{}{
"max_result_window": 20000,
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
_, err = elasticstack.NewElasticsearchIndexSettings(ctx, "my_index_settings", &elasticstack.ElasticsearchIndexSettingsArgs{
Index: pulumi.String("my-index"),
NumberOfReplicas: pulumi.Float64(2),
RefreshInterval: pulumi.String("30s"),
SettingsJson: pulumi.String(json0),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Elasticstack = Pulumi.Elasticstack;
return await Deployment.RunAsync(() =>
{
var myIndexSettings = new Elasticstack.ElasticsearchIndexSettings("my_index_settings", new()
{
Index = "my-index",
NumberOfReplicas = 2,
RefreshInterval = "30s",
SettingsJson = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["max_result_window"] = 20000,
}),
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.elasticstack.ElasticsearchIndexSettings;
import com.pulumi.elasticstack.ElasticsearchIndexSettingsArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var myIndexSettings = new ElasticsearchIndexSettings("myIndexSettings", ElasticsearchIndexSettingsArgs.builder()
.index("my-index")
.numberOfReplicas(2.0)
.refreshInterval("30s")
.settingsJson(serializeJson(
jsonObject(
jsonProperty("max_result_window", 20000)
)))
.build());
}
}
resources:
myIndexSettings:
type: elasticstack:ElasticsearchIndexSettings
name: my_index_settings
properties:
index: my-index
numberOfReplicas: 2
refreshInterval: 30s
settingsJson:
fn::toJSON:
max_result_window: 20000
Example coming soon!
Create ElasticsearchIndexSettings Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ElasticsearchIndexSettings(name: string, args: ElasticsearchIndexSettingsArgs, opts?: CustomResourceOptions);@overload
def ElasticsearchIndexSettings(resource_name: str,
args: ElasticsearchIndexSettingsArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ElasticsearchIndexSettings(resource_name: str,
opts: Optional[ResourceOptions] = None,
index: Optional[str] = None,
max_regex_length: Optional[float] = None,
indexing_slowlog_level: Optional[str] = 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,
default_pipeline: Optional[str] = None,
elasticsearch_connections: Optional[Sequence[ElasticsearchIndexSettingsElasticsearchConnectionArgs]] = None,
final_pipeline: Optional[str] = None,
gc_deletes: Optional[str] = None,
highlight_max_analyzed_offset: Optional[float] = None,
auto_expand_replicas: Optional[str] = None,
analyze_max_token_count: Optional[float] = 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,
mapping_total_fields_limit: Optional[float] = None,
max_docvalue_fields_search: Optional[float] = None,
max_inner_result_window: Optional[float] = None,
max_ngram_diff: Optional[float] = None,
blocks_metadata: Optional[bool] = None,
max_refresh_listeners: Optional[float] = None,
refresh_interval: Optional[str] = None,
max_result_window: Optional[float] = None,
max_script_fields: Optional[float] = None,
max_shingle_diff: Optional[float] = None,
max_terms_count: Optional[float] = None,
number_of_replicas: Optional[float] = None,
query_default_fields: Optional[Sequence[str]] = None,
max_rescore_window: Optional[float] = None,
routing_allocation_enable: 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,
settings_json: Optional[str] = None,
timeouts: Optional[ElasticsearchIndexSettingsTimeoutsArgs] = None,
unassigned_node_left_delayed_timeout: Optional[str] = None)func NewElasticsearchIndexSettings(ctx *Context, name string, args ElasticsearchIndexSettingsArgs, opts ...ResourceOption) (*ElasticsearchIndexSettings, error)public ElasticsearchIndexSettings(string name, ElasticsearchIndexSettingsArgs args, CustomResourceOptions? opts = null)
public ElasticsearchIndexSettings(String name, ElasticsearchIndexSettingsArgs args)
public ElasticsearchIndexSettings(String name, ElasticsearchIndexSettingsArgs args, CustomResourceOptions options)
type: elasticstack:ElasticsearchIndexSettings
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "elasticstack_elasticsearch_index_settings" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args ElasticsearchIndexSettingsArgs
- 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 ElasticsearchIndexSettingsArgs
- 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 ElasticsearchIndexSettingsArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ElasticsearchIndexSettingsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ElasticsearchIndexSettingsArgs
- 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 elasticsearchIndexSettingsResource = new Elasticstack.ElasticsearchIndexSettings("elasticsearchIndexSettingsResource", new()
{
Index = "string",
MaxRegexLength = 0.0,
IndexingSlowlogLevel = "string",
BlocksRead = false,
BlocksReadOnly = false,
BlocksReadOnlyAllowDelete = false,
BlocksWrite = false,
DefaultPipeline = "string",
ElasticsearchConnections = new[]
{
new Elasticstack.Inputs.ElasticsearchIndexSettingsElasticsearchConnectionArgs
{
ApiKey = "string",
BearerToken = "string",
CaData = "string",
CaFile = "string",
CaFingerprint = "string",
CertData = "string",
CertFile = "string",
Endpoints = new[]
{
"string",
},
EsClientAuthentication = "string",
Headers =
{
{ "string", "string" },
},
Insecure = false,
KeyData = "string",
KeyFile = "string",
Password = "string",
Username = "string",
},
},
FinalPipeline = "string",
GcDeletes = "string",
HighlightMaxAnalyzedOffset = 0.0,
AutoExpandReplicas = "string",
AnalyzeMaxTokenCount = 0.0,
IndexingSlowlogSource = "string",
IndexingSlowlogThresholdIndexDebug = "string",
IndexingSlowlogThresholdIndexInfo = "string",
IndexingSlowlogThresholdIndexTrace = "string",
IndexingSlowlogThresholdIndexWarn = "string",
MappingTotalFieldsLimit = 0.0,
MaxDocvalueFieldsSearch = 0.0,
MaxInnerResultWindow = 0.0,
MaxNgramDiff = 0.0,
BlocksMetadata = false,
MaxRefreshListeners = 0.0,
RefreshInterval = "string",
MaxResultWindow = 0.0,
MaxScriptFields = 0.0,
MaxShingleDiff = 0.0,
MaxTermsCount = 0.0,
NumberOfReplicas = 0.0,
QueryDefaultFields = new[]
{
"string",
},
MaxRescoreWindow = 0.0,
RoutingAllocationEnable = "string",
RoutingRebalanceEnable = "string",
SearchIdleAfter = "string",
SearchSlowlogLevel = "string",
SearchSlowlogThresholdFetchDebug = "string",
SearchSlowlogThresholdFetchInfo = "string",
SearchSlowlogThresholdFetchTrace = "string",
SearchSlowlogThresholdFetchWarn = "string",
SearchSlowlogThresholdQueryDebug = "string",
SearchSlowlogThresholdQueryInfo = "string",
SearchSlowlogThresholdQueryTrace = "string",
SearchSlowlogThresholdQueryWarn = "string",
SettingsJson = "string",
Timeouts = new Elasticstack.Inputs.ElasticsearchIndexSettingsTimeoutsArgs
{
Create = "string",
Delete = "string",
Read = "string",
Update = "string",
},
UnassignedNodeLeftDelayedTimeout = "string",
});
example, err := elasticstack.NewElasticsearchIndexSettings(ctx, "elasticsearchIndexSettingsResource", &elasticstack.ElasticsearchIndexSettingsArgs{
Index: pulumi.String("string"),
MaxRegexLength: pulumi.Float64(0),
IndexingSlowlogLevel: pulumi.String("string"),
BlocksRead: pulumi.Bool(false),
BlocksReadOnly: pulumi.Bool(false),
BlocksReadOnlyAllowDelete: pulumi.Bool(false),
BlocksWrite: pulumi.Bool(false),
DefaultPipeline: pulumi.String("string"),
ElasticsearchConnections: elasticstack.ElasticsearchIndexSettingsElasticsearchConnectionArray{
&elasticstack.ElasticsearchIndexSettingsElasticsearchConnectionArgs{
ApiKey: pulumi.String("string"),
BearerToken: pulumi.String("string"),
CaData: pulumi.String("string"),
CaFile: pulumi.String("string"),
CaFingerprint: pulumi.String("string"),
CertData: pulumi.String("string"),
CertFile: pulumi.String("string"),
Endpoints: pulumi.StringArray{
pulumi.String("string"),
},
EsClientAuthentication: pulumi.String("string"),
Headers: pulumi.StringMap{
"string": pulumi.String("string"),
},
Insecure: pulumi.Bool(false),
KeyData: pulumi.String("string"),
KeyFile: pulumi.String("string"),
Password: pulumi.String("string"),
Username: pulumi.String("string"),
},
},
FinalPipeline: pulumi.String("string"),
GcDeletes: pulumi.String("string"),
HighlightMaxAnalyzedOffset: pulumi.Float64(0),
AutoExpandReplicas: pulumi.String("string"),
AnalyzeMaxTokenCount: pulumi.Float64(0),
IndexingSlowlogSource: pulumi.String("string"),
IndexingSlowlogThresholdIndexDebug: pulumi.String("string"),
IndexingSlowlogThresholdIndexInfo: pulumi.String("string"),
IndexingSlowlogThresholdIndexTrace: pulumi.String("string"),
IndexingSlowlogThresholdIndexWarn: pulumi.String("string"),
MappingTotalFieldsLimit: pulumi.Float64(0),
MaxDocvalueFieldsSearch: pulumi.Float64(0),
MaxInnerResultWindow: pulumi.Float64(0),
MaxNgramDiff: pulumi.Float64(0),
BlocksMetadata: pulumi.Bool(false),
MaxRefreshListeners: pulumi.Float64(0),
RefreshInterval: pulumi.String("string"),
MaxResultWindow: pulumi.Float64(0),
MaxScriptFields: pulumi.Float64(0),
MaxShingleDiff: pulumi.Float64(0),
MaxTermsCount: pulumi.Float64(0),
NumberOfReplicas: pulumi.Float64(0),
QueryDefaultFields: pulumi.StringArray{
pulumi.String("string"),
},
MaxRescoreWindow: pulumi.Float64(0),
RoutingAllocationEnable: 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"),
SettingsJson: pulumi.String("string"),
Timeouts: &elasticstack.ElasticsearchIndexSettingsTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Read: pulumi.String("string"),
Update: pulumi.String("string"),
},
UnassignedNodeLeftDelayedTimeout: pulumi.String("string"),
})
resource "elasticstack_elasticsearch_index_settings" "elasticsearchIndexSettingsResource" {
lifecycle {
create_before_destroy = true
}
index = "string"
max_regex_length = 0
indexing_slowlog_level = "string"
blocks_read = false
blocks_read_only = false
blocks_read_only_allow_delete = false
blocks_write = false
default_pipeline = "string"
elasticsearch_connections {
api_key = "string"
bearer_token = "string"
ca_data = "string"
ca_file = "string"
ca_fingerprint = "string"
cert_data = "string"
cert_file = "string"
endpoints = ["string"]
es_client_authentication = "string"
headers = {
"string" = "string"
}
insecure = false
key_data = "string"
key_file = "string"
password = "string"
username = "string"
}
final_pipeline = "string"
gc_deletes = "string"
highlight_max_analyzed_offset = 0
auto_expand_replicas = "string"
analyze_max_token_count = 0
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"
mapping_total_fields_limit = 0
max_docvalue_fields_search = 0
max_inner_result_window = 0
max_ngram_diff = 0
blocks_metadata = false
max_refresh_listeners = 0
refresh_interval = "string"
max_result_window = 0
max_script_fields = 0
max_shingle_diff = 0
max_terms_count = 0
number_of_replicas = 0
query_default_fields = ["string"]
max_rescore_window = 0
routing_allocation_enable = "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"
settings_json = "string"
_ {
timeouts = {
create = "string"
delete = "string"
read = "string"
update = "string"
}
}
unassigned_node_left_delayed_timeout = "string"
}
var elasticsearchIndexSettingsResource = new ElasticsearchIndexSettings("elasticsearchIndexSettingsResource", ElasticsearchIndexSettingsArgs.builder()
.index("string")
.maxRegexLength(0.0)
.indexingSlowlogLevel("string")
.blocksRead(false)
.blocksReadOnly(false)
.blocksReadOnlyAllowDelete(false)
.blocksWrite(false)
.defaultPipeline("string")
.elasticsearchConnections(ElasticsearchIndexSettingsElasticsearchConnectionArgs.builder()
.apiKey("string")
.bearerToken("string")
.caData("string")
.caFile("string")
.caFingerprint("string")
.certData("string")
.certFile("string")
.endpoints("string")
.esClientAuthentication("string")
.headers(Map.of("string", "string"))
.insecure(false)
.keyData("string")
.keyFile("string")
.password("string")
.username("string")
.build())
.finalPipeline("string")
.gcDeletes("string")
.highlightMaxAnalyzedOffset(0.0)
.autoExpandReplicas("string")
.analyzeMaxTokenCount(0.0)
.indexingSlowlogSource("string")
.indexingSlowlogThresholdIndexDebug("string")
.indexingSlowlogThresholdIndexInfo("string")
.indexingSlowlogThresholdIndexTrace("string")
.indexingSlowlogThresholdIndexWarn("string")
.mappingTotalFieldsLimit(0.0)
.maxDocvalueFieldsSearch(0.0)
.maxInnerResultWindow(0.0)
.maxNgramDiff(0.0)
.blocksMetadata(false)
.maxRefreshListeners(0.0)
.refreshInterval("string")
.maxResultWindow(0.0)
.maxScriptFields(0.0)
.maxShingleDiff(0.0)
.maxTermsCount(0.0)
.numberOfReplicas(0.0)
.queryDefaultFields("string")
.maxRescoreWindow(0.0)
.routingAllocationEnable("string")
.routingRebalanceEnable("string")
.searchIdleAfter("string")
.searchSlowlogLevel("string")
.searchSlowlogThresholdFetchDebug("string")
.searchSlowlogThresholdFetchInfo("string")
.searchSlowlogThresholdFetchTrace("string")
.searchSlowlogThresholdFetchWarn("string")
.searchSlowlogThresholdQueryDebug("string")
.searchSlowlogThresholdQueryInfo("string")
.searchSlowlogThresholdQueryTrace("string")
.searchSlowlogThresholdQueryWarn("string")
.settingsJson("string")
.timeouts(ElasticsearchIndexSettingsTimeoutsArgs.builder()
.create("string")
.delete("string")
.read("string")
.update("string")
.build())
.unassignedNodeLeftDelayedTimeout("string")
.build());
elasticsearch_index_settings_resource = elasticstack.ElasticsearchIndexSettings("elasticsearchIndexSettingsResource",
index="string",
max_regex_length=float(0),
indexing_slowlog_level="string",
blocks_read=False,
blocks_read_only=False,
blocks_read_only_allow_delete=False,
blocks_write=False,
default_pipeline="string",
elasticsearch_connections=[{
"api_key": "string",
"bearer_token": "string",
"ca_data": "string",
"ca_file": "string",
"ca_fingerprint": "string",
"cert_data": "string",
"cert_file": "string",
"endpoints": ["string"],
"es_client_authentication": "string",
"headers": {
"string": "string",
},
"insecure": False,
"key_data": "string",
"key_file": "string",
"password": "string",
"username": "string",
}],
final_pipeline="string",
gc_deletes="string",
highlight_max_analyzed_offset=float(0),
auto_expand_replicas="string",
analyze_max_token_count=float(0),
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",
mapping_total_fields_limit=float(0),
max_docvalue_fields_search=float(0),
max_inner_result_window=float(0),
max_ngram_diff=float(0),
blocks_metadata=False,
max_refresh_listeners=float(0),
refresh_interval="string",
max_result_window=float(0),
max_script_fields=float(0),
max_shingle_diff=float(0),
max_terms_count=float(0),
number_of_replicas=float(0),
query_default_fields=["string"],
max_rescore_window=float(0),
routing_allocation_enable="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",
settings_json="string",
timeouts={
"create": "string",
"delete": "string",
"read": "string",
"update": "string",
},
unassigned_node_left_delayed_timeout="string")
const elasticsearchIndexSettingsResource = new elasticstack.ElasticsearchIndexSettings("elasticsearchIndexSettingsResource", {
index: "string",
maxRegexLength: 0,
indexingSlowlogLevel: "string",
blocksRead: false,
blocksReadOnly: false,
blocksReadOnlyAllowDelete: false,
blocksWrite: false,
defaultPipeline: "string",
elasticsearchConnections: [{
apiKey: "string",
bearerToken: "string",
caData: "string",
caFile: "string",
caFingerprint: "string",
certData: "string",
certFile: "string",
endpoints: ["string"],
esClientAuthentication: "string",
headers: {
string: "string",
},
insecure: false,
keyData: "string",
keyFile: "string",
password: "string",
username: "string",
}],
finalPipeline: "string",
gcDeletes: "string",
highlightMaxAnalyzedOffset: 0,
autoExpandReplicas: "string",
analyzeMaxTokenCount: 0,
indexingSlowlogSource: "string",
indexingSlowlogThresholdIndexDebug: "string",
indexingSlowlogThresholdIndexInfo: "string",
indexingSlowlogThresholdIndexTrace: "string",
indexingSlowlogThresholdIndexWarn: "string",
mappingTotalFieldsLimit: 0,
maxDocvalueFieldsSearch: 0,
maxInnerResultWindow: 0,
maxNgramDiff: 0,
blocksMetadata: false,
maxRefreshListeners: 0,
refreshInterval: "string",
maxResultWindow: 0,
maxScriptFields: 0,
maxShingleDiff: 0,
maxTermsCount: 0,
numberOfReplicas: 0,
queryDefaultFields: ["string"],
maxRescoreWindow: 0,
routingAllocationEnable: "string",
routingRebalanceEnable: "string",
searchIdleAfter: "string",
searchSlowlogLevel: "string",
searchSlowlogThresholdFetchDebug: "string",
searchSlowlogThresholdFetchInfo: "string",
searchSlowlogThresholdFetchTrace: "string",
searchSlowlogThresholdFetchWarn: "string",
searchSlowlogThresholdQueryDebug: "string",
searchSlowlogThresholdQueryInfo: "string",
searchSlowlogThresholdQueryTrace: "string",
searchSlowlogThresholdQueryWarn: "string",
settingsJson: "string",
timeouts: {
create: "string",
"delete": "string",
read: "string",
update: "string",
},
unassignedNodeLeftDelayedTimeout: "string",
});
type: elasticstack:ElasticsearchIndexSettings
properties:
analyzeMaxTokenCount: 0
autoExpandReplicas: string
blocksMetadata: false
blocksRead: false
blocksReadOnly: false
blocksReadOnlyAllowDelete: false
blocksWrite: false
defaultPipeline: string
elasticsearchConnections:
- apiKey: string
bearerToken: string
caData: string
caFile: string
caFingerprint: string
certData: string
certFile: string
endpoints:
- string
esClientAuthentication: string
headers:
string: string
insecure: false
keyData: string
keyFile: string
password: string
username: string
finalPipeline: string
gcDeletes: string
highlightMaxAnalyzedOffset: 0
index: string
indexingSlowlogLevel: string
indexingSlowlogSource: string
indexingSlowlogThresholdIndexDebug: string
indexingSlowlogThresholdIndexInfo: string
indexingSlowlogThresholdIndexTrace: string
indexingSlowlogThresholdIndexWarn: string
mappingTotalFieldsLimit: 0
maxDocvalueFieldsSearch: 0
maxInnerResultWindow: 0
maxNgramDiff: 0
maxRefreshListeners: 0
maxRegexLength: 0
maxRescoreWindow: 0
maxResultWindow: 0
maxScriptFields: 0
maxShingleDiff: 0
maxTermsCount: 0
numberOfReplicas: 0
queryDefaultFields:
- string
refreshInterval: string
routingAllocationEnable: string
routingRebalanceEnable: string
searchIdleAfter: string
searchSlowlogLevel: string
searchSlowlogThresholdFetchDebug: string
searchSlowlogThresholdFetchInfo: string
searchSlowlogThresholdFetchTrace: string
searchSlowlogThresholdFetchWarn: string
searchSlowlogThresholdQueryDebug: string
searchSlowlogThresholdQueryInfo: string
searchSlowlogThresholdQueryTrace: string
searchSlowlogThresholdQueryWarn: string
settingsJson: string
timeouts:
create: string
delete: string
read: string
update: string
unassignedNodeLeftDelayedTimeout: string
ElasticsearchIndexSettings 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 ElasticsearchIndexSettings resource accepts the following input properties:
- Index string
- Name of the target Elasticsearch index; changing it forces replacement. The name is treated as an already-resolved concrete index (no date-math resolution).
- Analyze
Max doubleToken Count - The maximum number of tokens that can be produced using _analyze API.
- Auto
Expand stringReplicas - 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
trueto disable index metadata reads and writes. - Blocks
Read bool - Set to
trueto disable read operations against the index. - Blocks
Read boolOnly - Set to
trueto make the index and index metadata read only,falseto allow writes and metadata changes. - Blocks
Read boolOnly Allow Delete - Identical to
index.blocks.read_onlybut allows deleting the index to free up resources. - Blocks
Write bool - Set to
trueto disable data write operations against the index. This setting does not affect metadata. - Default
Pipeline 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.
- Elasticsearch
Connections List<ElasticsearchIndex Settings Elasticsearch Connection> - Elasticsearch connection configuration block.
- Final
Pipeline 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
_noneindicates no ingest pipeline will run. - Gc
Deletes string - The length of time that a deleted document's version number remains available for further versioned operations.
- Highlight
Max doubleAnalyzed Offset - The maximum number of characters that will be analyzed for a highlight request.
- Indexing
Slowlog stringLevel - Set which logging level to use for the search slow log, can be:
warn,info,debug,trace - Indexing
Slowlog stringSource - Set the number of characters of the
_sourceto include in the slowlog lines.falseor0skips logging the source entirely;truelogs the entire source regardless of size. The original_sourceis reformatted by default to make sure that it fits on a single log line. - Indexing
Slowlog stringThreshold Index Debug - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
2s - Indexing
Slowlog stringThreshold Index Info - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
5s - Indexing
Slowlog stringThreshold Index Trace - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
500ms - Indexing
Slowlog stringThreshold Index Warn - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
10s - Mapping
Total doubleFields Limit - The maximum number of fields in an index. Field type parameters count towards this limit. The default value is 1000.
- Max
Docvalue doubleFields Search - The maximum number of
docvalue_fieldsthat are allowed in a query. - Max
Inner doubleResult Window - The maximum value of
from + sizefor inner hits definition and top hits aggregations to this index. - Max
Ngram doubleDiff - The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
- Max
Refresh doubleListeners - Maximum number of refresh listeners available on each shard of the index.
- Max
Regex doubleLength - The maximum length of regex that can be used in Regexp Query.
- Max
Rescore doubleWindow - The maximum value of
window_sizeforrescorerequests in searches of this index. - Max
Result doubleWindow - The maximum value of
from + sizefor searches to this index. - Max
Script doubleFields - The maximum number of
script_fieldsthat are allowed in a query. - Max
Shingle doubleDiff - The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
- Max
Terms doubleCount - The maximum number of terms that can be used in Terms Query.
- Number
Of doubleReplicas - Number of shard replicas.
- Query
Default List<string>Fields - Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
- Refresh
Interval string - How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to
-1to disable refresh. - Routing
Allocation stringEnable - Controls shard allocation for this index. It can be set to:
all,primaries,new_primaries,none. - Routing
Rebalance stringEnable - Enables shard rebalancing for this index. It can be set to:
all,primaries,replicas,none. - Search
Idle stringAfter - How long a shard can not receive a search or get request until it’s considered search idle.
- Search
Slowlog stringLevel - Set which logging level to use for the search slow log, can be:
warn,info,debug,trace - Search
Slowlog stringThreshold Fetch Debug - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
2s - Search
Slowlog stringThreshold Fetch Info - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
5s - Search
Slowlog stringThreshold Fetch Trace - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
500ms - Search
Slowlog stringThreshold Fetch Warn - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
10s - Search
Slowlog stringThreshold Query Debug - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
2s - Search
Slowlog stringThreshold Query Info - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
5s - Search
Slowlog stringThreshold Query Trace - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
500ms - Search
Slowlog stringThreshold Query Warn - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
10s - Settings
Json string - Flat JSON object of dynamic index settings not covered by the typed attributes (e.g.
{"max_result_window": 20000}). Use flat dotted setting keys; values are scalars or arrays of scalars (including empty arrays). Creation-time-only (static) settings, nested objects, explicitnullvalues and object or null array elements are rejected. To reset a setting, omit it. Keys set here must not also be set via a typed attribute. - Timeouts
Elasticsearch
Index Settings Timeouts - Unassigned
Node stringLeft Delayed Timeout - Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g.
10s
- Index string
- Name of the target Elasticsearch index; changing it forces replacement. The name is treated as an already-resolved concrete index (no date-math resolution).
- Analyze
Max float64Token Count - The maximum number of tokens that can be produced using _analyze API.
- Auto
Expand stringReplicas - 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
trueto disable index metadata reads and writes. - Blocks
Read bool - Set to
trueto disable read operations against the index. - Blocks
Read boolOnly - Set to
trueto make the index and index metadata read only,falseto allow writes and metadata changes. - Blocks
Read boolOnly Allow Delete - Identical to
index.blocks.read_onlybut allows deleting the index to free up resources. - Blocks
Write bool - Set to
trueto disable data write operations against the index. This setting does not affect metadata. - Default
Pipeline 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.
- Elasticsearch
Connections []ElasticsearchIndex Settings Elasticsearch Connection Args - Elasticsearch connection configuration block.
- Final
Pipeline 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
_noneindicates no ingest pipeline will run. - Gc
Deletes string - The length of time that a deleted document's version number remains available for further versioned operations.
- Highlight
Max float64Analyzed Offset - The maximum number of characters that will be analyzed for a highlight request.
- Indexing
Slowlog stringLevel - Set which logging level to use for the search slow log, can be:
warn,info,debug,trace - Indexing
Slowlog stringSource - Set the number of characters of the
_sourceto include in the slowlog lines.falseor0skips logging the source entirely;truelogs the entire source regardless of size. The original_sourceis reformatted by default to make sure that it fits on a single log line. - Indexing
Slowlog stringThreshold Index Debug - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
2s - Indexing
Slowlog stringThreshold Index Info - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
5s - Indexing
Slowlog stringThreshold Index Trace - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
500ms - Indexing
Slowlog stringThreshold Index Warn - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
10s - Mapping
Total float64Fields Limit - The maximum number of fields in an index. Field type parameters count towards this limit. The default value is 1000.
- Max
Docvalue float64Fields Search - The maximum number of
docvalue_fieldsthat are allowed in a query. - Max
Inner float64Result Window - The maximum value of
from + sizefor inner hits definition and top hits aggregations to this index. - Max
Ngram float64Diff - The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
- Max
Refresh float64Listeners - Maximum number of refresh listeners available on each shard of the index.
- Max
Regex float64Length - The maximum length of regex that can be used in Regexp Query.
- Max
Rescore float64Window - The maximum value of
window_sizeforrescorerequests in searches of this index. - Max
Result float64Window - The maximum value of
from + sizefor searches to this index. - Max
Script float64Fields - The maximum number of
script_fieldsthat are allowed in a query. - Max
Shingle float64Diff - The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
- Max
Terms float64Count - The maximum number of terms that can be used in Terms Query.
- Number
Of float64Replicas - Number of shard replicas.
- Query
Default []stringFields - Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
- Refresh
Interval string - How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to
-1to disable refresh. - Routing
Allocation stringEnable - Controls shard allocation for this index. It can be set to:
all,primaries,new_primaries,none. - Routing
Rebalance stringEnable - Enables shard rebalancing for this index. It can be set to:
all,primaries,replicas,none. - Search
Idle stringAfter - How long a shard can not receive a search or get request until it’s considered search idle.
- Search
Slowlog stringLevel - Set which logging level to use for the search slow log, can be:
warn,info,debug,trace - Search
Slowlog stringThreshold Fetch Debug - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
2s - Search
Slowlog stringThreshold Fetch Info - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
5s - Search
Slowlog stringThreshold Fetch Trace - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
500ms - Search
Slowlog stringThreshold Fetch Warn - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
10s - Search
Slowlog stringThreshold Query Debug - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
2s - Search
Slowlog stringThreshold Query Info - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
5s - Search
Slowlog stringThreshold Query Trace - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
500ms - Search
Slowlog stringThreshold Query Warn - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
10s - Settings
Json string - Flat JSON object of dynamic index settings not covered by the typed attributes (e.g.
{"max_result_window": 20000}). Use flat dotted setting keys; values are scalars or arrays of scalars (including empty arrays). Creation-time-only (static) settings, nested objects, explicitnullvalues and object or null array elements are rejected. To reset a setting, omit it. Keys set here must not also be set via a typed attribute. - Timeouts
Elasticsearch
Index Settings Timeouts Args - Unassigned
Node stringLeft Delayed Timeout - Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g.
10s
- index string
- Name of the target Elasticsearch index; changing it forces replacement. The name is treated as an already-resolved concrete index (no date-math resolution).
- analyze_
max_ numbertoken_ count - The maximum number of tokens that can be produced using _analyze API.
- auto_
expand_ stringreplicas - 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
trueto disable index metadata reads and writes. - blocks_
read bool - Set to
trueto disable read operations against the index. - blocks_
read_ boolonly - Set to
trueto make the index and index metadata read only,falseto allow writes and metadata changes. - blocks_
read_ boolonly_ allow_ delete - Identical to
index.blocks.read_onlybut allows deleting the index to free up resources. - blocks_
write bool - Set to
trueto disable data write operations against the index. This setting does not affect metadata. - default_
pipeline 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.
- elasticsearch_
connections list(object) - Elasticsearch connection configuration block.
- final_
pipeline 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
_noneindicates no ingest pipeline will run. - gc_
deletes string - The length of time that a deleted document's version number remains available for further versioned operations.
- highlight_
max_ numberanalyzed_ offset - The maximum number of characters that will be analyzed for a highlight request.
- indexing_
slowlog_ stringlevel - Set which logging level to use for the search slow log, can be:
warn,info,debug,trace - indexing_
slowlog_ stringsource - Set the number of characters of the
_sourceto include in the slowlog lines.falseor0skips logging the source entirely;truelogs the entire source regardless of size. The original_sourceis reformatted by default to make sure that it fits on a single log line. - indexing_
slowlog_ stringthreshold_ index_ debug - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
2s - indexing_
slowlog_ stringthreshold_ index_ info - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
5s - indexing_
slowlog_ stringthreshold_ index_ trace - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
500ms - indexing_
slowlog_ stringthreshold_ index_ warn - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
10s - mapping_
total_ numberfields_ limit - The maximum number of fields in an index. Field type parameters count towards this limit. The default value is 1000.
- max_
docvalue_ numberfields_ search - The maximum number of
docvalue_fieldsthat are allowed in a query. - max_
inner_ numberresult_ window - The maximum value of
from + sizefor inner hits definition and top hits aggregations to this index. - max_
ngram_ numberdiff - The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
- max_
refresh_ numberlisteners - Maximum number of refresh listeners available on each shard of the index.
- max_
regex_ numberlength - The maximum length of regex that can be used in Regexp Query.
- max_
rescore_ numberwindow - The maximum value of
window_sizeforrescorerequests in searches of this index. - max_
result_ numberwindow - The maximum value of
from + sizefor searches to this index. - max_
script_ numberfields - The maximum number of
script_fieldsthat are allowed in a query. - max_
shingle_ numberdiff - The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
- max_
terms_ numbercount - The maximum number of terms that can be used in Terms Query.
- number_
of_ numberreplicas - Number of shard replicas.
- query_
default_ list(string)fields - Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
- refresh_
interval string - How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to
-1to disable refresh. - routing_
allocation_ stringenable - Controls shard allocation for this index. It can be set to:
all,primaries,new_primaries,none. - routing_
rebalance_ stringenable - Enables shard rebalancing for this index. It can be set to:
all,primaries,replicas,none. - search_
idle_ stringafter - How long a shard can not receive a search or get request until it’s considered search idle.
- search_
slowlog_ stringlevel - Set which logging level to use for the search slow log, can be:
warn,info,debug,trace - search_
slowlog_ stringthreshold_ fetch_ debug - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
2s - search_
slowlog_ stringthreshold_ fetch_ info - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
5s - search_
slowlog_ stringthreshold_ fetch_ trace - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
500ms - search_
slowlog_ stringthreshold_ fetch_ warn - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
10s - search_
slowlog_ stringthreshold_ query_ debug - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
2s - search_
slowlog_ stringthreshold_ query_ info - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
5s - search_
slowlog_ stringthreshold_ query_ trace - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
500ms - search_
slowlog_ stringthreshold_ query_ warn - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
10s - settings_
json string - Flat JSON object of dynamic index settings not covered by the typed attributes (e.g.
{"max_result_window": 20000}). Use flat dotted setting keys; values are scalars or arrays of scalars (including empty arrays). Creation-time-only (static) settings, nested objects, explicitnullvalues and object or null array elements are rejected. To reset a setting, omit it. Keys set here must not also be set via a typed attribute. - timeouts object
- unassigned_
node_ stringleft_ delayed_ timeout - Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g.
10s
- index String
- Name of the target Elasticsearch index; changing it forces replacement. The name is treated as an already-resolved concrete index (no date-math resolution).
- analyze
Max DoubleToken Count - The maximum number of tokens that can be produced using _analyze API.
- auto
Expand StringReplicas - 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 Boolean - Set to
trueto disable index metadata reads and writes. - blocks
Read Boolean - Set to
trueto disable read operations against the index. - blocks
Read BooleanOnly - Set to
trueto make the index and index metadata read only,falseto allow writes and metadata changes. - blocks
Read BooleanOnly Allow Delete - Identical to
index.blocks.read_onlybut allows deleting the index to free up resources. - blocks
Write Boolean - Set to
trueto disable data write operations against the index. This setting does not affect metadata. - default
Pipeline 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.
- elasticsearch
Connections List<ElasticsearchIndex Settings Elasticsearch Connection> - Elasticsearch connection configuration block.
- final
Pipeline 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
_noneindicates no ingest pipeline will run. - gc
Deletes String - The length of time that a deleted document's version number remains available for further versioned operations.
- highlight
Max DoubleAnalyzed Offset - The maximum number of characters that will be analyzed for a highlight request.
- indexing
Slowlog StringLevel - Set which logging level to use for the search slow log, can be:
warn,info,debug,trace - indexing
Slowlog StringSource - Set the number of characters of the
_sourceto include in the slowlog lines.falseor0skips logging the source entirely;truelogs the entire source regardless of size. The original_sourceis reformatted by default to make sure that it fits on a single log line. - indexing
Slowlog StringThreshold Index Debug - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
2s - indexing
Slowlog StringThreshold Index Info - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
5s - indexing
Slowlog StringThreshold Index Trace - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
500ms - indexing
Slowlog StringThreshold Index Warn - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
10s - mapping
Total DoubleFields Limit - The maximum number of fields in an index. Field type parameters count towards this limit. The default value is 1000.
- max
Docvalue DoubleFields Search - The maximum number of
docvalue_fieldsthat are allowed in a query. - max
Inner DoubleResult Window - The maximum value of
from + sizefor inner hits definition and top hits aggregations to this index. - max
Ngram DoubleDiff - The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
- max
Refresh DoubleListeners - Maximum number of refresh listeners available on each shard of the index.
- max
Regex DoubleLength - The maximum length of regex that can be used in Regexp Query.
- max
Rescore DoubleWindow - The maximum value of
window_sizeforrescorerequests in searches of this index. - max
Result DoubleWindow - The maximum value of
from + sizefor searches to this index. - max
Script DoubleFields - The maximum number of
script_fieldsthat are allowed in a query. - max
Shingle DoubleDiff - The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
- max
Terms DoubleCount - The maximum number of terms that can be used in Terms Query.
- number
Of DoubleReplicas - Number of shard replicas.
- query
Default List<String>Fields - Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
- refresh
Interval String - How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to
-1to disable refresh. - routing
Allocation StringEnable - Controls shard allocation for this index. It can be set to:
all,primaries,new_primaries,none. - routing
Rebalance StringEnable - Enables shard rebalancing for this index. It can be set to:
all,primaries,replicas,none. - search
Idle StringAfter - How long a shard can not receive a search or get request until it’s considered search idle.
- search
Slowlog StringLevel - Set which logging level to use for the search slow log, can be:
warn,info,debug,trace - search
Slowlog StringThreshold Fetch Debug - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
2s - search
Slowlog StringThreshold Fetch Info - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
5s - search
Slowlog StringThreshold Fetch Trace - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
500ms - search
Slowlog StringThreshold Fetch Warn - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
10s - search
Slowlog StringThreshold Query Debug - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
2s - search
Slowlog StringThreshold Query Info - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
5s - search
Slowlog StringThreshold Query Trace - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
500ms - search
Slowlog StringThreshold Query Warn - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
10s - settings
Json String - Flat JSON object of dynamic index settings not covered by the typed attributes (e.g.
{"max_result_window": 20000}). Use flat dotted setting keys; values are scalars or arrays of scalars (including empty arrays). Creation-time-only (static) settings, nested objects, explicitnullvalues and object or null array elements are rejected. To reset a setting, omit it. Keys set here must not also be set via a typed attribute. - timeouts
Elasticsearch
Index Settings Timeouts - unassigned
Node StringLeft Delayed Timeout - Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g.
10s
- index string
- Name of the target Elasticsearch index; changing it forces replacement. The name is treated as an already-resolved concrete index (no date-math resolution).
- analyze
Max numberToken Count - The maximum number of tokens that can be produced using _analyze API.
- auto
Expand stringReplicas - 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 boolean - Set to
trueto disable index metadata reads and writes. - blocks
Read boolean - Set to
trueto disable read operations against the index. - blocks
Read booleanOnly - Set to
trueto make the index and index metadata read only,falseto allow writes and metadata changes. - blocks
Read booleanOnly Allow Delete - Identical to
index.blocks.read_onlybut allows deleting the index to free up resources. - blocks
Write boolean - Set to
trueto disable data write operations against the index. This setting does not affect metadata. - default
Pipeline 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.
- elasticsearch
Connections ElasticsearchIndex Settings Elasticsearch Connection[] - Elasticsearch connection configuration block.
- final
Pipeline 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
_noneindicates no ingest pipeline will run. - gc
Deletes string - The length of time that a deleted document's version number remains available for further versioned operations.
- highlight
Max numberAnalyzed Offset - The maximum number of characters that will be analyzed for a highlight request.
- indexing
Slowlog stringLevel - Set which logging level to use for the search slow log, can be:
warn,info,debug,trace - indexing
Slowlog stringSource - Set the number of characters of the
_sourceto include in the slowlog lines.falseor0skips logging the source entirely;truelogs the entire source regardless of size. The original_sourceis reformatted by default to make sure that it fits on a single log line. - indexing
Slowlog stringThreshold Index Debug - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
2s - indexing
Slowlog stringThreshold Index Info - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
5s - indexing
Slowlog stringThreshold Index Trace - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
500ms - indexing
Slowlog stringThreshold Index Warn - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
10s - mapping
Total numberFields Limit - The maximum number of fields in an index. Field type parameters count towards this limit. The default value is 1000.
- max
Docvalue numberFields Search - The maximum number of
docvalue_fieldsthat are allowed in a query. - max
Inner numberResult Window - The maximum value of
from + sizefor inner hits definition and top hits aggregations to this index. - max
Ngram numberDiff - The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
- max
Refresh numberListeners - Maximum number of refresh listeners available on each shard of the index.
- max
Regex numberLength - The maximum length of regex that can be used in Regexp Query.
- max
Rescore numberWindow - The maximum value of
window_sizeforrescorerequests in searches of this index. - max
Result numberWindow - The maximum value of
from + sizefor searches to this index. - max
Script numberFields - The maximum number of
script_fieldsthat are allowed in a query. - max
Shingle numberDiff - The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
- max
Terms numberCount - The maximum number of terms that can be used in Terms Query.
- number
Of numberReplicas - Number of shard replicas.
- query
Default string[]Fields - Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
- refresh
Interval string - How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to
-1to disable refresh. - routing
Allocation stringEnable - Controls shard allocation for this index. It can be set to:
all,primaries,new_primaries,none. - routing
Rebalance stringEnable - Enables shard rebalancing for this index. It can be set to:
all,primaries,replicas,none. - search
Idle stringAfter - How long a shard can not receive a search or get request until it’s considered search idle.
- search
Slowlog stringLevel - Set which logging level to use for the search slow log, can be:
warn,info,debug,trace - search
Slowlog stringThreshold Fetch Debug - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
2s - search
Slowlog stringThreshold Fetch Info - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
5s - search
Slowlog stringThreshold Fetch Trace - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
500ms - search
Slowlog stringThreshold Fetch Warn - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
10s - search
Slowlog stringThreshold Query Debug - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
2s - search
Slowlog stringThreshold Query Info - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
5s - search
Slowlog stringThreshold Query Trace - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
500ms - search
Slowlog stringThreshold Query Warn - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
10s - settings
Json string - Flat JSON object of dynamic index settings not covered by the typed attributes (e.g.
{"max_result_window": 20000}). Use flat dotted setting keys; values are scalars or arrays of scalars (including empty arrays). Creation-time-only (static) settings, nested objects, explicitnullvalues and object or null array elements are rejected. To reset a setting, omit it. Keys set here must not also be set via a typed attribute. - timeouts
Elasticsearch
Index Settings Timeouts - unassigned
Node stringLeft Delayed Timeout - Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g.
10s
- index str
- Name of the target Elasticsearch index; changing it forces replacement. The name is treated as an already-resolved concrete index (no date-math resolution).
- analyze_
max_ floattoken_ count - The maximum number of tokens that can be produced using _analyze API.
- auto_
expand_ strreplicas - 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
trueto disable index metadata reads and writes. - blocks_
read bool - Set to
trueto disable read operations against the index. - blocks_
read_ boolonly - Set to
trueto make the index and index metadata read only,falseto allow writes and metadata changes. - blocks_
read_ boolonly_ allow_ delete - Identical to
index.blocks.read_onlybut allows deleting the index to free up resources. - blocks_
write bool - Set to
trueto disable data write operations against the index. This setting does not affect metadata. - 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.
- elasticsearch_
connections Sequence[ElasticsearchIndex Settings Elasticsearch Connection Args] - Elasticsearch connection configuration block.
- 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
_noneindicates 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_ floatanalyzed_ offset - The maximum number of characters that will be analyzed for a highlight request.
- indexing_
slowlog_ strlevel - Set which logging level to use for the search slow log, can be:
warn,info,debug,trace - indexing_
slowlog_ strsource - Set the number of characters of the
_sourceto include in the slowlog lines.falseor0skips logging the source entirely;truelogs the entire source regardless of size. The original_sourceis reformatted by default to make sure that it fits on a single log line. - indexing_
slowlog_ strthreshold_ index_ debug - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
2s - indexing_
slowlog_ strthreshold_ index_ info - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
5s - indexing_
slowlog_ strthreshold_ index_ trace - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
500ms - indexing_
slowlog_ strthreshold_ index_ warn - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
10s - mapping_
total_ floatfields_ limit - The maximum number of fields in an index. Field type parameters count towards this limit. The default value is 1000.
- max_
docvalue_ floatfields_ search - The maximum number of
docvalue_fieldsthat are allowed in a query. - max_
inner_ floatresult_ window - The maximum value of
from + sizefor inner hits definition and top hits aggregations to this index. - max_
ngram_ floatdiff - The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
- max_
refresh_ floatlisteners - Maximum number of refresh listeners available on each shard of the index.
- max_
regex_ floatlength - The maximum length of regex that can be used in Regexp Query.
- max_
rescore_ floatwindow - The maximum value of
window_sizeforrescorerequests in searches of this index. - max_
result_ floatwindow - The maximum value of
from + sizefor searches to this index. - max_
script_ floatfields - The maximum number of
script_fieldsthat are allowed in a query. - max_
shingle_ floatdiff - The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
- max_
terms_ floatcount - The maximum number of terms that can be used in Terms Query.
- number_
of_ floatreplicas - Number of shard replicas.
- query_
default_ Sequence[str]fields - 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
-1to disable refresh. - routing_
allocation_ strenable - Controls shard allocation for this index. It can be set to:
all,primaries,new_primaries,none. - routing_
rebalance_ strenable - Enables shard rebalancing for this index. It can be set to:
all,primaries,replicas,none. - search_
idle_ strafter - How long a shard can not receive a search or get request until it’s considered search idle.
- search_
slowlog_ strlevel - Set which logging level to use for the search slow log, can be:
warn,info,debug,trace - search_
slowlog_ strthreshold_ fetch_ debug - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
2s - search_
slowlog_ strthreshold_ fetch_ info - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
5s - search_
slowlog_ strthreshold_ fetch_ trace - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
500ms - search_
slowlog_ strthreshold_ fetch_ warn - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
10s - search_
slowlog_ strthreshold_ query_ debug - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
2s - search_
slowlog_ strthreshold_ query_ info - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
5s - search_
slowlog_ strthreshold_ query_ trace - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
500ms - search_
slowlog_ strthreshold_ query_ warn - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
10s - settings_
json str - Flat JSON object of dynamic index settings not covered by the typed attributes (e.g.
{"max_result_window": 20000}). Use flat dotted setting keys; values are scalars or arrays of scalars (including empty arrays). Creation-time-only (static) settings, nested objects, explicitnullvalues and object or null array elements are rejected. To reset a setting, omit it. Keys set here must not also be set via a typed attribute. - timeouts
Elasticsearch
Index Settings Timeouts Args - unassigned_
node_ strleft_ delayed_ timeout - Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g.
10s
- index String
- Name of the target Elasticsearch index; changing it forces replacement. The name is treated as an already-resolved concrete index (no date-math resolution).
- analyze
Max NumberToken Count - The maximum number of tokens that can be produced using _analyze API.
- auto
Expand StringReplicas - 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 Boolean - Set to
trueto disable index metadata reads and writes. - blocks
Read Boolean - Set to
trueto disable read operations against the index. - blocks
Read BooleanOnly - Set to
trueto make the index and index metadata read only,falseto allow writes and metadata changes. - blocks
Read BooleanOnly Allow Delete - Identical to
index.blocks.read_onlybut allows deleting the index to free up resources. - blocks
Write Boolean - Set to
trueto disable data write operations against the index. This setting does not affect metadata. - default
Pipeline 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.
- elasticsearch
Connections List<Property Map> - Elasticsearch connection configuration block.
- final
Pipeline 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
_noneindicates no ingest pipeline will run. - gc
Deletes String - The length of time that a deleted document's version number remains available for further versioned operations.
- highlight
Max NumberAnalyzed Offset - The maximum number of characters that will be analyzed for a highlight request.
- indexing
Slowlog StringLevel - Set which logging level to use for the search slow log, can be:
warn,info,debug,trace - indexing
Slowlog StringSource - Set the number of characters of the
_sourceto include in the slowlog lines.falseor0skips logging the source entirely;truelogs the entire source regardless of size. The original_sourceis reformatted by default to make sure that it fits on a single log line. - indexing
Slowlog StringThreshold Index Debug - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
2s - indexing
Slowlog StringThreshold Index Info - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
5s - indexing
Slowlog StringThreshold Index Trace - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
500ms - indexing
Slowlog StringThreshold Index Warn - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
10s - mapping
Total NumberFields Limit - The maximum number of fields in an index. Field type parameters count towards this limit. The default value is 1000.
- max
Docvalue NumberFields Search - The maximum number of
docvalue_fieldsthat are allowed in a query. - max
Inner NumberResult Window - The maximum value of
from + sizefor inner hits definition and top hits aggregations to this index. - max
Ngram NumberDiff - The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
- max
Refresh NumberListeners - Maximum number of refresh listeners available on each shard of the index.
- max
Regex NumberLength - The maximum length of regex that can be used in Regexp Query.
- max
Rescore NumberWindow - The maximum value of
window_sizeforrescorerequests in searches of this index. - max
Result NumberWindow - The maximum value of
from + sizefor searches to this index. - max
Script NumberFields - The maximum number of
script_fieldsthat are allowed in a query. - max
Shingle NumberDiff - The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
- max
Terms NumberCount - The maximum number of terms that can be used in Terms Query.
- number
Of NumberReplicas - Number of shard replicas.
- query
Default List<String>Fields - Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
- refresh
Interval String - How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to
-1to disable refresh. - routing
Allocation StringEnable - Controls shard allocation for this index. It can be set to:
all,primaries,new_primaries,none. - routing
Rebalance StringEnable - Enables shard rebalancing for this index. It can be set to:
all,primaries,replicas,none. - search
Idle StringAfter - How long a shard can not receive a search or get request until it’s considered search idle.
- search
Slowlog StringLevel - Set which logging level to use for the search slow log, can be:
warn,info,debug,trace - search
Slowlog StringThreshold Fetch Debug - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
2s - search
Slowlog StringThreshold Fetch Info - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
5s - search
Slowlog StringThreshold Fetch Trace - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
500ms - search
Slowlog StringThreshold Fetch Warn - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
10s - search
Slowlog StringThreshold Query Debug - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
2s - search
Slowlog StringThreshold Query Info - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
5s - search
Slowlog StringThreshold Query Trace - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
500ms - search
Slowlog StringThreshold Query Warn - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
10s - settings
Json String - Flat JSON object of dynamic index settings not covered by the typed attributes (e.g.
{"max_result_window": 20000}). Use flat dotted setting keys; values are scalars or arrays of scalars (including empty arrays). Creation-time-only (static) settings, nested objects, explicitnullvalues and object or null array elements are rejected. To reset a setting, omit it. Keys set here must not also be set via a typed attribute. - timeouts Property Map
- unassigned
Node StringLeft Delayed Timeout - Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g.
10s
Outputs
All input properties are implicitly available as output properties. Additionally, the ElasticsearchIndexSettings 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 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 ElasticsearchIndexSettings Resource
Get an existing ElasticsearchIndexSettings 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?: ElasticsearchIndexSettingsState, opts?: CustomResourceOptions): ElasticsearchIndexSettings@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
analyze_max_token_count: Optional[float] = None,
auto_expand_replicas: Optional[str] = None,
blocks_metadata: Optional[bool] = None,
blocks_read: Optional[bool] = None,
blocks_read_only: Optional[bool] = None,
blocks_read_only_allow_delete: Optional[bool] = None,
blocks_write: Optional[bool] = None,
default_pipeline: Optional[str] = None,
elasticsearch_connections: Optional[Sequence[ElasticsearchIndexSettingsElasticsearchConnectionArgs]] = None,
final_pipeline: Optional[str] = None,
gc_deletes: Optional[str] = None,
highlight_max_analyzed_offset: Optional[float] = None,
index: 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,
mapping_total_fields_limit: Optional[float] = None,
max_docvalue_fields_search: Optional[float] = None,
max_inner_result_window: Optional[float] = None,
max_ngram_diff: Optional[float] = None,
max_refresh_listeners: Optional[float] = None,
max_regex_length: Optional[float] = None,
max_rescore_window: Optional[float] = None,
max_result_window: Optional[float] = None,
max_script_fields: Optional[float] = None,
max_shingle_diff: Optional[float] = None,
max_terms_count: Optional[float] = None,
number_of_replicas: Optional[float] = None,
query_default_fields: Optional[Sequence[str]] = None,
refresh_interval: Optional[str] = None,
routing_allocation_enable: 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,
settings_json: Optional[str] = None,
timeouts: Optional[ElasticsearchIndexSettingsTimeoutsArgs] = None,
unassigned_node_left_delayed_timeout: Optional[str] = None) -> ElasticsearchIndexSettingsfunc GetElasticsearchIndexSettings(ctx *Context, name string, id IDInput, state *ElasticsearchIndexSettingsState, opts ...ResourceOption) (*ElasticsearchIndexSettings, error)public static ElasticsearchIndexSettings Get(string name, Input<string> id, ElasticsearchIndexSettingsState? state, CustomResourceOptions? opts = null)public static ElasticsearchIndexSettings get(String name, Output<String> id, ElasticsearchIndexSettingsState state, CustomResourceOptions options)resources: existingElasticsearchIndexSettings: type: elasticstack:ElasticsearchIndexSettings get: id: ${id}import {
to = elasticstack_elasticsearch_index_settings.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- state ElasticsearchIndexSettingsState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state ElasticsearchIndexSettingsState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- state ElasticsearchIndexSettingsState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- state ElasticsearchIndexSettingsState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
- Analyze
Max doubleToken Count - The maximum number of tokens that can be produced using _analyze API.
- Auto
Expand stringReplicas - 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
trueto disable index metadata reads and writes. - Blocks
Read bool - Set to
trueto disable read operations against the index. - Blocks
Read boolOnly - Set to
trueto make the index and index metadata read only,falseto allow writes and metadata changes. - Blocks
Read boolOnly Allow Delete - Identical to
index.blocks.read_onlybut allows deleting the index to free up resources. - Blocks
Write bool - Set to
trueto disable data write operations against the index. This setting does not affect metadata. - Default
Pipeline 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.
- Elasticsearch
Connections List<ElasticsearchIndex Settings Elasticsearch Connection> - Elasticsearch connection configuration block.
- Final
Pipeline 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
_noneindicates no ingest pipeline will run. - Gc
Deletes string - The length of time that a deleted document's version number remains available for further versioned operations.
- Highlight
Max doubleAnalyzed Offset - The maximum number of characters that will be analyzed for a highlight request.
- Index string
- Name of the target Elasticsearch index; changing it forces replacement. The name is treated as an already-resolved concrete index (no date-math resolution).
- Indexing
Slowlog stringLevel - Set which logging level to use for the search slow log, can be:
warn,info,debug,trace - Indexing
Slowlog stringSource - Set the number of characters of the
_sourceto include in the slowlog lines.falseor0skips logging the source entirely;truelogs the entire source regardless of size. The original_sourceis reformatted by default to make sure that it fits on a single log line. - Indexing
Slowlog stringThreshold Index Debug - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
2s - Indexing
Slowlog stringThreshold Index Info - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
5s - Indexing
Slowlog stringThreshold Index Trace - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
500ms - Indexing
Slowlog stringThreshold Index Warn - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
10s - Mapping
Total doubleFields Limit - The maximum number of fields in an index. Field type parameters count towards this limit. The default value is 1000.
- Max
Docvalue doubleFields Search - The maximum number of
docvalue_fieldsthat are allowed in a query. - Max
Inner doubleResult Window - The maximum value of
from + sizefor inner hits definition and top hits aggregations to this index. - Max
Ngram doubleDiff - The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
- Max
Refresh doubleListeners - Maximum number of refresh listeners available on each shard of the index.
- Max
Regex doubleLength - The maximum length of regex that can be used in Regexp Query.
- Max
Rescore doubleWindow - The maximum value of
window_sizeforrescorerequests in searches of this index. - Max
Result doubleWindow - The maximum value of
from + sizefor searches to this index. - Max
Script doubleFields - The maximum number of
script_fieldsthat are allowed in a query. - Max
Shingle doubleDiff - The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
- Max
Terms doubleCount - The maximum number of terms that can be used in Terms Query.
- Number
Of doubleReplicas - Number of shard replicas.
- Query
Default List<string>Fields - Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
- Refresh
Interval string - How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to
-1to disable refresh. - Routing
Allocation stringEnable - Controls shard allocation for this index. It can be set to:
all,primaries,new_primaries,none. - Routing
Rebalance stringEnable - Enables shard rebalancing for this index. It can be set to:
all,primaries,replicas,none. - Search
Idle stringAfter - How long a shard can not receive a search or get request until it’s considered search idle.
- Search
Slowlog stringLevel - Set which logging level to use for the search slow log, can be:
warn,info,debug,trace - Search
Slowlog stringThreshold Fetch Debug - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
2s - Search
Slowlog stringThreshold Fetch Info - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
5s - Search
Slowlog stringThreshold Fetch Trace - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
500ms - Search
Slowlog stringThreshold Fetch Warn - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
10s - Search
Slowlog stringThreshold Query Debug - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
2s - Search
Slowlog stringThreshold Query Info - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
5s - Search
Slowlog stringThreshold Query Trace - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
500ms - Search
Slowlog stringThreshold Query Warn - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
10s - Settings
Json string - Flat JSON object of dynamic index settings not covered by the typed attributes (e.g.
{"max_result_window": 20000}). Use flat dotted setting keys; values are scalars or arrays of scalars (including empty arrays). Creation-time-only (static) settings, nested objects, explicitnullvalues and object or null array elements are rejected. To reset a setting, omit it. Keys set here must not also be set via a typed attribute. - Timeouts
Elasticsearch
Index Settings Timeouts - Unassigned
Node stringLeft Delayed Timeout - Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g.
10s
- Analyze
Max float64Token Count - The maximum number of tokens that can be produced using _analyze API.
- Auto
Expand stringReplicas - 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
trueto disable index metadata reads and writes. - Blocks
Read bool - Set to
trueto disable read operations against the index. - Blocks
Read boolOnly - Set to
trueto make the index and index metadata read only,falseto allow writes and metadata changes. - Blocks
Read boolOnly Allow Delete - Identical to
index.blocks.read_onlybut allows deleting the index to free up resources. - Blocks
Write bool - Set to
trueto disable data write operations against the index. This setting does not affect metadata. - Default
Pipeline 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.
- Elasticsearch
Connections []ElasticsearchIndex Settings Elasticsearch Connection Args - Elasticsearch connection configuration block.
- Final
Pipeline 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
_noneindicates no ingest pipeline will run. - Gc
Deletes string - The length of time that a deleted document's version number remains available for further versioned operations.
- Highlight
Max float64Analyzed Offset - The maximum number of characters that will be analyzed for a highlight request.
- Index string
- Name of the target Elasticsearch index; changing it forces replacement. The name is treated as an already-resolved concrete index (no date-math resolution).
- Indexing
Slowlog stringLevel - Set which logging level to use for the search slow log, can be:
warn,info,debug,trace - Indexing
Slowlog stringSource - Set the number of characters of the
_sourceto include in the slowlog lines.falseor0skips logging the source entirely;truelogs the entire source regardless of size. The original_sourceis reformatted by default to make sure that it fits on a single log line. - Indexing
Slowlog stringThreshold Index Debug - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
2s - Indexing
Slowlog stringThreshold Index Info - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
5s - Indexing
Slowlog stringThreshold Index Trace - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
500ms - Indexing
Slowlog stringThreshold Index Warn - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
10s - Mapping
Total float64Fields Limit - The maximum number of fields in an index. Field type parameters count towards this limit. The default value is 1000.
- Max
Docvalue float64Fields Search - The maximum number of
docvalue_fieldsthat are allowed in a query. - Max
Inner float64Result Window - The maximum value of
from + sizefor inner hits definition and top hits aggregations to this index. - Max
Ngram float64Diff - The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
- Max
Refresh float64Listeners - Maximum number of refresh listeners available on each shard of the index.
- Max
Regex float64Length - The maximum length of regex that can be used in Regexp Query.
- Max
Rescore float64Window - The maximum value of
window_sizeforrescorerequests in searches of this index. - Max
Result float64Window - The maximum value of
from + sizefor searches to this index. - Max
Script float64Fields - The maximum number of
script_fieldsthat are allowed in a query. - Max
Shingle float64Diff - The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
- Max
Terms float64Count - The maximum number of terms that can be used in Terms Query.
- Number
Of float64Replicas - Number of shard replicas.
- Query
Default []stringFields - Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
- Refresh
Interval string - How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to
-1to disable refresh. - Routing
Allocation stringEnable - Controls shard allocation for this index. It can be set to:
all,primaries,new_primaries,none. - Routing
Rebalance stringEnable - Enables shard rebalancing for this index. It can be set to:
all,primaries,replicas,none. - Search
Idle stringAfter - How long a shard can not receive a search or get request until it’s considered search idle.
- Search
Slowlog stringLevel - Set which logging level to use for the search slow log, can be:
warn,info,debug,trace - Search
Slowlog stringThreshold Fetch Debug - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
2s - Search
Slowlog stringThreshold Fetch Info - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
5s - Search
Slowlog stringThreshold Fetch Trace - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
500ms - Search
Slowlog stringThreshold Fetch Warn - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
10s - Search
Slowlog stringThreshold Query Debug - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
2s - Search
Slowlog stringThreshold Query Info - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
5s - Search
Slowlog stringThreshold Query Trace - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
500ms - Search
Slowlog stringThreshold Query Warn - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
10s - Settings
Json string - Flat JSON object of dynamic index settings not covered by the typed attributes (e.g.
{"max_result_window": 20000}). Use flat dotted setting keys; values are scalars or arrays of scalars (including empty arrays). Creation-time-only (static) settings, nested objects, explicitnullvalues and object or null array elements are rejected. To reset a setting, omit it. Keys set here must not also be set via a typed attribute. - Timeouts
Elasticsearch
Index Settings Timeouts Args - Unassigned
Node stringLeft Delayed Timeout - Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g.
10s
- analyze_
max_ numbertoken_ count - The maximum number of tokens that can be produced using _analyze API.
- auto_
expand_ stringreplicas - 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
trueto disable index metadata reads and writes. - blocks_
read bool - Set to
trueto disable read operations against the index. - blocks_
read_ boolonly - Set to
trueto make the index and index metadata read only,falseto allow writes and metadata changes. - blocks_
read_ boolonly_ allow_ delete - Identical to
index.blocks.read_onlybut allows deleting the index to free up resources. - blocks_
write bool - Set to
trueto disable data write operations against the index. This setting does not affect metadata. - default_
pipeline 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.
- elasticsearch_
connections list(object) - Elasticsearch connection configuration block.
- final_
pipeline 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
_noneindicates no ingest pipeline will run. - gc_
deletes string - The length of time that a deleted document's version number remains available for further versioned operations.
- highlight_
max_ numberanalyzed_ offset - The maximum number of characters that will be analyzed for a highlight request.
- index string
- Name of the target Elasticsearch index; changing it forces replacement. The name is treated as an already-resolved concrete index (no date-math resolution).
- indexing_
slowlog_ stringlevel - Set which logging level to use for the search slow log, can be:
warn,info,debug,trace - indexing_
slowlog_ stringsource - Set the number of characters of the
_sourceto include in the slowlog lines.falseor0skips logging the source entirely;truelogs the entire source regardless of size. The original_sourceis reformatted by default to make sure that it fits on a single log line. - indexing_
slowlog_ stringthreshold_ index_ debug - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
2s - indexing_
slowlog_ stringthreshold_ index_ info - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
5s - indexing_
slowlog_ stringthreshold_ index_ trace - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
500ms - indexing_
slowlog_ stringthreshold_ index_ warn - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
10s - mapping_
total_ numberfields_ limit - The maximum number of fields in an index. Field type parameters count towards this limit. The default value is 1000.
- max_
docvalue_ numberfields_ search - The maximum number of
docvalue_fieldsthat are allowed in a query. - max_
inner_ numberresult_ window - The maximum value of
from + sizefor inner hits definition and top hits aggregations to this index. - max_
ngram_ numberdiff - The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
- max_
refresh_ numberlisteners - Maximum number of refresh listeners available on each shard of the index.
- max_
regex_ numberlength - The maximum length of regex that can be used in Regexp Query.
- max_
rescore_ numberwindow - The maximum value of
window_sizeforrescorerequests in searches of this index. - max_
result_ numberwindow - The maximum value of
from + sizefor searches to this index. - max_
script_ numberfields - The maximum number of
script_fieldsthat are allowed in a query. - max_
shingle_ numberdiff - The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
- max_
terms_ numbercount - The maximum number of terms that can be used in Terms Query.
- number_
of_ numberreplicas - Number of shard replicas.
- query_
default_ list(string)fields - Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
- refresh_
interval string - How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to
-1to disable refresh. - routing_
allocation_ stringenable - Controls shard allocation for this index. It can be set to:
all,primaries,new_primaries,none. - routing_
rebalance_ stringenable - Enables shard rebalancing for this index. It can be set to:
all,primaries,replicas,none. - search_
idle_ stringafter - How long a shard can not receive a search or get request until it’s considered search idle.
- search_
slowlog_ stringlevel - Set which logging level to use for the search slow log, can be:
warn,info,debug,trace - search_
slowlog_ stringthreshold_ fetch_ debug - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
2s - search_
slowlog_ stringthreshold_ fetch_ info - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
5s - search_
slowlog_ stringthreshold_ fetch_ trace - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
500ms - search_
slowlog_ stringthreshold_ fetch_ warn - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
10s - search_
slowlog_ stringthreshold_ query_ debug - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
2s - search_
slowlog_ stringthreshold_ query_ info - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
5s - search_
slowlog_ stringthreshold_ query_ trace - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
500ms - search_
slowlog_ stringthreshold_ query_ warn - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
10s - settings_
json string - Flat JSON object of dynamic index settings not covered by the typed attributes (e.g.
{"max_result_window": 20000}). Use flat dotted setting keys; values are scalars or arrays of scalars (including empty arrays). Creation-time-only (static) settings, nested objects, explicitnullvalues and object or null array elements are rejected. To reset a setting, omit it. Keys set here must not also be set via a typed attribute. - timeouts object
- unassigned_
node_ stringleft_ delayed_ timeout - Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g.
10s
- analyze
Max DoubleToken Count - The maximum number of tokens that can be produced using _analyze API.
- auto
Expand StringReplicas - 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 Boolean - Set to
trueto disable index metadata reads and writes. - blocks
Read Boolean - Set to
trueto disable read operations against the index. - blocks
Read BooleanOnly - Set to
trueto make the index and index metadata read only,falseto allow writes and metadata changes. - blocks
Read BooleanOnly Allow Delete - Identical to
index.blocks.read_onlybut allows deleting the index to free up resources. - blocks
Write Boolean - Set to
trueto disable data write operations against the index. This setting does not affect metadata. - default
Pipeline 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.
- elasticsearch
Connections List<ElasticsearchIndex Settings Elasticsearch Connection> - Elasticsearch connection configuration block.
- final
Pipeline 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
_noneindicates no ingest pipeline will run. - gc
Deletes String - The length of time that a deleted document's version number remains available for further versioned operations.
- highlight
Max DoubleAnalyzed Offset - The maximum number of characters that will be analyzed for a highlight request.
- index String
- Name of the target Elasticsearch index; changing it forces replacement. The name is treated as an already-resolved concrete index (no date-math resolution).
- indexing
Slowlog StringLevel - Set which logging level to use for the search slow log, can be:
warn,info,debug,trace - indexing
Slowlog StringSource - Set the number of characters of the
_sourceto include in the slowlog lines.falseor0skips logging the source entirely;truelogs the entire source regardless of size. The original_sourceis reformatted by default to make sure that it fits on a single log line. - indexing
Slowlog StringThreshold Index Debug - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
2s - indexing
Slowlog StringThreshold Index Info - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
5s - indexing
Slowlog StringThreshold Index Trace - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
500ms - indexing
Slowlog StringThreshold Index Warn - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
10s - mapping
Total DoubleFields Limit - The maximum number of fields in an index. Field type parameters count towards this limit. The default value is 1000.
- max
Docvalue DoubleFields Search - The maximum number of
docvalue_fieldsthat are allowed in a query. - max
Inner DoubleResult Window - The maximum value of
from + sizefor inner hits definition and top hits aggregations to this index. - max
Ngram DoubleDiff - The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
- max
Refresh DoubleListeners - Maximum number of refresh listeners available on each shard of the index.
- max
Regex DoubleLength - The maximum length of regex that can be used in Regexp Query.
- max
Rescore DoubleWindow - The maximum value of
window_sizeforrescorerequests in searches of this index. - max
Result DoubleWindow - The maximum value of
from + sizefor searches to this index. - max
Script DoubleFields - The maximum number of
script_fieldsthat are allowed in a query. - max
Shingle DoubleDiff - The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
- max
Terms DoubleCount - The maximum number of terms that can be used in Terms Query.
- number
Of DoubleReplicas - Number of shard replicas.
- query
Default List<String>Fields - Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
- refresh
Interval String - How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to
-1to disable refresh. - routing
Allocation StringEnable - Controls shard allocation for this index. It can be set to:
all,primaries,new_primaries,none. - routing
Rebalance StringEnable - Enables shard rebalancing for this index. It can be set to:
all,primaries,replicas,none. - search
Idle StringAfter - How long a shard can not receive a search or get request until it’s considered search idle.
- search
Slowlog StringLevel - Set which logging level to use for the search slow log, can be:
warn,info,debug,trace - search
Slowlog StringThreshold Fetch Debug - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
2s - search
Slowlog StringThreshold Fetch Info - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
5s - search
Slowlog StringThreshold Fetch Trace - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
500ms - search
Slowlog StringThreshold Fetch Warn - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
10s - search
Slowlog StringThreshold Query Debug - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
2s - search
Slowlog StringThreshold Query Info - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
5s - search
Slowlog StringThreshold Query Trace - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
500ms - search
Slowlog StringThreshold Query Warn - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
10s - settings
Json String - Flat JSON object of dynamic index settings not covered by the typed attributes (e.g.
{"max_result_window": 20000}). Use flat dotted setting keys; values are scalars or arrays of scalars (including empty arrays). Creation-time-only (static) settings, nested objects, explicitnullvalues and object or null array elements are rejected. To reset a setting, omit it. Keys set here must not also be set via a typed attribute. - timeouts
Elasticsearch
Index Settings Timeouts - unassigned
Node StringLeft Delayed Timeout - Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g.
10s
- analyze
Max numberToken Count - The maximum number of tokens that can be produced using _analyze API.
- auto
Expand stringReplicas - 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 boolean - Set to
trueto disable index metadata reads and writes. - blocks
Read boolean - Set to
trueto disable read operations against the index. - blocks
Read booleanOnly - Set to
trueto make the index and index metadata read only,falseto allow writes and metadata changes. - blocks
Read booleanOnly Allow Delete - Identical to
index.blocks.read_onlybut allows deleting the index to free up resources. - blocks
Write boolean - Set to
trueto disable data write operations against the index. This setting does not affect metadata. - default
Pipeline 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.
- elasticsearch
Connections ElasticsearchIndex Settings Elasticsearch Connection[] - Elasticsearch connection configuration block.
- final
Pipeline 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
_noneindicates no ingest pipeline will run. - gc
Deletes string - The length of time that a deleted document's version number remains available for further versioned operations.
- highlight
Max numberAnalyzed Offset - The maximum number of characters that will be analyzed for a highlight request.
- index string
- Name of the target Elasticsearch index; changing it forces replacement. The name is treated as an already-resolved concrete index (no date-math resolution).
- indexing
Slowlog stringLevel - Set which logging level to use for the search slow log, can be:
warn,info,debug,trace - indexing
Slowlog stringSource - Set the number of characters of the
_sourceto include in the slowlog lines.falseor0skips logging the source entirely;truelogs the entire source regardless of size. The original_sourceis reformatted by default to make sure that it fits on a single log line. - indexing
Slowlog stringThreshold Index Debug - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
2s - indexing
Slowlog stringThreshold Index Info - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
5s - indexing
Slowlog stringThreshold Index Trace - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
500ms - indexing
Slowlog stringThreshold Index Warn - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
10s - mapping
Total numberFields Limit - The maximum number of fields in an index. Field type parameters count towards this limit. The default value is 1000.
- max
Docvalue numberFields Search - The maximum number of
docvalue_fieldsthat are allowed in a query. - max
Inner numberResult Window - The maximum value of
from + sizefor inner hits definition and top hits aggregations to this index. - max
Ngram numberDiff - The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
- max
Refresh numberListeners - Maximum number of refresh listeners available on each shard of the index.
- max
Regex numberLength - The maximum length of regex that can be used in Regexp Query.
- max
Rescore numberWindow - The maximum value of
window_sizeforrescorerequests in searches of this index. - max
Result numberWindow - The maximum value of
from + sizefor searches to this index. - max
Script numberFields - The maximum number of
script_fieldsthat are allowed in a query. - max
Shingle numberDiff - The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
- max
Terms numberCount - The maximum number of terms that can be used in Terms Query.
- number
Of numberReplicas - Number of shard replicas.
- query
Default string[]Fields - Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
- refresh
Interval string - How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to
-1to disable refresh. - routing
Allocation stringEnable - Controls shard allocation for this index. It can be set to:
all,primaries,new_primaries,none. - routing
Rebalance stringEnable - Enables shard rebalancing for this index. It can be set to:
all,primaries,replicas,none. - search
Idle stringAfter - How long a shard can not receive a search or get request until it’s considered search idle.
- search
Slowlog stringLevel - Set which logging level to use for the search slow log, can be:
warn,info,debug,trace - search
Slowlog stringThreshold Fetch Debug - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
2s - search
Slowlog stringThreshold Fetch Info - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
5s - search
Slowlog stringThreshold Fetch Trace - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
500ms - search
Slowlog stringThreshold Fetch Warn - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
10s - search
Slowlog stringThreshold Query Debug - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
2s - search
Slowlog stringThreshold Query Info - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
5s - search
Slowlog stringThreshold Query Trace - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
500ms - search
Slowlog stringThreshold Query Warn - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
10s - settings
Json string - Flat JSON object of dynamic index settings not covered by the typed attributes (e.g.
{"max_result_window": 20000}). Use flat dotted setting keys; values are scalars or arrays of scalars (including empty arrays). Creation-time-only (static) settings, nested objects, explicitnullvalues and object or null array elements are rejected. To reset a setting, omit it. Keys set here must not also be set via a typed attribute. - timeouts
Elasticsearch
Index Settings Timeouts - unassigned
Node stringLeft Delayed Timeout - Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g.
10s
- analyze_
max_ floattoken_ count - The maximum number of tokens that can be produced using _analyze API.
- auto_
expand_ strreplicas - 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
trueto disable index metadata reads and writes. - blocks_
read bool - Set to
trueto disable read operations against the index. - blocks_
read_ boolonly - Set to
trueto make the index and index metadata read only,falseto allow writes and metadata changes. - blocks_
read_ boolonly_ allow_ delete - Identical to
index.blocks.read_onlybut allows deleting the index to free up resources. - blocks_
write bool - Set to
trueto disable data write operations against the index. This setting does not affect metadata. - 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.
- elasticsearch_
connections Sequence[ElasticsearchIndex Settings Elasticsearch Connection Args] - Elasticsearch connection configuration block.
- 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
_noneindicates 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_ floatanalyzed_ offset - The maximum number of characters that will be analyzed for a highlight request.
- index str
- Name of the target Elasticsearch index; changing it forces replacement. The name is treated as an already-resolved concrete index (no date-math resolution).
- indexing_
slowlog_ strlevel - Set which logging level to use for the search slow log, can be:
warn,info,debug,trace - indexing_
slowlog_ strsource - Set the number of characters of the
_sourceto include in the slowlog lines.falseor0skips logging the source entirely;truelogs the entire source regardless of size. The original_sourceis reformatted by default to make sure that it fits on a single log line. - indexing_
slowlog_ strthreshold_ index_ debug - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
2s - indexing_
slowlog_ strthreshold_ index_ info - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
5s - indexing_
slowlog_ strthreshold_ index_ trace - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
500ms - indexing_
slowlog_ strthreshold_ index_ warn - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
10s - mapping_
total_ floatfields_ limit - The maximum number of fields in an index. Field type parameters count towards this limit. The default value is 1000.
- max_
docvalue_ floatfields_ search - The maximum number of
docvalue_fieldsthat are allowed in a query. - max_
inner_ floatresult_ window - The maximum value of
from + sizefor inner hits definition and top hits aggregations to this index. - max_
ngram_ floatdiff - The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
- max_
refresh_ floatlisteners - Maximum number of refresh listeners available on each shard of the index.
- max_
regex_ floatlength - The maximum length of regex that can be used in Regexp Query.
- max_
rescore_ floatwindow - The maximum value of
window_sizeforrescorerequests in searches of this index. - max_
result_ floatwindow - The maximum value of
from + sizefor searches to this index. - max_
script_ floatfields - The maximum number of
script_fieldsthat are allowed in a query. - max_
shingle_ floatdiff - The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
- max_
terms_ floatcount - The maximum number of terms that can be used in Terms Query.
- number_
of_ floatreplicas - Number of shard replicas.
- query_
default_ Sequence[str]fields - 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
-1to disable refresh. - routing_
allocation_ strenable - Controls shard allocation for this index. It can be set to:
all,primaries,new_primaries,none. - routing_
rebalance_ strenable - Enables shard rebalancing for this index. It can be set to:
all,primaries,replicas,none. - search_
idle_ strafter - How long a shard can not receive a search or get request until it’s considered search idle.
- search_
slowlog_ strlevel - Set which logging level to use for the search slow log, can be:
warn,info,debug,trace - search_
slowlog_ strthreshold_ fetch_ debug - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
2s - search_
slowlog_ strthreshold_ fetch_ info - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
5s - search_
slowlog_ strthreshold_ fetch_ trace - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
500ms - search_
slowlog_ strthreshold_ fetch_ warn - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
10s - search_
slowlog_ strthreshold_ query_ debug - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
2s - search_
slowlog_ strthreshold_ query_ info - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
5s - search_
slowlog_ strthreshold_ query_ trace - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
500ms - search_
slowlog_ strthreshold_ query_ warn - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
10s - settings_
json str - Flat JSON object of dynamic index settings not covered by the typed attributes (e.g.
{"max_result_window": 20000}). Use flat dotted setting keys; values are scalars or arrays of scalars (including empty arrays). Creation-time-only (static) settings, nested objects, explicitnullvalues and object or null array elements are rejected. To reset a setting, omit it. Keys set here must not also be set via a typed attribute. - timeouts
Elasticsearch
Index Settings Timeouts Args - unassigned_
node_ strleft_ delayed_ timeout - Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g.
10s
- analyze
Max NumberToken Count - The maximum number of tokens that can be produced using _analyze API.
- auto
Expand StringReplicas - 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 Boolean - Set to
trueto disable index metadata reads and writes. - blocks
Read Boolean - Set to
trueto disable read operations against the index. - blocks
Read BooleanOnly - Set to
trueto make the index and index metadata read only,falseto allow writes and metadata changes. - blocks
Read BooleanOnly Allow Delete - Identical to
index.blocks.read_onlybut allows deleting the index to free up resources. - blocks
Write Boolean - Set to
trueto disable data write operations against the index. This setting does not affect metadata. - default
Pipeline 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.
- elasticsearch
Connections List<Property Map> - Elasticsearch connection configuration block.
- final
Pipeline 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
_noneindicates no ingest pipeline will run. - gc
Deletes String - The length of time that a deleted document's version number remains available for further versioned operations.
- highlight
Max NumberAnalyzed Offset - The maximum number of characters that will be analyzed for a highlight request.
- index String
- Name of the target Elasticsearch index; changing it forces replacement. The name is treated as an already-resolved concrete index (no date-math resolution).
- indexing
Slowlog StringLevel - Set which logging level to use for the search slow log, can be:
warn,info,debug,trace - indexing
Slowlog StringSource - Set the number of characters of the
_sourceto include in the slowlog lines.falseor0skips logging the source entirely;truelogs the entire source regardless of size. The original_sourceis reformatted by default to make sure that it fits on a single log line. - indexing
Slowlog StringThreshold Index Debug - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
2s - indexing
Slowlog StringThreshold Index Info - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
5s - indexing
Slowlog StringThreshold Index Trace - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
500ms - indexing
Slowlog StringThreshold Index Warn - Set the cutoff for shard level slow search logging of slow searches for indexing queries, in time units, e.g.
10s - mapping
Total NumberFields Limit - The maximum number of fields in an index. Field type parameters count towards this limit. The default value is 1000.
- max
Docvalue NumberFields Search - The maximum number of
docvalue_fieldsthat are allowed in a query. - max
Inner NumberResult Window - The maximum value of
from + sizefor inner hits definition and top hits aggregations to this index. - max
Ngram NumberDiff - The maximum allowed difference between mingram and maxgram for NGramTokenizer and NGramTokenFilter.
- max
Refresh NumberListeners - Maximum number of refresh listeners available on each shard of the index.
- max
Regex NumberLength - The maximum length of regex that can be used in Regexp Query.
- max
Rescore NumberWindow - The maximum value of
window_sizeforrescorerequests in searches of this index. - max
Result NumberWindow - The maximum value of
from + sizefor searches to this index. - max
Script NumberFields - The maximum number of
script_fieldsthat are allowed in a query. - max
Shingle NumberDiff - The maximum allowed difference between maxshinglesize and minshinglesize for ShingleTokenFilter.
- max
Terms NumberCount - The maximum number of terms that can be used in Terms Query.
- number
Of NumberReplicas - Number of shard replicas.
- query
Default List<String>Fields - Wildcard () patterns matching one or more fields. Defaults to '', which matches all fields eligible for term-level queries, excluding metadata fields.
- refresh
Interval String - How often to perform a refresh operation, which makes recent changes to the index visible to search. Can be set to
-1to disable refresh. - routing
Allocation StringEnable - Controls shard allocation for this index. It can be set to:
all,primaries,new_primaries,none. - routing
Rebalance StringEnable - Enables shard rebalancing for this index. It can be set to:
all,primaries,replicas,none. - search
Idle StringAfter - How long a shard can not receive a search or get request until it’s considered search idle.
- search
Slowlog StringLevel - Set which logging level to use for the search slow log, can be:
warn,info,debug,trace - search
Slowlog StringThreshold Fetch Debug - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
2s - search
Slowlog StringThreshold Fetch Info - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
5s - search
Slowlog StringThreshold Fetch Trace - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
500ms - search
Slowlog StringThreshold Fetch Warn - Set the cutoff for shard level slow search logging of slow searches in the fetch phase, in time units, e.g.
10s - search
Slowlog StringThreshold Query Debug - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
2s - search
Slowlog StringThreshold Query Info - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
5s - search
Slowlog StringThreshold Query Trace - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
500ms - search
Slowlog StringThreshold Query Warn - Set the cutoff for shard level slow search logging of slow searches in the query phase, in time units, e.g.
10s - settings
Json String - Flat JSON object of dynamic index settings not covered by the typed attributes (e.g.
{"max_result_window": 20000}). Use flat dotted setting keys; values are scalars or arrays of scalars (including empty arrays). Creation-time-only (static) settings, nested objects, explicitnullvalues and object or null array elements are rejected. To reset a setting, omit it. Keys set here must not also be set via a typed attribute. - timeouts Property Map
- unassigned
Node StringLeft Delayed Timeout - Time to delay the allocation of replica shards which become unassigned because a node has left, in time units, e.g.
10s
Supporting Types
ElasticsearchIndexSettingsElasticsearchConnection, ElasticsearchIndexSettingsElasticsearchConnectionArgs
- Api
Key string - API Key to use for authentication to Elasticsearch
- Bearer
Token string - Bearer Token to use for authentication to Elasticsearch
- Ca
Data string - PEM-encoded custom Certificate Authority certificate
- Ca
File string - Path to a custom Certificate Authority certificate
- Ca
Fingerprint string - SHA-256 hex fingerprint (64 hexadecimal characters, no colons or separators) of the server TLS certificate used to pin the connection instead of a full CA chain
- Cert
Data string - PEM encoded certificate for client auth
- Cert
File string - Path to a file containing the PEM encoded certificate for client auth
- Endpoints List<string>
- Es
Client stringAuthentication - ES Client Authentication field to be used with the JWT token
- Headers Dictionary<string, string>
- A list of headers to be sent with each request to Elasticsearch.
- Insecure bool
- Disable TLS certificate validation
- Key
Data string - PEM encoded private key for client auth
- Key
File string - Path to a file containing the PEM encoded private key for client auth
- Password string
- Password to use for API authentication to Elasticsearch.
- Username string
- Username to use for API authentication to Elasticsearch.
- Api
Key string - API Key to use for authentication to Elasticsearch
- Bearer
Token string - Bearer Token to use for authentication to Elasticsearch
- Ca
Data string - PEM-encoded custom Certificate Authority certificate
- Ca
File string - Path to a custom Certificate Authority certificate
- Ca
Fingerprint string - SHA-256 hex fingerprint (64 hexadecimal characters, no colons or separators) of the server TLS certificate used to pin the connection instead of a full CA chain
- Cert
Data string - PEM encoded certificate for client auth
- Cert
File string - Path to a file containing the PEM encoded certificate for client auth
- Endpoints []string
- Es
Client stringAuthentication - ES Client Authentication field to be used with the JWT token
- Headers map[string]string
- A list of headers to be sent with each request to Elasticsearch.
- Insecure bool
- Disable TLS certificate validation
- Key
Data string - PEM encoded private key for client auth
- Key
File string - Path to a file containing the PEM encoded private key for client auth
- Password string
- Password to use for API authentication to Elasticsearch.
- Username string
- Username to use for API authentication to Elasticsearch.
- api_
key string - API Key to use for authentication to Elasticsearch
- bearer_
token string - Bearer Token to use for authentication to Elasticsearch
- ca_
data string - PEM-encoded custom Certificate Authority certificate
- ca_
file string - Path to a custom Certificate Authority certificate
- ca_
fingerprint string - SHA-256 hex fingerprint (64 hexadecimal characters, no colons or separators) of the server TLS certificate used to pin the connection instead of a full CA chain
- cert_
data string - PEM encoded certificate for client auth
- cert_
file string - Path to a file containing the PEM encoded certificate for client auth
- endpoints list(string)
- es_
client_ stringauthentication - ES Client Authentication field to be used with the JWT token
- headers map(string)
- A list of headers to be sent with each request to Elasticsearch.
- insecure bool
- Disable TLS certificate validation
- key_
data string - PEM encoded private key for client auth
- key_
file string - Path to a file containing the PEM encoded private key for client auth
- password string
- Password to use for API authentication to Elasticsearch.
- username string
- Username to use for API authentication to Elasticsearch.
- api
Key String - API Key to use for authentication to Elasticsearch
- bearer
Token String - Bearer Token to use for authentication to Elasticsearch
- ca
Data String - PEM-encoded custom Certificate Authority certificate
- ca
File String - Path to a custom Certificate Authority certificate
- ca
Fingerprint String - SHA-256 hex fingerprint (64 hexadecimal characters, no colons or separators) of the server TLS certificate used to pin the connection instead of a full CA chain
- cert
Data String - PEM encoded certificate for client auth
- cert
File String - Path to a file containing the PEM encoded certificate for client auth
- endpoints List<String>
- es
Client StringAuthentication - ES Client Authentication field to be used with the JWT token
- headers Map<String,String>
- A list of headers to be sent with each request to Elasticsearch.
- insecure Boolean
- Disable TLS certificate validation
- key
Data String - PEM encoded private key for client auth
- key
File String - Path to a file containing the PEM encoded private key for client auth
- password String
- Password to use for API authentication to Elasticsearch.
- username String
- Username to use for API authentication to Elasticsearch.
- api
Key string - API Key to use for authentication to Elasticsearch
- bearer
Token string - Bearer Token to use for authentication to Elasticsearch
- ca
Data string - PEM-encoded custom Certificate Authority certificate
- ca
File string - Path to a custom Certificate Authority certificate
- ca
Fingerprint string - SHA-256 hex fingerprint (64 hexadecimal characters, no colons or separators) of the server TLS certificate used to pin the connection instead of a full CA chain
- cert
Data string - PEM encoded certificate for client auth
- cert
File string - Path to a file containing the PEM encoded certificate for client auth
- endpoints string[]
- es
Client stringAuthentication - ES Client Authentication field to be used with the JWT token
- headers {[key: string]: string}
- A list of headers to be sent with each request to Elasticsearch.
- insecure boolean
- Disable TLS certificate validation
- key
Data string - PEM encoded private key for client auth
- key
File string - Path to a file containing the PEM encoded private key for client auth
- password string
- Password to use for API authentication to Elasticsearch.
- username string
- Username to use for API authentication to Elasticsearch.
- api_
key str - API Key to use for authentication to Elasticsearch
- bearer_
token str - Bearer Token to use for authentication to Elasticsearch
- ca_
data str - PEM-encoded custom Certificate Authority certificate
- ca_
file str - Path to a custom Certificate Authority certificate
- ca_
fingerprint str - SHA-256 hex fingerprint (64 hexadecimal characters, no colons or separators) of the server TLS certificate used to pin the connection instead of a full CA chain
- cert_
data str - PEM encoded certificate for client auth
- cert_
file str - Path to a file containing the PEM encoded certificate for client auth
- endpoints Sequence[str]
- es_
client_ strauthentication - ES Client Authentication field to be used with the JWT token
- headers Mapping[str, str]
- A list of headers to be sent with each request to Elasticsearch.
- insecure bool
- Disable TLS certificate validation
- key_
data str - PEM encoded private key for client auth
- key_
file str - Path to a file containing the PEM encoded private key for client auth
- password str
- Password to use for API authentication to Elasticsearch.
- username str
- Username to use for API authentication to Elasticsearch.
- api
Key String - API Key to use for authentication to Elasticsearch
- bearer
Token String - Bearer Token to use for authentication to Elasticsearch
- ca
Data String - PEM-encoded custom Certificate Authority certificate
- ca
File String - Path to a custom Certificate Authority certificate
- ca
Fingerprint String - SHA-256 hex fingerprint (64 hexadecimal characters, no colons or separators) of the server TLS certificate used to pin the connection instead of a full CA chain
- cert
Data String - PEM encoded certificate for client auth
- cert
File String - Path to a file containing the PEM encoded certificate for client auth
- endpoints List<String>
- es
Client StringAuthentication - ES Client Authentication field to be used with the JWT token
- headers Map<String>
- A list of headers to be sent with each request to Elasticsearch.
- insecure Boolean
- Disable TLS certificate validation
- key
Data String - PEM encoded private key for client auth
- key
File String - Path to a file containing the PEM encoded private key for client auth
- password String
- Password to use for API authentication to Elasticsearch.
- username String
- Username to use for API authentication to Elasticsearch.
ElasticsearchIndexSettingsTimeouts, ElasticsearchIndexSettingsTimeoutsArgs
- Create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- Read string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
- Update string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- Read string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
- Update string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- read string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
- update string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- read String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
- update String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- read string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
- update string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- read str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
- update str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- read String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
- update String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
Import
The pulumi import command can be used, for example:
Importing an index settings resource only hydrates the typed dynamic settings
from the index; settings declared via settings_json are not imported and
will show as additions in the next pulumi preview.
$ pulumi import elasticstack:index/elasticsearchIndexSettings:ElasticsearchIndexSettings my_index_settings 'cluster_uuid/concrete_index_name'
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- elasticstack elastic/terraform-provider-elasticstack
- License
- Notes
- This Pulumi package is based on the
elasticstackTerraform Provider.
published on Tuesday, Nov 10, 2026 by elastic