It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« ElasticsearchShardsInfo ElasticsearchUserBundle »

› › › ›

ElasticsearchSystemSettings

edit

`ElasticsearchSystemSettings`

edit

A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use ElasticsearchSystemSettings with user_settings_override* and user_settings*.

Properties

edit

auto_create_index (boolean): If true (the default), then any write operation on an index that does not currently exist will create it. NOTES: (Corresponds to the parameter 'action.auto_create_index')
default_shards_per_index (integer as int32): (2.x only - to get the same result in 5.x template mappings must be used) Sets the default number of shards per index, defaulting to 1 if not specified. (Corresponds to the parameter 'index.number_of_shards' in 2.x, not supported in 5.x)
destructive_requires_name (boolean): If true (default is false) then the index deletion API will not support wildcards or '_all'. NOTES: (Corresponds to the parameter 'action.destructive_requires_name')
enable_close_index (boolean): Defaults to false on versions <= 7.2.0, true otherwise. If false, then the API commands to close indices are disabled. This is important because Elasticsearch does not snapshot or migrate close indices on versions under 7.2.0, therefore standard Elastic Cloud configuration operations will cause irretrievable loss of indices' data. NOTES: (Corresponds to the parameter 'cluster.indices.close.enable')
monitoring_collection_interval (integer as int32): The default interval at which monitoring information from the cluster if collected, if monitoring is enabled. NOTES: (Corresponds to the parameter 'marvel.agent.interval' in 2.x and 'xpack.monitoring.collection.interval' in 5.x)
monitoring_history_duration (string): The duration for which monitoring history is stored (format '(NUMBER)d' eg '3d' for 3 days). NOTES: ('Corresponds to the parameter xpack.monitoring.history.duration' in 5.x, defaults to '7d')
reindex_whitelist (array[string]): Limits remote Elasticsearch clusters that can be used as the source for '_reindex' API commands
scripting (ElasticsearchScriptingUserSettings): Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.
use_disk_threshold (boolean): Whether to factor in the available disk space on a node before deciding whether to allocate new shards to that node or actively relocate shards away from the node (default: true). NOTES: (Corresponds to the parameter 'cluster.routing.allocation.disk.threshold_enabled')
watcher_trigger_engine (string): The trigger engine for Watcher, defaults to 'scheduler' - see the xpack documentation for more information. NOTES: (Corresponds to the parameter '(xpack.)watcher.trigger.schedule.engine', depending on version. Ignored from 6.x onwards.)

Example

edit

{
   "auto_create_index" : true,
   "default_shards_per_index" : 0,
   "destructive_requires_name" : true,
   "enable_close_index" : true,
   "monitoring_collection_interval" : 0,
   "monitoring_history_duration" : "string",
   "reindex_whitelist" : [
      "string"
   ],
   "scripting" : {
      "expressions_enabled" : true,
      "file" : {
         "enabled" : true,
         "sandbox_mode" : true
      },
      "inline" : null,
      "mustache_enabled" : true,
      "painless_enabled" : true,
      "stored" : null
   },
   "use_disk_threshold" : true,
   "watcher_trigger_engine" : "string"
}

« ElasticsearchShardsInfo ElasticsearchUserBundle »