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.
DeploymentTemplateInfo
editDeploymentTemplateInfo
editThe top level object for a deployment template.
Properties
edit-
cluster_template
(CreateElasticsearchClusterRequest
) - The body of the cluster template to use for creating a cluster.
-
description
(string
) - An optional description for the template.
-
id
(string
) - The unique identifier for the template.
-
instance_configurations
(array[
InstanceConfiguration
]
) - Optional list of instance configurations used in the cluster template.
-
metadata
(array[
MetadataItem
]
) - Optional arbitrary metadata to associate with this template.
-
name
(string
, required) - A human readable name for the template.
-
order
(integer
asint32
) - Determines the order in which this template should be returned when listed. Templates are returned in ascending order. If not specified, then the template willbe appended to the end of the list.
-
source
(ChangeSourceInfo
) - Information describing the source that created or modified the template.
-
system_owned
(boolean
) - Whether or not if this is system owned template.
Example
edit{ "cluster_template" : { "cluster_name" : "string", "kibana" : { "cluster_name" : "string", "plan" : { "cluster_topology" : [ { "allocator_filter" : {}, "instance_configuration_id" : "string", "kibana" : { "docker_image" : "string", "system_settings" : { "elasticsearch_password" : "string", "elasticsearch_url" : "string", "elasticsearch_username" : "string" }, "user_settings_json" : {}, "user_settings_override_json" : {}, "user_settings_override_yaml" : "string", "user_settings_yaml" : "string", "version" : "string" }, "memory_per_node" : 0, "node_configuration" : "string", "node_count_per_zone" : 0, "size" : { "resource" : "string", "value" : 0 }, "zone_count" : 0 } ], "kibana" : null, "transient" : { "plan_configuration" : { "calm_wait_time" : 0, "cluster_reboot" : "string", "extended_maintenance" : true, "move_allocators" : [ { "allocator_down" : true, "from" : "string", "to" : [ "string" ] } ], "move_instances" : [ { "from" : "string", "instance_down" : true, "to" : [ "string" ] } ], "preferred_allocators" : [ "string" ], "reallocate_instances" : true, "timeout" : 0 }, "strategy" : { "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 } }, "plan" : { "cluster_topology" : [ { "allocator_filter" : {}, "elasticsearch" : { "curation" : { "from_instance_configuration_id" : "string", "to_instance_configuration_id" : "string" }, "docker_image" : "string", "enabled_built_in_plugins" : [ "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" : null, "mustache_enabled" : true, "painless_enabled" : true, "stored" : null }, "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" }, "instance_configuration_id" : "string", "memory_per_node" : 0, "node_configuration" : "string", "node_count_per_zone" : 0, "node_type" : { "data" : true, "ingest" : true, "master" : true, "ml" : true }, "size" : null, "zone_count" : 0 } ], "deployment_template" : { "id" : "string", "version" : "string" }, "elasticsearch" : null, "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_attempts" : 0, "move_allocators" : [ null ], "move_instances" : [ null ], "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_upgrade_checker" : true, "timeout" : 0 }, "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" : null }, "zone_count" : 0 }, "settings" : { "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" ] } } }, "description" : "string", "id" : "string", "instance_configurations" : [ { "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" } }, "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" : {} } } }, "deleted_on" : "2019-01-01T00:00:00Z", "description" : "string", "discrete_sizes" : { "default_size" : 0, "resource" : "string", "sizes" : [ 0 ] }, "id" : "string", "instance_type" : "string", "metadata" : {}, "name" : "string", "node_types" : [ "string" ], "storage_multiplier" : 0.1, "system_owned" : true } ], "metadata" : [ { "key" : "string", "value" : "string" } ], "name" : "string", "order" : 0, "source" : { "action" : "string", "admin_id" : "string", "date" : "2019-01-01T00:00:00Z", "facilitator" : "string", "remote_addresses" : [ "string" ], "user_id" : "string" }, "system_owned" : true }