InstanceConfiguration

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

`InstanceConfiguration`

edit

The configuration template for Elasticsearch instances, Kibana instances, and APM Servers.

Properties

edit

allocator_filter (QueryContainer): Optional filter to match allocators against
cpu_multiplier (number as double): Settings for the instance CPU multiplier
deleted_on (string as date-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, required): The type of instance (elasticsearch, kibana)
max_zones (integer as int32): 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
storage_multiplier (number as double): 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)

Example

edit

{
   "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"
         }
      },
      "term" : {
         "some_property" : {
            "value" : "string"
         }
      }
   },
   "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
}

« IndexSynchronizationResults InstanceConfigurationInfo »