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.
ElasticsearchPayload
editElasticsearchPayload
editAn alias for an Elasticsearch Cluster paired with a request for creating one
Properties
edit-
display_name
(string
) - The human readable name for the cluster (defaults to the generated cluster id if not specified)
-
plan
(ElasticsearchClusterPlan
, required) - The plan for building this Elasticsearch cluster
-
ref_id
(string
, required) - A locally-unique user-specified id for this Elasticsearch cluster
-
region
(string
, required) - The region where this resource exists
-
settings
(ElasticsearchClusterSettings
) - The settings for building this Elasticsearch cluster
Example
edit{ "display_name" : "string", "plan" : { "autoscaling_enabled" : true, "cluster_topology" : [ { "allocator_filter" : {}, "autoscaling_max" : { "resource" : "string", "value" : 0 }, "autoscaling_min" : { "resource" : "string", "value" : 0 }, "autoscaling_policy_override_json" : {}, "elasticsearch" : { "curation" : { "from_instance_configuration_id" : "string", "to_instance_configuration_id" : "string" }, "docker_image" : "string", "enabled_built_in_plugins" : [ "string" ], "node_attributes" : { "some_property" : "string" }, "system_settings" : { "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" : { "enabled" : true, "sandbox_mode" : true }, "mustache_enabled" : true, "painless_enabled" : true, "stored" : { "enabled" : true, "sandbox_mode" : true } }, "use_disk_threshold" : true, "watcher_trigger_engine" : "string" }, "user_bundles" : [ { "elasticsearch_version" : "string", "name" : "string", "url" : "string" } ], "user_plugins" : [ { "elasticsearch_version" : "string", "name" : "string", "url" : "string" } ], "user_settings_json" : {}, "user_settings_override_json" : {}, "user_settings_override_yaml" : "string", "user_settings_yaml" : "string", "version" : "string" }, "id" : "string", "instance_configuration_id" : "string", "memory_per_node" : 0, "node_configuration" : "string", "node_count_per_zone" : 0, "node_roles" : [ "string" ], "node_type" : { "data" : true, "ingest" : true, "master" : true, "ml" : true }, "size" : { "resource" : "string", "value" : 0 }, "topology_element_control" : { "min" : { "resource" : "string", "value" : 0 } }, "zone_count" : 0 } ], "deployment_template" : { "id" : "string", "version" : "string" }, "elasticsearch" : { "curation" : { "from_instance_configuration_id" : "string", "to_instance_configuration_id" : "string" }, "docker_image" : "string", "enabled_built_in_plugins" : [ "string" ], "node_attributes" : { "some_property" : "string" }, "system_settings" : { "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" : { "enabled" : true, "sandbox_mode" : true }, "mustache_enabled" : true, "painless_enabled" : true, "stored" : { "enabled" : true, "sandbox_mode" : true } }, "use_disk_threshold" : true, "watcher_trigger_engine" : "string" }, "user_bundles" : [ { "elasticsearch_version" : "string", "name" : "string", "url" : "string" } ], "user_plugins" : [ { "elasticsearch_version" : "string", "name" : "string", "url" : "string" } ], "user_settings_json" : {}, "user_settings_override_json" : {}, "user_settings_override_yaml" : "string", "user_settings_yaml" : "string", "version" : "string" }, "tiebreaker_override" : true, "tiebreaker_topology" : { "memory_per_node" : 0 }, "transient" : { "cluster_settings_json" : {}, "plan_configuration" : { "calm_wait_time" : 0, "cluster_reboot" : "string", "extended_maintenance" : true, "max_snapshot_age" : 0, "max_snapshot_attempts" : 0, "move_allocators" : [ { "allocator_down" : true, "from" : "string", "to" : [ "string" ] } ], "move_instances" : [ { "from" : "string", "instance_down" : true, "to" : [ "string" ] } ], "move_only" : true, "override_failsafe" : true, "preferred_allocators" : [ "string" ], "reallocate_instances" : true, "skip_data_migration" : true, "skip_post_upgrade_steps" : true, "skip_snapshot" : true, "skip_snapshot_post_major_upgrade" : true, "skip_upgrade_checker" : true, "timeout" : 0 }, "remote_clusters" : { "resources" : [ { "alias" : "string", "deployment_id" : "string", "elasticsearch_ref_id" : "string", "info" : { "compatible" : true, "connected" : true, "healthy" : true, "trusted" : true, "trusted_back" : true }, "skip_unavailable" : true } ] }, "restore_snapshot" : { "repository_config" : { "raw_settings" : {} }, "repository_name" : "string", "restore_payload" : { "indices" : [ "string" ], "raw_settings" : {} }, "snapshot_name" : "string", "source_cluster_id" : "string", "strategy" : "string" }, "strategy" : { "autodetect" : {}, "grow_and_shrink" : {}, "rolling" : { "allow_inline_resize" : true, "group_by" : "string", "shard_init_wait_time" : 0, "skip_synced_flush" : true }, "rolling_grow_and_shrink" : {} } }, "zone_count" : 0 }, "ref_id" : "string", "region" : "string", "settings" : { "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" } ] } } }