IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« ElasticsearchClusterSecurityInfo ElasticsearchClusterTopologyElement »

› › › ›

ElasticsearchClusterSettings

edit

`ElasticsearchClusterSettings`

edit

The settings for an Elasticsearch cluster.

Properties

edit

ccs (CrossClusterSearchSettings)

This endpoint is deprecated and scheduled to be removed in the next major version. Use the /remote-clusters endpoints instead.

Configuration of remote clusters.

curation (ClusterCurationSettings): The index curation settings for an Elasticsearch cluster.
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.
ip_filtering (IpFilteringSettings)

This endpoint is deprecated and scheduled to be removed in the next major version. Use traffic filter settings instead.

The set of rulesets to apply for all the resources in this cluster. When specified the same rulesets will be applied to Kibana and APM clusters as well

metadata (ClusterMetadataSettings): The top-level configuration settings for the Elasticsearch cluster.
monitoring (ManagedMonitoringSettings): The settings for sending monitoring information to another cluster.
snapshot (ClusterSnapshotSettings): The snapshot configuration settings for an Elasticsearch cluster.
traffic_filter (TrafficFilterSettings): The rulesets to apply to all resources in this cluster. When specified the same rulesets will be applied to Kibana and APM clusters as well
trust (ElasticsearchClusterTrustSettings): Configuration of trust with other clusters

Example

edit

{
   "ccs" : {
      "remote_clusters" : {
         "some_property" : {
            "cluster_id" : "string",
            "skip_unavailable" : true
         }
      }
   },
   "curation" : {
      "specs" : [
         {
            "index_pattern" : "string",
            "trigger_interval_seconds" : 0
         }
      ]
   },
   "dedicated_masters_threshold" : 0,
   "ip_filtering" : {
      "rulesets" : [
         "string"
      ]
   },
   "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" : {}
         }
      },
      "repository_name" : "string",
      "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"
            ]
         }
      ],
      "external" : [
         {
            "trust_all" : true,
            "trust_allowlist" : [
               "string"
            ],
            "trust_relationship_id" : "string"
         }
      ]
   }
}

« ElasticsearchClusterSecurityInfo ElasticsearchClusterTopologyElement »