A newer version is available. For the latest information, see the
current release documentation.
ElasticsearchClusterSettings
editElasticsearchClusterSettings
editThe settings for an Elasticsearch cluster.
Properties
edit-
curation
(ClusterCurationSettings
) -
The curation settings for this deployment. When provided, curation settings are changed as specified. A
null
value reverts the field to the default value. Otherwise, all curation settings remain as they were set previously. -
dedicated_masters_threshold
(integer
asint32
) -
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. When provided the threshold setting is updated. A
null
value removes the field. Otherwise, the setting remains as it was set previously. -
metadata
(ClusterMetadataSettings
) - The top-level configuration settings for the Elasticsearch cluster.
-
monitoring
(ManagedMonitoringSettings
) -
The monitoring settings for this deployment. When provided, monitoring settings are changed as specified. A
null
value reverts the field to the default value. Otherwise, all monitoring settings remain as they were set previously. -
snapshot
(ClusterSnapshotSettings
) -
The snapshot settings for this deployment. When provided, snapshot settings are changed as specified. A
null
value reverts the field to the default value. Otherwise, all snapshot settings remain as they were set previously. -
traffic_filter
(TrafficFilterSettings
) - The rulesets to apply to all resources in this cluster. When specified, the set of rulesets is updated and the same rulesets will be applied to Kibana and APM clusters as well. If not specified, the rulesets remain as they were set previously.
-
trust
(ElasticsearchClusterTrustSettings
) -
Configuration of trust with other clusters. When provided, trust settings are changed as specified. A
null
value reverts the field to the default value. Otherwise, all trust settings remain as they were set previously.
Example
edit{ "curation" : { "specs" : [ { "index_pattern" : "string", "trigger_interval_seconds" : 0 } ] }, "dedicated_masters_threshold" : 0, "metadata" : { "contact_email" : "string", "hidden" : true, "name" : "string", "organization_id" : "string", "owner_id" : "string", "resources" : { "cpu" : { "boost" : true, "hard_limit" : true } }, "subscription_level" : "string", "system_owned" : true }, "monitoring" : { "target_cluster_id" : "string" }, "snapshot" : { "cron_expression" : "string", "enabled" : true, "interval" : "string", "pending_interval" : "string", "repository" : { "default" : {}, "reference" : { "repository_name" : "string" }, "static" : { "repository_type" : "string", "settings" : {} } }, "retention" : { "max_age" : "string", "snapshots" : 0 }, "slm" : true, "suspended" : [ "string" ], "wait_time_after_snapshotting" : "string" }, "traffic_filter" : { "rulesets" : [ "string" ] }, "trust" : { "accounts" : [ { "account_id" : "string", "trust_all" : true, "trust_allowlist" : [ "string" ] } ], "direct" : [ { "additional_node_names" : [ "string" ], "certificates" : [ { "metadata" : { "fingerprint" : "string", "valid_from" : "2019-01-01T00:00:00Z", "valid_to" : "2019-01-01T00:00:00Z" }, "pem" : "string" } ], "name" : "string", "scope_id" : "string", "trust_all" : true, "trust_allowlist" : [ "string" ], "type" : "string", "uid" : "string" } ], "external" : [ { "trust_all" : true, "trust_allowlist" : [ "string" ], "trust_relationship_id" : "string" } ] } }