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.

« ElasticsearchClusterSecurityInfo ElasticsearchClusterTopologyElement »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.0] ›RESTful API ›API reference ›Definitions

ElasticsearchClusterSettings

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

ElasticsearchClusterSettings

edit

Settings for controlling ECE functionality for an Elasticsearch cluster

Properties

edit
curation (ClusterCurationSettings)
Cluster index curation settings
dedicated_masters_threshold (integer as int32)
Threshold starting from which the number of instances in the cluster results in the introduction of dedicated masters. If the cluster is downscaled to a number of nodes below this one, dedicated masters will be removed. Limit is inclusive.
metadata (ClusterMetadataSettings)
The cluster metadata settings stores top level configuration for a cluster.
monitoring (ManagedMonitoringSettings)
Settings for sending monitoring information to another cluster
snapshot (ClusterSnapshotSettings)
The cluster snapshot settings stores snapshot configuration for a cluster.

Example

edit
{
   "curation" : {
      "specs" : [
         {
            "index_pattern" : "string",
            "trigger_interval_seconds" : 0
         }
      ]
   },
   "dedicated_masters_threshold" : 0,
   "metadata" : {
      "contact_email" : "string",
      "hidden" : true,
      "name" : "string",
      "owner_id" : "string",
      "resources" : {
         "cpu" : {
            "boost" : true,
            "hard_limit" : true
         }
      },
      "subscription_level" : "string",
      "system_owned" : true
   },
   "monitoring" : {
      "target_cluster_id" : "string"
   },
   "snapshot" : {
      "enabled" : true,
      "interval" : "string",
      "repository" : {
         "default" : {},
         "reference" : {
            "repository_name" : "string"
         },
         "static" : {
            "repository_type" : "string",
            "settings" : {}
         }
      },
      "repository_name" : "string",
      "suspended" : [
         "string"
      ]
   }
}
« ElasticsearchClusterSecurityInfo ElasticsearchClusterTopologyElement »