InstanceConfigurationedit
The configuration template for Elasticsearch instances, Kibana instances, and APM Servers.
Propertiesedit
-
allocator_filter(QueryContainer) - Optional filter to match allocators against
-
allowed_zones(array[string)] - The zones this instance configuration may exist in. Leaving out this parameter or specifying an empty list implies all zones are allowed. Normally not needed, but can be useful for exceptional infrastructure constraints.
-
config_version(integerasint32) - If the IC is configuration controlled, this field is the version either being read back (reads return the latest IC unless specified by the 'config_version' URL param), or the version to update. Cannot be used in creates. For unversioned IC reads it is left empty.
-
cpu_multiplier(numberasdouble) - Settings for the instance CPU multiplier
-
deleted_on(stringasdate-time) - Date/time that this instance configuration was marked for deletion
-
description(string) - Optional description for the instance configuration
-
discrete_sizes(DiscreteSizes, required) - Numerics representing possible instance sizes that the instance configuration supports.
-
id(string) - Unique identifier for the instance configuration
-
instance_type(string; allowed values: [elasticsearch,kibana,apm,integrations_server,appsearch,enterprise_search]) - The type of instance. For instance configurations where the type is specified in the 'id', the default value of 'instance_type' will be automatically inferred.
-
max_zones(integerasint32) - The maximum number of availability zones in which this instance configuration has allocators. This field will be missing unless explicitly requested with the show_max_zones parameter.
-
metadata(object) - Optional arbitrary metadata to associate with this template.
-
name(string, required) - Display name for the instance configuration.
-
node_types(array[string)] - Node types (master, data) for the instance. For instance configurations where the type (and tier) is specified in the 'id', the default value of 'node_types' will be automatically inferred.
-
storage_multiplier(numberasdouble) - Settings for the instance storage multiplier
-
system_owned(boolean) - Indicates if a instance configuration is system owned (restricts the set of operations that can be performed on it)
Exampleedit
{
"allocator_filter" : {
"bool" : {
"filter" : [
null
],
"minimum_should_match" : 0,
"must" : [
null
],
"must_not" : [
null
],
"should" : [
null
]
},
"exists" : {
"field" : "string"
},
"match" : {
"some_property" : {
"analyzer" : "string",
"minimum_should_match" : 0,
"operator" : "string",
"query" : "string"
}
},
"match_all" : {},
"match_none" : {},
"nested" : {
"path" : "string",
"query" : null,
"score_mode" : "string"
},
"prefix" : {
"some_property" : {
"boost" : 0.1,
"value" : "string"
}
},
"query_string" : {
"allow_leading_wildcard" : true,
"analyzer" : "string",
"default_field" : "string",
"default_operator" : "string",
"query" : "string"
},
"range" : {
"some_property" : {
"boost" : 0.1,
"format" : "string",
"gt" : {},
"gte" : {},
"lt" : {},
"lte" : {},
"time_zone" : "string"
}
},
"simple_query_string" : {
"analyze_wildcard" : true,
"analyzer" : "string",
"auto_generate_synonyms_phrase_query" : true,
"default_operator" : "string",
"fields" : [
"string"
],
"flags" : "string",
"fuzzy_max_expansions" : 0,
"fuzzy_prefix_length" : 0,
"fuzzy_transpositions" : true,
"lenient" : true,
"minimum_should_match" : "string",
"query" : "string",
"quote_field_suffix" : "string"
},
"term" : {
"some_property" : {
"value" : "string"
}
}
},
"allowed_zones" : [
"string"
],
"config_version" : 0,
"cpu_multiplier" : 0.1,
"deleted_on" : "2019-01-01T00:00:00Z",
"description" : "string",
"discrete_sizes" : {
"default_size" : 0,
"resource" : "string",
"sizes" : [
0
]
},
"id" : "string",
"instance_type" : "string",
"max_zones" : 0,
"metadata" : {},
"name" : "string",
"node_types" : [
"string"
],
"storage_multiplier" : 0.1,
"system_owned" : true
}