Get eligible remote clusters
Returns the list of deployments which contain eligible remote clusters for the elasticsearch resource.
Path parameters
-
Identifier for the Deployment.
-
User-specified RefId for the Resource (or '_main' if there is only one).
Body
(Optional) The search query to run against all deployments containing eligible remote clusters. When not specified, all the eligible deployments are matched.
-
from integer(int32)
-
size integer(int32)
The maximum number of search results to return.
-
query object
The container for all of the allowed Elasticsearch queries. Specify only one property each time.
Additional properties are allowed.
Hide query attributes Show query attributes object
-
match object
Hide match attribute Show match attribute object
-
Consumes and analyzes text, numbers, and dates, then constructs a query.
Additional properties are allowed.
Hide * attributes Show * attributes object
-
The text/numeric/date to query for.
-
operator string
The operator flag can be set to or or and to control the boolean clauses (defaults to or).
-
minimum_should_match integer(int32)
The minimum number of optional should clauses to match.
-
analyzer string
The analyzer that will be used to perform the analysis process on the text. Defaults to the analyzer that was used to index the field.
-
-
-
match_all object
A query that matches all documents.
Additional properties are allowed.
-
match_none object
A query that doesn't match any documents.
Additional properties are allowed.
-
term object
-
bool object
A query for documents that match boolean combinations of other queries.
Additional properties are allowed.
Hide bool attributes Show bool attributes object
-
must array[object]
The container for all of the allowed Elasticsearch queries. Specify only one property each time.
Additional properties are allowed.
-
should array[object]
The container for all of the allowed Elasticsearch queries. Specify only one property each time.
Additional properties are allowed.
-
must_not array[object]
The container for all of the allowed Elasticsearch queries. Specify only one property each time.
Additional properties are allowed.
-
filter array[object]
The container for all of the allowed Elasticsearch queries. Specify only one property each time.
Additional properties are allowed.
-
minimum_should_match integer(int32)
The minimum number of optional should clauses to match.
-
-
query_string object
A query that uses the strict query string syntax for parsing. Will return an error for invalid syntax.
Additional properties are allowed.
Hide query_string attributes Show query_string attributes object
-
The actual query to be parsed.
-
default_field string
The default field for query terms if no prefix field is specified.
-
analyzer string
The analyzer used to analyze each term of the query when creating composite queries.
-
default_operator string
The default operator used if no explicit operator is specified.
-
allow_leading_wildcard boolean
When set, * or ? are allowed as the first character. Defaults to false.
-
-
nested object
A query that matches nested objects.
Additional properties are allowed.
Hide nested attributes Show nested attributes object
-
The container for all of the allowed Elasticsearch queries. Specify only one property each time.
Additional properties are allowed.
-
The path to the nested object.
-
score_mode string
Allows to specify how inner children matching affects score of the parent. Refer to the Elasticsearch documentation for details.
Values are
avg
,sum
,min
,max
, ornone
.
-
-
prefix object
Hide prefix attribute Show prefix attribute object
-
The query that matches documents with fields that contain terms with a specified, not analyzed, prefix.
Additional properties are allowed.
-
-
exists object
Matches documents that have at least one non-
null
value in the original field.Additional properties are allowed.
Hide exists attribute Show exists attribute object
-
The field to check for non-null values in.
-
-
range object
Hide range attribute Show range attribute object
-
The query that matches documents with fields that contain terms within a specified range.
Additional properties are allowed.
Hide * attributes Show * attributes object
-
gt object
Greater-than
Additional properties are allowed.
-
gte object
Greater-than or equal to
Additional properties are allowed.
-
lt object
Less-than
Additional properties are allowed.
-
lte object
Less-than or equal to.
Additional properties are allowed.
-
boost number(float)
An optional boost value to apply to the query.
-
format string
Formatted dates will be parsed using the format specified on the date field by default, but it can be overridden by passing the format parameter.
-
time_zone string
Dates can be converted from another timezone to UTC either by specifying the time zone in the date value itself (if the format accepts it), or it can be specified as the time_zone parameter.
-
-
-
simple_query_string object
A query that uses simple query string syntax. Will ignore invalid syntax.
Additional properties are allowed.
Hide simple_query_string attributes Show simple_query_string attributes object
-
The query expressed in simple query string syntax.
-
fields array[string]
Array of fields to search
-
default_operator string
The boolean operator used to combine the terms of the query. Valid values are
OR
(default) andAND
. -
analyze_wildcard boolean
If
true
, the query attempts to analyze wildcard terms. Defaults tofalse
. -
analyzer string
The name of the analyzer to use to convert the query text into tokens.
-
If
true
, the parse creates amatch_phrase
uery for each multi-position token. Defaults totrue
. -
flags string
List of enabled operators for the simple query string syntax. Defaults to
ALL
. -
fuzzy_max_expansions integer(int32)
Maximum number of terms to which the query expands for fuzzy matching. Defaults to 50.
-
fuzzy_prefix_length integer(int32)
Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.
-
fuzzy_transpositions boolean
If
true
, edits for fuzzy matching include transpositions of two adjacent characters. Defaults tofalse
. -
lenient boolean
If
true
, format-based errors, such as providing a text value for a numeric field are ignored. Defaults tofalse
. -
minimum_should_match string
Minimum number of clauses that must match for a document to be returned.
-
quote_field_suffix string
Suffix appended to quoted text in the query string.
-
-
-
sort array[object]
An array of fields to sort the search results by.
Additional properties are allowed.
-
_source object
Additional properties are allowed.
Responses
-
List of deployments which contains eligible remote clusters for the resource
Hide response attributes Show response attributes object
-
The number of deployments actually returned
-
match_count integer(int32)
If a query is supplied, then the total number of deployments that matched
-
Hide deployments attributes Show deployments attributes object
-
A randomly-generated id of this Deployment
-
The name of this deployment
-
alias string
A user-defined deployment alias for user-friendly resource URLs
-
Whether the deployment is overall healthy or not (one or more of the resource info subsections will have healthy: false)
-
The Resources that belong to this Deployment
Additional properties are allowed.
Hide resources attributes Show resources attributes object
-
List of Elasticsearch resources in your Deployment
Hide elasticsearch attributes Show elasticsearch attributes object
-
The locally-unique user-specified id of a Resource
-
The randomly-generated id of a Resource
-
The region where this resource exists
-
Info for the resource.
Additional properties are allowed.
Hide info attributes Show info attributes object
-
The id of the cluster
-
The name of the cluster
-
deployment_id string
The id of the deployment that this Elasticsearch belongs to.
-
Whether the cluster is healthy or not (one or more of the info subsections will have healthy: false)
-
Cluster status
Values are
initializing
,stopping
,stopped
,rebooting
,restarting
,reconfiguring
, orstarted
. -
Information about the current, pending, and past Elasticsearch cluster plans.
Additional properties are allowed.
Hide plan_info attributes Show plan_info attributes object
-
Whether the plan situation is healthy (if unhealthy, means the last plan attempt failed)
-
current object
Information about the Elasticsearch cluster plan.
Additional properties are allowed.
Hide current attributes Show current attributes object
-
plan_attempt_id string
A UUID for each plan attempt
-
plan_attempt_name string
A human readable name for each plan attempt, only populated when retrieving plan histories
-
Either the plan ended successfully, or is not yet completed (and no errors have occurred)
-
attempt_start_time string(date-time)
When this plan attempt (ie to apply the plan to the cluster) started (ISO format in UTC)
-
attempt_end_time string(date-time)
If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)
-
plan_end_time string(date-time)
If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)
-
plan object
The plan for building this Elasticsearch cluster
Additional properties are allowed.
Hide plan attributes Show plan attributes object
-
Hide cluster_topology attributes Show cluster_topology attributes object
-
id string
Unique identifier of this topology element
-
node_type object
Controls the combinations of Elasticsearch node types. TIP: By default, the Elasticsearch node is master eligible, can hold data, and run ingest pipelines. WARNING: Do not set for tiebreaker topologies.
Additional properties are allowed.
Hide node_type attributes Show node_type attributes object
-
master boolean
Defines whether this node can be elected master (default: false)
-
data boolean
Defines whether this node can hold data (default: false)
-
ingest boolean
Defines whether this node can run an ingest pipeline (default: false)
-
ml boolean
Defines whether this node can run ml jobs, valid only for versions 5.4.0 or greater (default: false)
-
-
node_roles array[string]
The list of node roles for this topology element (ES version >= 7.10). Allowable values are: master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, transform
Values are
master
,ingest
,ml
,data_hot
,data_content
,data_warm
,data_cold
,data_frozen
,remote_cluster_client
, ortransform
. -
memory_per_node integer(int32)
The memory capacity in MB for each node of this type built in each zone.
-
node_count_per_zone integer(int32)
The number of nodes of this type that are allocated within each zone. (i.e. total capacity per zone =
node_count_per_zone
*memory_per_node
in MB). Cannot be set for tiebreaker topologies. For dedicated master nodes, must be 1 if an entry exists. -
zone_count integer(int32)
The default number of zones in which data nodes will be placed
-
elasticsearch object
The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
Additional properties are allowed.
Hide elasticsearch attributes Show elasticsearch attributes object
-
version string
The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.
-
docker_image string
A docker URI that allows overriding of the default docker image specified for this version
-
system_settings object
A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use
ElasticsearchSystemSettings
withuser_settings_override*
anduser_settings*
.Additional properties are allowed.
Hide system_settings attributes Show system_settings attributes object
-
scripting object
Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.
Additional properties are allowed.
Hide scripting attributes Show scripting attributes object
-
painless_enabled boolean
(5.x+ only) If enabled (the default) then the painless scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.painless.[file|stored|inline]')
-
mustache_enabled boolean
(5.x+ only) If enabled (the default) then the mustache scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.mustache.[file|stored|inline]')
-
expressions_enabled boolean
(5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')
-
stored object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide stored attributes Show stored attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
file object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide file attributes Show file attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
inline object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide inline attributes Show inline attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
-
reindex_whitelist array[string]
Limits remote Elasticsearch clusters that can be used as the source for '_reindex' API commands
-
auto_create_index boolean
If true (the default), then any write operation on an index that does not currently exist will create it. NOTES: (Corresponds to the parameter 'action.auto_create_index')
-
enable_close_index boolean
Defaults to false on versions <= 7.2.0, true otherwise. If false, then the API commands to close indices are disabled. This is important because Elasticsearch does not snapshot or migrate close indices on versions under 7.2.0, therefore standard Elastic Cloud configuration operations will cause irretrievable loss of indices' data. NOTES: (Corresponds to the parameter 'cluster.indices.close.enable')
-
destructive_requires_name boolean
If true (default is false) then the index deletion API will not support wildcards or '_all'. NOTES: (Corresponds to the parameter 'action.destructive_requires_name')
-
watcher_trigger_engine string
The trigger engine for Watcher, defaults to 'scheduler' - see the xpack documentation for more information. NOTES: (Corresponds to the parameter '(xpack.)watcher.trigger.schedule.engine', depending on version. Ignored from 6.x onwards.)
-
default_shards_per_index integer(int32)
(2.x only - to get the same result in 5.x template mappings must be used) Sets the default number of shards per index, defaulting to 1 if not specified. (Corresponds to the parameter 'index.number_of_shards' in 2.x, not supported in 5.x)
-
monitoring_collection_interval integer(int32)
The default interval at which monitoring information from the cluster if collected, if monitoring is enabled. NOTES: (Corresponds to the parameter 'marvel.agent.interval' in 2.x and 'xpack.monitoring.collection.interval' in 5.x)
-
monitoring_history_duration string
The duration for which monitoring history is stored (format '(NUMBER)d' eg '3d' for 3 days). NOTES: ('Corresponds to the parameter xpack.monitoring.history.duration' in 5.x, defaults to '7d')
-
-
user_settings_json object
An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
Additional properties are allowed.
-
user_settings_yaml string
An arbitrary YAML object allowing cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
-
user_settings_override_json object
An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
Additional properties are allowed.
-
user_settings_override_yaml string
An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
-
enabled_built_in_plugins array[string]
A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)
-
user_plugins array[object]
A list of admin-uploaded plugin objects that are available for this user.
Hide user_plugins attributes Show user_plugins attributes object
-
The name of the plugin
-
The URL of the plugin (must be accessible from the ECE infrastructure)
-
The supported Elasticsearch version (must match the version in the plan)
-
-
user_bundles array[object]
A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.
Hide user_bundles attributes Show user_bundles attributes object
-
The name of the bundle
-
The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle
-
The supported Elasticsearch version (must match the version in the plan)
-
-
curation object
Defines the index curation routing for the cluster
Additional properties are allowed.
Hide curation attributes Show curation attributes object
-
The source instance configuration
-
The destination instance configuration
-
-
node_attributes object
Defines the Elasticsearch node attributes for the instances in the topology
Hide node_attributes attribute Show node_attributes attribute object
-
-
instance_configuration_id string
Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
-
instance_configuration_version integer(int32)
The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.
-
size object
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
Additional properties are allowed.
-
autoscaling_min object
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
Additional properties are allowed.
-
autoscaling_max object
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
Additional properties are allowed.
-
An arbitrary JSON object overriding the default autoscaling policy. Don't set unless you really know what you are doing.
Additional properties are allowed.
-
topology_element_control object
Controls for the topology element. Only used as part of the deployment template. Ignored if included as part of a deployment.
Additional properties are allowed.
Hide topology_element_control attribute Show topology_element_control attribute object
-
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
Additional properties are allowed.
-
-
autoscaling_tier_override boolean
Set to true to enable autoscaling for this topology element, even if the cluster-level 'autoscaling_enabled' field is false. Note that 'autoscaling_tier_override' cannot be set to false if cluster-level 'autoscaling_enabled' is true. Currently only supported for the 'ml' tier
-
-
The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
Additional properties are allowed.
Hide elasticsearch attributes Show elasticsearch attributes object
-
version string
The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.
-
docker_image string
A docker URI that allows overriding of the default docker image specified for this version
-
system_settings object
A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use
ElasticsearchSystemSettings
withuser_settings_override*
anduser_settings*
.Additional properties are allowed.
Hide system_settings attributes Show system_settings attributes object
-
scripting object
Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.
Additional properties are allowed.
Hide scripting attributes Show scripting attributes object
-
painless_enabled boolean
(5.x+ only) If enabled (the default) then the painless scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.painless.[file|stored|inline]')
-
mustache_enabled boolean
(5.x+ only) If enabled (the default) then the mustache scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.mustache.[file|stored|inline]')
-
expressions_enabled boolean
(5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')
-
stored object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide stored attributes Show stored attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
file object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide file attributes Show file attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
inline object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide inline attributes Show inline attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
-
reindex_whitelist array[string]
Limits remote Elasticsearch clusters that can be used as the source for '_reindex' API commands
-
auto_create_index boolean
If true (the default), then any write operation on an index that does not currently exist will create it. NOTES: (Corresponds to the parameter 'action.auto_create_index')
-
enable_close_index boolean
Defaults to false on versions <= 7.2.0, true otherwise. If false, then the API commands to close indices are disabled. This is important because Elasticsearch does not snapshot or migrate close indices on versions under 7.2.0, therefore standard Elastic Cloud configuration operations will cause irretrievable loss of indices' data. NOTES: (Corresponds to the parameter 'cluster.indices.close.enable')
-
destructive_requires_name boolean
If true (default is false) then the index deletion API will not support wildcards or '_all'. NOTES: (Corresponds to the parameter 'action.destructive_requires_name')
-
watcher_trigger_engine string
The trigger engine for Watcher, defaults to 'scheduler' - see the xpack documentation for more information. NOTES: (Corresponds to the parameter '(xpack.)watcher.trigger.schedule.engine', depending on version. Ignored from 6.x onwards.)
-
default_shards_per_index integer(int32)
(2.x only - to get the same result in 5.x template mappings must be used) Sets the default number of shards per index, defaulting to 1 if not specified. (Corresponds to the parameter 'index.number_of_shards' in 2.x, not supported in 5.x)
-
monitoring_collection_interval integer(int32)
The default interval at which monitoring information from the cluster if collected, if monitoring is enabled. NOTES: (Corresponds to the parameter 'marvel.agent.interval' in 2.x and 'xpack.monitoring.collection.interval' in 5.x)
-
monitoring_history_duration string
The duration for which monitoring history is stored (format '(NUMBER)d' eg '3d' for 3 days). NOTES: ('Corresponds to the parameter xpack.monitoring.history.duration' in 5.x, defaults to '7d')
-
-
user_settings_json object
An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
Additional properties are allowed.
-
user_settings_yaml string
An arbitrary YAML object allowing cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
-
user_settings_override_json object
An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
Additional properties are allowed.
-
user_settings_override_yaml string
An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
-
enabled_built_in_plugins array[string]
A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)
-
user_plugins array[object]
A list of admin-uploaded plugin objects that are available for this user.
Hide user_plugins attributes Show user_plugins attributes object
-
The name of the plugin
-
The URL of the plugin (must be accessible from the ECE infrastructure)
-
The supported Elasticsearch version (must match the version in the plan)
-
-
user_bundles array[object]
A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.
Hide user_bundles attributes Show user_bundles attributes object
-
The name of the bundle
-
The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle
-
The supported Elasticsearch version (must match the version in the plan)
-
-
curation object
Defines the index curation routing for the cluster
Additional properties are allowed.
Hide curation attributes Show curation attributes object
-
The source instance configuration
-
The destination instance configuration
-
-
node_attributes object
Defines the Elasticsearch node attributes for the instances in the topology
Hide node_attributes attribute Show node_attributes attribute object
-
-
deployment_template object
Documents which deployment template was used in the creation of this plan
Additional properties are allowed.
-
transient object
Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Elasticsearch settings.
Additional properties are allowed.
Hide transient attributes Show transient attributes object
-
strategy object
The options for performing a plan change. Specify only one property each time. The default is
grow_and_shrink
.Additional properties are allowed.
Hide strategy attributes Show strategy attributes object
-
rolling object
Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.
Additional properties are allowed.
Hide rolling attributes Show rolling attributes object
-
group_by string
Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade
-
allow_inline_resize boolean
Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing
-
skip_synced_flush boolean
Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy
-
shard_init_wait_time integer(int64)
The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
-
-
grow_and_shrink object
A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances.
GrowShrinkStrategyConfig
is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.Additional properties are allowed.
-
rolling_grow_and_shrink object
A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.
Additional properties are allowed.
-
autodetect object
A strategy that lets constructor choose the most optimal way to execute the plan.
Additional properties are allowed.
-
-
plan_configuration object
The configuration settings for the timeout and fallback parameters.
Additional properties are allowed.
Hide plan_configuration attributes Show plan_configuration attributes object
-
timeout integer(int64)
The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB). NOTES: A 3 zone cluster with 2 nodes of 2048 each would have a timeout of 4*2048=8192 seconds. Timeout does not include time required to run rollback actions.
-
calm_wait_time integer(int64)
This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
-
move_instances array[object]
Hide move_instances attributes Show move_instances attributes object
-
The instance id that is going to be moved
-
to array[string]
An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
-
instance_down boolean
Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)
-
-
move_allocators array[object]
Hide move_allocators attributes Show move_allocators attributes object
-
The allocator id off which all instances in the cluster should be moved
-
to array[string]
An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
-
allocator_down boolean
Tells the infrastructure that all instances on the allocator should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will auto-decide (currently: will treat the allocator as up)
-
-
move_only boolean
If true (default: false) only move_instances and move_allocators instructions will be executed, all other changes will be ignored
-
reallocate_instances boolean
If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created
-
preferred_allocators array[string]
List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)
-
preferred_allocator_tags object
Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators
Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
-
skip_snapshot boolean
If true (default: false), does not take (or require) a successful snapshot to be taken before performing any potentially destructive changes to this cluster
-
max_snapshot_attempts integer(int32)
If taking a snapshot (ie unless 'skip_snapshots': true) then will retry on failure at most this number of times (default: 5)
-
max_snapshot_age integer(int64)
When you take a snapshot and 'skip_snapshots' is false, specifies the maximum age in seconds of the most recent snapshot before a new snapshot is created. Default is 300
-
extended_maintenance boolean
If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
-
cluster_reboot string
Set to 'forced' to force a reboot as part of the upgrade plan. NOTES: (ie taking an existing plan and leaving it alone except for setting 'transient.plan_configuration.cluster_reboot': 'forced' will reboot the cluster)
Value is
forced
. -
override_failsafe boolean
If false (the default) then the plan will fail out if it believes the requested sequence of operations can result in data loss - this flag will override some of these restraints
-
skip_data_migration boolean
If true (default: false) then the plan will not wait for data to be migrated from old instances to new instances before continuing the plan (potentially deleting the old instances and losing data)
-
skip_upgrade_checker boolean
If false, the cluster is checked for issues that should be resolved before migration (eg contains old Lucene segments), if true this is bypassed
-
skip_post_upgrade_steps boolean
If false (the default), the cluster will run (currently) 2.x->5.x operations for any plan change ending with a 5.x cluster (eg apply a cluster license, ensure Monitoring is configured)
-
skip_snapshot_post_major_upgrade boolean
If false (the default), the cluster will perform a snapshot after a major version upgrade takes place
-
-
restore_snapshot object
Restores a snapshot from a local or remote repository.
Additional properties are allowed.
Hide restore_snapshot attributes Show restore_snapshot attributes object
-
repository_name string
If specified, contains the name of the snapshot repository - else will default to the Elastic Cloud system repo ('found-snapshots')
-
The name of the snapshot to restore. Use '__latest_success__' to get the most recent snapshot from the specified repository
-
repository_config object
Raw remote snapshot restore settings. Do not send this if you are sending source_cluster_id
Additional properties are allowed.
Hide repository_config attribute Show repository_config attribute object
-
raw_settings object
The remote snapshot settings raw JSON - see the Elasticsearch '_snapshot' documentation for more details on supported formats
Additional properties are allowed.
-
-
restore_payload object
The configuration for the restore command, such as which indices you want to restore.
Additional properties are allowed.
Hide restore_payload attributes Show restore_payload attributes object
-
indices array[string]
The list of indices to restore (supports +ve and -ve selection and wildcarding - see the default Elasticsearch index format documentation)
-
raw_settings object
This JSON object (merged with the 'indices' field (if present) is passed untouched into the restore command - see the Elasticsearch '_snapshot' documentation for more details on supported formats
Additional properties are allowed.
-
-
strategy string
The restore strategy to use. Defaults to a full restore. Partial restore will attempt to restore unavailable indices only
Values are
partial
,full
, orrecovery
. -
source_cluster_id string
If specified, contains the name of the source cluster id. Do not send this if you are sending repository_config
-
-
remote_clusters object
The list of resources that will be configured as remote clusters
Additional properties are allowed.
Hide remote_clusters attribute Show remote_clusters attribute object
-
The remote resources
Hide resources attributes Show resources attributes object
-
The id of the deployment
-
The locally-unique user-specified id of an Elasticsearch Resource
-
The alias for this remote cluster. Aliases must only contain letters, digits, dashes and underscores
-
skip_unavailable boolean
If true, skip this cluster during search if it is disconnected. Default: false
-
info object
Information about a Remote Cluster.
Additional properties are allowed.
Hide info attributes Show info attributes object
-
Whether or not the remote cluster is healthy
-
Whether or not there is at least one connection to the remote cluster.
-
Whether or not the remote cluster version is compatible with this cluster version.
-
Whether or not the remote cluster is trusted by this cluster.
-
Whether or not the remote cluster trusts this cluster back.
-
-
-
-
cluster_settings_json object
If specified, contains transient settings to be applied to an Elasticsearch cluster during changes,default values shown below applied. These can be overridden by specifying them in the map (or null to unset). Additional settings can also be set. Settings will be cleared after the plan has finished. If not specified, no settings will be applied. NOTE: These settings are only explicitly cleared for 5.x+ clusters, they must be hand-reset to their defaults in 2.x- (or a cluster reboot will clear them).
- indices.store.throttle.max_bytes_per_sec: 120Mb
- indices.recovery.max_bytes_per_sec: 120Mb
- cluster.routing.allocation.cluster_concurrent_rebalance: 5
- cluster.routing.allocation.node_initial_primaries_recoveries: 5
- cluster.routing.allocation.node_concurrent_incoming_recoveries: 5 For version 8.1 and later no defaults are provided through this mechanism, but instead hardware dependent settings are provided to each instance.
Additional properties are allowed.
-
-
autoscaling_enabled boolean
Enable autoscaling for this Elasticsearch cluster.
-
-
Hide plan_attempt_log attributes Show plan_attempt_log attributes object
-
ID of current step
-
When the step started (ISO format in UTC)
-
completed string(date-time)
When the step completed (ISO format in UTC)
-
duration_in_millis integer(int64)
The duration of the step in MS
-
The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)
Values are
success
,warning
,error
, orpending
. -
Current stage that the step is in
Values are
starting
,completed
, orin_progress
. -
Human readable summaries of the step, including messages for each stage of the step
Hide info_log attributes Show info_log attributes object
-
Timestamp marking on info log of step
-
delta_in_millis integer(int64)
Time in milliseconds since previous log message
-
Stage that info log message takes place in
Values are
starting
,completed
, orin_progress
. -
Human readable log message
-
A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.
Hide details attribute Show details attribute object
-
internal_details object
A json object with sensitive details for the log, visible only to admins. May contain nested json objects.
Hide internal_details attribute Show internal_details attribute object
-
failure_type string
The failure type, in case the step failed
-
-
-
source object
Information describing the source that facilitated the plans current state
Additional properties are allowed.
Hide source attributes Show source attributes object
-
The service where the change originated from
-
The type of plan change that was initiated
-
The time the change was initiated
-
user_id string
The user that requested the change
-
admin_id string
The admin user that requested the change
-
remote_addresses array[string]
The host addresses of the user that originated the change
-
-
error object
Information about an error during a plan attempt.
Additional properties are allowed.
Hide error attributes Show error attributes object
-
Timestamp marking on info log of step
-
Human readable error message
-
A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively.
Hide details attribute Show details attribute object
-
failure_type string
The failure type
-
-
-
pending object
Information about the Elasticsearch cluster plan.
Additional properties are allowed.
Hide pending attributes Show pending attributes object
-
plan_attempt_id string
A UUID for each plan attempt
-
plan_attempt_name string
A human readable name for each plan attempt, only populated when retrieving plan histories
-
Either the plan ended successfully, or is not yet completed (and no errors have occurred)
-
attempt_start_time string(date-time)
When this plan attempt (ie to apply the plan to the cluster) started (ISO format in UTC)
-
attempt_end_time string(date-time)
If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)
-
plan_end_time string(date-time)
If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)
-
plan object
The plan for building this Elasticsearch cluster
Additional properties are allowed.
Hide plan attributes Show plan attributes object
-
Hide cluster_topology attributes Show cluster_topology attributes object
-
id string
Unique identifier of this topology element
-
node_type object
Controls the combinations of Elasticsearch node types. TIP: By default, the Elasticsearch node is master eligible, can hold data, and run ingest pipelines. WARNING: Do not set for tiebreaker topologies.
Additional properties are allowed.
Hide node_type attributes Show node_type attributes object
-
master boolean
Defines whether this node can be elected master (default: false)
-
data boolean
Defines whether this node can hold data (default: false)
-
ingest boolean
Defines whether this node can run an ingest pipeline (default: false)
-
ml boolean
Defines whether this node can run ml jobs, valid only for versions 5.4.0 or greater (default: false)
-
-
node_roles array[string]
The list of node roles for this topology element (ES version >= 7.10). Allowable values are: master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, transform
Values are
master
,ingest
,ml
,data_hot
,data_content
,data_warm
,data_cold
,data_frozen
,remote_cluster_client
, ortransform
. -
memory_per_node integer(int32)
The memory capacity in MB for each node of this type built in each zone.
-
node_count_per_zone integer(int32)
The number of nodes of this type that are allocated within each zone. (i.e. total capacity per zone =
node_count_per_zone
*memory_per_node
in MB). Cannot be set for tiebreaker topologies. For dedicated master nodes, must be 1 if an entry exists. -
zone_count integer(int32)
The default number of zones in which data nodes will be placed
-
elasticsearch object
The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
Additional properties are allowed.
Hide elasticsearch attributes Show elasticsearch attributes object
-
version string
The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.
-
docker_image string
A docker URI that allows overriding of the default docker image specified for this version
-
system_settings object
A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use
ElasticsearchSystemSettings
withuser_settings_override*
anduser_settings*
.Additional properties are allowed.
Hide system_settings attributes Show system_settings attributes object
-
scripting object
Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.
Additional properties are allowed.
Hide scripting attributes Show scripting attributes object
-
painless_enabled boolean
(5.x+ only) If enabled (the default) then the painless scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.painless.[file|stored|inline]')
-
mustache_enabled boolean
(5.x+ only) If enabled (the default) then the mustache scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.mustache.[file|stored|inline]')
-
expressions_enabled boolean
(5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')
-
stored object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide stored attributes Show stored attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
file object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide file attributes Show file attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
inline object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide inline attributes Show inline attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
-
reindex_whitelist array[string]
Limits remote Elasticsearch clusters that can be used as the source for '_reindex' API commands
-
auto_create_index boolean
If true (the default), then any write operation on an index that does not currently exist will create it. NOTES: (Corresponds to the parameter 'action.auto_create_index')
-
enable_close_index boolean
Defaults to false on versions <= 7.2.0, true otherwise. If false, then the API commands to close indices are disabled. This is important because Elasticsearch does not snapshot or migrate close indices on versions under 7.2.0, therefore standard Elastic Cloud configuration operations will cause irretrievable loss of indices' data. NOTES: (Corresponds to the parameter 'cluster.indices.close.enable')
-
destructive_requires_name boolean
If true (default is false) then the index deletion API will not support wildcards or '_all'. NOTES: (Corresponds to the parameter 'action.destructive_requires_name')
-
watcher_trigger_engine string
The trigger engine for Watcher, defaults to 'scheduler' - see the xpack documentation for more information. NOTES: (Corresponds to the parameter '(xpack.)watcher.trigger.schedule.engine', depending on version. Ignored from 6.x onwards.)
-
default_shards_per_index integer(int32)
(2.x only - to get the same result in 5.x template mappings must be used) Sets the default number of shards per index, defaulting to 1 if not specified. (Corresponds to the parameter 'index.number_of_shards' in 2.x, not supported in 5.x)
-
monitoring_collection_interval integer(int32)
The default interval at which monitoring information from the cluster if collected, if monitoring is enabled. NOTES: (Corresponds to the parameter 'marvel.agent.interval' in 2.x and 'xpack.monitoring.collection.interval' in 5.x)
-
monitoring_history_duration string
The duration for which monitoring history is stored (format '(NUMBER)d' eg '3d' for 3 days). NOTES: ('Corresponds to the parameter xpack.monitoring.history.duration' in 5.x, defaults to '7d')
-
-
user_settings_json object
An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
Additional properties are allowed.
-
user_settings_yaml string
An arbitrary YAML object allowing cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
-
user_settings_override_json object
An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
Additional properties are allowed.
-
user_settings_override_yaml string
An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
-
enabled_built_in_plugins array[string]
A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)
-
user_plugins array[object]
A list of admin-uploaded plugin objects that are available for this user.
Hide user_plugins attributes Show user_plugins attributes object
-
The name of the plugin
-
The URL of the plugin (must be accessible from the ECE infrastructure)
-
The supported Elasticsearch version (must match the version in the plan)
-
-
user_bundles array[object]
A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.
Hide user_bundles attributes Show user_bundles attributes object
-
The name of the bundle
-
The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle
-
The supported Elasticsearch version (must match the version in the plan)
-
-
curation object
Defines the index curation routing for the cluster
Additional properties are allowed.
Hide curation attributes Show curation attributes object
-
The source instance configuration
-
The destination instance configuration
-
-
node_attributes object
Defines the Elasticsearch node attributes for the instances in the topology
Hide node_attributes attribute Show node_attributes attribute object
-
-
instance_configuration_id string
Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
-
instance_configuration_version integer(int32)
The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.
-
size object
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
Additional properties are allowed.
-
autoscaling_min object
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
Additional properties are allowed.
-
autoscaling_max object
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
Additional properties are allowed.
-
An arbitrary JSON object overriding the default autoscaling policy. Don't set unless you really know what you are doing.
Additional properties are allowed.
-
topology_element_control object
Controls for the topology element. Only used as part of the deployment template. Ignored if included as part of a deployment.
Additional properties are allowed.
Hide topology_element_control attribute Show topology_element_control attribute object
-
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
Additional properties are allowed.
-
-
autoscaling_tier_override boolean
Set to true to enable autoscaling for this topology element, even if the cluster-level 'autoscaling_enabled' field is false. Note that 'autoscaling_tier_override' cannot be set to false if cluster-level 'autoscaling_enabled' is true. Currently only supported for the 'ml' tier
-
-
The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
Additional properties are allowed.
Hide elasticsearch attributes Show elasticsearch attributes object
-
version string
The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.
-
docker_image string
A docker URI that allows overriding of the default docker image specified for this version
-
system_settings object
A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use
ElasticsearchSystemSettings
withuser_settings_override*
anduser_settings*
.Additional properties are allowed.
Hide system_settings attributes Show system_settings attributes object
-
scripting object
Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.
Additional properties are allowed.
Hide scripting attributes Show scripting attributes object
-
painless_enabled boolean
(5.x+ only) If enabled (the default) then the painless scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.painless.[file|stored|inline]')
-
mustache_enabled boolean
(5.x+ only) If enabled (the default) then the mustache scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.mustache.[file|stored|inline]')
-
expressions_enabled boolean
(5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')
-
stored object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide stored attributes Show stored attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
file object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide file attributes Show file attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
inline object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide inline attributes Show inline attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
-
reindex_whitelist array[string]
Limits remote Elasticsearch clusters that can be used as the source for '_reindex' API commands
-
auto_create_index boolean
If true (the default), then any write operation on an index that does not currently exist will create it. NOTES: (Corresponds to the parameter 'action.auto_create_index')
-
enable_close_index boolean
Defaults to false on versions <= 7.2.0, true otherwise. If false, then the API commands to close indices are disabled. This is important because Elasticsearch does not snapshot or migrate close indices on versions under 7.2.0, therefore standard Elastic Cloud configuration operations will cause irretrievable loss of indices' data. NOTES: (Corresponds to the parameter 'cluster.indices.close.enable')
-
destructive_requires_name boolean
If true (default is false) then the index deletion API will not support wildcards or '_all'. NOTES: (Corresponds to the parameter 'action.destructive_requires_name')
-
watcher_trigger_engine string
The trigger engine for Watcher, defaults to 'scheduler' - see the xpack documentation for more information. NOTES: (Corresponds to the parameter '(xpack.)watcher.trigger.schedule.engine', depending on version. Ignored from 6.x onwards.)
-
default_shards_per_index integer(int32)
(2.x only - to get the same result in 5.x template mappings must be used) Sets the default number of shards per index, defaulting to 1 if not specified. (Corresponds to the parameter 'index.number_of_shards' in 2.x, not supported in 5.x)
-
monitoring_collection_interval integer(int32)
The default interval at which monitoring information from the cluster if collected, if monitoring is enabled. NOTES: (Corresponds to the parameter 'marvel.agent.interval' in 2.x and 'xpack.monitoring.collection.interval' in 5.x)
-
monitoring_history_duration string
The duration for which monitoring history is stored (format '(NUMBER)d' eg '3d' for 3 days). NOTES: ('Corresponds to the parameter xpack.monitoring.history.duration' in 5.x, defaults to '7d')
-
-
user_settings_json object
An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
Additional properties are allowed.
-
user_settings_yaml string
An arbitrary YAML object allowing cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
-
user_settings_override_json object
An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
Additional properties are allowed.
-
user_settings_override_yaml string
An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
-
enabled_built_in_plugins array[string]
A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)
-
user_plugins array[object]
A list of admin-uploaded plugin objects that are available for this user.
Hide user_plugins attributes Show user_plugins attributes object
-
The name of the plugin
-
The URL of the plugin (must be accessible from the ECE infrastructure)
-
The supported Elasticsearch version (must match the version in the plan)
-
-
user_bundles array[object]
A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.
Hide user_bundles attributes Show user_bundles attributes object
-
The name of the bundle
-
The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle
-
The supported Elasticsearch version (must match the version in the plan)
-
-
curation object
Defines the index curation routing for the cluster
Additional properties are allowed.
Hide curation attributes Show curation attributes object
-
The source instance configuration
-
The destination instance configuration
-
-
node_attributes object
Defines the Elasticsearch node attributes for the instances in the topology
Hide node_attributes attribute Show node_attributes attribute object
-
-
deployment_template object
Documents which deployment template was used in the creation of this plan
Additional properties are allowed.
-
transient object
Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Elasticsearch settings.
Additional properties are allowed.
Hide transient attributes Show transient attributes object
-
strategy object
The options for performing a plan change. Specify only one property each time. The default is
grow_and_shrink
.Additional properties are allowed.
Hide strategy attributes Show strategy attributes object
-
rolling object
Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.
Additional properties are allowed.
Hide rolling attributes Show rolling attributes object
-
group_by string
Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade
-
allow_inline_resize boolean
Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing
-
skip_synced_flush boolean
Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy
-
shard_init_wait_time integer(int64)
The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
-
-
grow_and_shrink object
A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances.
GrowShrinkStrategyConfig
is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.Additional properties are allowed.
-
rolling_grow_and_shrink object
A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.
Additional properties are allowed.
-
autodetect object
A strategy that lets constructor choose the most optimal way to execute the plan.
Additional properties are allowed.
-
-
plan_configuration object
The configuration settings for the timeout and fallback parameters.
Additional properties are allowed.
Hide plan_configuration attributes Show plan_configuration attributes object
-
timeout integer(int64)
The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB). NOTES: A 3 zone cluster with 2 nodes of 2048 each would have a timeout of 4*2048=8192 seconds. Timeout does not include time required to run rollback actions.
-
calm_wait_time integer(int64)
This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
-
move_instances array[object]
Hide move_instances attributes Show move_instances attributes object
-
The instance id that is going to be moved
-
to array[string]
An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
-
instance_down boolean
Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)
-
-
move_allocators array[object]
Hide move_allocators attributes Show move_allocators attributes object
-
The allocator id off which all instances in the cluster should be moved
-
to array[string]
An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
-
allocator_down boolean
Tells the infrastructure that all instances on the allocator should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will auto-decide (currently: will treat the allocator as up)
-
-
move_only boolean
If true (default: false) only move_instances and move_allocators instructions will be executed, all other changes will be ignored
-
reallocate_instances boolean
If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created
-
preferred_allocators array[string]
List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)
-
preferred_allocator_tags object
Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators
Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
-
skip_snapshot boolean
If true (default: false), does not take (or require) a successful snapshot to be taken before performing any potentially destructive changes to this cluster
-
max_snapshot_attempts integer(int32)
If taking a snapshot (ie unless 'skip_snapshots': true) then will retry on failure at most this number of times (default: 5)
-
max_snapshot_age integer(int64)
When you take a snapshot and 'skip_snapshots' is false, specifies the maximum age in seconds of the most recent snapshot before a new snapshot is created. Default is 300
-
extended_maintenance boolean
If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
-
cluster_reboot string
Set to 'forced' to force a reboot as part of the upgrade plan. NOTES: (ie taking an existing plan and leaving it alone except for setting 'transient.plan_configuration.cluster_reboot': 'forced' will reboot the cluster)
Value is
forced
. -
override_failsafe boolean
If false (the default) then the plan will fail out if it believes the requested sequence of operations can result in data loss - this flag will override some of these restraints
-
skip_data_migration boolean
If true (default: false) then the plan will not wait for data to be migrated from old instances to new instances before continuing the plan (potentially deleting the old instances and losing data)
-
skip_upgrade_checker boolean
If false, the cluster is checked for issues that should be resolved before migration (eg contains old Lucene segments), if true this is bypassed
-
skip_post_upgrade_steps boolean
If false (the default), the cluster will run (currently) 2.x->5.x operations for any plan change ending with a 5.x cluster (eg apply a cluster license, ensure Monitoring is configured)
-
skip_snapshot_post_major_upgrade boolean
If false (the default), the cluster will perform a snapshot after a major version upgrade takes place
-
-
restore_snapshot object
Restores a snapshot from a local or remote repository.
Additional properties are allowed.
Hide restore_snapshot attributes Show restore_snapshot attributes object
-
repository_name string
If specified, contains the name of the snapshot repository - else will default to the Elastic Cloud system repo ('found-snapshots')
-
The name of the snapshot to restore. Use '__latest_success__' to get the most recent snapshot from the specified repository
-
repository_config object
Raw remote snapshot restore settings. Do not send this if you are sending source_cluster_id
Additional properties are allowed.
Hide repository_config attribute Show repository_config attribute object
-
raw_settings object
The remote snapshot settings raw JSON - see the Elasticsearch '_snapshot' documentation for more details on supported formats
Additional properties are allowed.
-
-
restore_payload object
The configuration for the restore command, such as which indices you want to restore.
Additional properties are allowed.
Hide restore_payload attributes Show restore_payload attributes object
-
indices array[string]
The list of indices to restore (supports +ve and -ve selection and wildcarding - see the default Elasticsearch index format documentation)
-
raw_settings object
This JSON object (merged with the 'indices' field (if present) is passed untouched into the restore command - see the Elasticsearch '_snapshot' documentation for more details on supported formats
Additional properties are allowed.
-
-
strategy string
The restore strategy to use. Defaults to a full restore. Partial restore will attempt to restore unavailable indices only
Values are
partial
,full
, orrecovery
. -
source_cluster_id string
If specified, contains the name of the source cluster id. Do not send this if you are sending repository_config
-
-
remote_clusters object
The list of resources that will be configured as remote clusters
Additional properties are allowed.
Hide remote_clusters attribute Show remote_clusters attribute object
-
The remote resources
Hide resources attributes Show resources attributes object
-
The id of the deployment
-
The locally-unique user-specified id of an Elasticsearch Resource
-
The alias for this remote cluster. Aliases must only contain letters, digits, dashes and underscores
-
skip_unavailable boolean
If true, skip this cluster during search if it is disconnected. Default: false
-
info object
Information about a Remote Cluster.
Additional properties are allowed.
Hide info attributes Show info attributes object
-
Whether or not the remote cluster is healthy
-
Whether or not there is at least one connection to the remote cluster.
-
Whether or not the remote cluster version is compatible with this cluster version.
-
Whether or not the remote cluster is trusted by this cluster.
-
Whether or not the remote cluster trusts this cluster back.
-
-
-
-
cluster_settings_json object
If specified, contains transient settings to be applied to an Elasticsearch cluster during changes,default values shown below applied. These can be overridden by specifying them in the map (or null to unset). Additional settings can also be set. Settings will be cleared after the plan has finished. If not specified, no settings will be applied. NOTE: These settings are only explicitly cleared for 5.x+ clusters, they must be hand-reset to their defaults in 2.x- (or a cluster reboot will clear them).
- indices.store.throttle.max_bytes_per_sec: 120Mb
- indices.recovery.max_bytes_per_sec: 120Mb
- cluster.routing.allocation.cluster_concurrent_rebalance: 5
- cluster.routing.allocation.node_initial_primaries_recoveries: 5
- cluster.routing.allocation.node_concurrent_incoming_recoveries: 5 For version 8.1 and later no defaults are provided through this mechanism, but instead hardware dependent settings are provided to each instance.
Additional properties are allowed.
-
-
autoscaling_enabled boolean
Enable autoscaling for this Elasticsearch cluster.
-
-
Hide plan_attempt_log attributes Show plan_attempt_log attributes object
-
ID of current step
-
When the step started (ISO format in UTC)
-
completed string(date-time)
When the step completed (ISO format in UTC)
-
duration_in_millis integer(int64)
The duration of the step in MS
-
The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)
Values are
success
,warning
,error
, orpending
. -
Current stage that the step is in
Values are
starting
,completed
, orin_progress
. -
Human readable summaries of the step, including messages for each stage of the step
Hide info_log attributes Show info_log attributes object
-
Timestamp marking on info log of step
-
delta_in_millis integer(int64)
Time in milliseconds since previous log message
-
Stage that info log message takes place in
Values are
starting
,completed
, orin_progress
. -
Human readable log message
-
A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.
Hide details attribute Show details attribute object
-
internal_details object
A json object with sensitive details for the log, visible only to admins. May contain nested json objects.
Hide internal_details attribute Show internal_details attribute object
-
failure_type string
The failure type, in case the step failed
-
-
-
source object
Information describing the source that facilitated the plans current state
Additional properties are allowed.
Hide source attributes Show source attributes object
-
The service where the change originated from
-
The type of plan change that was initiated
-
The time the change was initiated
-
user_id string
The user that requested the change
-
admin_id string
The admin user that requested the change
-
remote_addresses array[string]
The host addresses of the user that originated the change
-
-
error object
Information about an error during a plan attempt.
Additional properties are allowed.
Hide error attributes Show error attributes object
-
Timestamp marking on info log of step
-
Human readable error message
-
A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively.
Hide details attribute Show details attribute object
-
failure_type string
The failure type
-
-
-
Hide history attributes Show history attributes object
-
plan_attempt_id string
A UUID for each plan attempt
-
plan_attempt_name string
A human readable name for each plan attempt, only populated when retrieving plan histories
-
Either the plan ended successfully, or is not yet completed (and no errors have occurred)
-
attempt_start_time string(date-time)
When this plan attempt (ie to apply the plan to the cluster) started (ISO format in UTC)
-
attempt_end_time string(date-time)
If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)
-
plan_end_time string(date-time)
If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)
-
plan object
The plan for building this Elasticsearch cluster
Additional properties are allowed.
Hide plan attributes Show plan attributes object
-
Hide cluster_topology attributes Show cluster_topology attributes object
-
id string
Unique identifier of this topology element
-
node_type object
Controls the combinations of Elasticsearch node types. TIP: By default, the Elasticsearch node is master eligible, can hold data, and run ingest pipelines. WARNING: Do not set for tiebreaker topologies.
Additional properties are allowed.
Hide node_type attributes Show node_type attributes object
-
master boolean
Defines whether this node can be elected master (default: false)
-
data boolean
Defines whether this node can hold data (default: false)
-
ingest boolean
Defines whether this node can run an ingest pipeline (default: false)
-
ml boolean
Defines whether this node can run ml jobs, valid only for versions 5.4.0 or greater (default: false)
-
-
node_roles array[string]
The list of node roles for this topology element (ES version >= 7.10). Allowable values are: master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, transform
Values are
master
,ingest
,ml
,data_hot
,data_content
,data_warm
,data_cold
,data_frozen
,remote_cluster_client
, ortransform
. -
memory_per_node integer(int32)
The memory capacity in MB for each node of this type built in each zone.
-
node_count_per_zone integer(int32)
The number of nodes of this type that are allocated within each zone. (i.e. total capacity per zone =
node_count_per_zone
*memory_per_node
in MB). Cannot be set for tiebreaker topologies. For dedicated master nodes, must be 1 if an entry exists. -
zone_count integer(int32)
The default number of zones in which data nodes will be placed
-
elasticsearch object
The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
Additional properties are allowed.
Hide elasticsearch attributes Show elasticsearch attributes object
-
version string
The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.
-
docker_image string
A docker URI that allows overriding of the default docker image specified for this version
-
system_settings object
A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use
ElasticsearchSystemSettings
withuser_settings_override*
anduser_settings*
.Additional properties are allowed.
Hide system_settings attributes Show system_settings attributes object
-
scripting object
Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.
Additional properties are allowed.
Hide scripting attributes Show scripting attributes object
-
painless_enabled boolean
(5.x+ only) If enabled (the default) then the painless scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.painless.[file|stored|inline]')
-
mustache_enabled boolean
(5.x+ only) If enabled (the default) then the mustache scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.mustache.[file|stored|inline]')
-
expressions_enabled boolean
(5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')
-
stored object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide stored attributes Show stored attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
file object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide file attributes Show file attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
inline object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide inline attributes Show inline attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
-
reindex_whitelist array[string]
Limits remote Elasticsearch clusters that can be used as the source for '_reindex' API commands
-
auto_create_index boolean
If true (the default), then any write operation on an index that does not currently exist will create it. NOTES: (Corresponds to the parameter 'action.auto_create_index')
-
enable_close_index boolean
Defaults to false on versions <= 7.2.0, true otherwise. If false, then the API commands to close indices are disabled. This is important because Elasticsearch does not snapshot or migrate close indices on versions under 7.2.0, therefore standard Elastic Cloud configuration operations will cause irretrievable loss of indices' data. NOTES: (Corresponds to the parameter 'cluster.indices.close.enable')
-
destructive_requires_name boolean
If true (default is false) then the index deletion API will not support wildcards or '_all'. NOTES: (Corresponds to the parameter 'action.destructive_requires_name')
-
watcher_trigger_engine string
The trigger engine for Watcher, defaults to 'scheduler' - see the xpack documentation for more information. NOTES: (Corresponds to the parameter '(xpack.)watcher.trigger.schedule.engine', depending on version. Ignored from 6.x onwards.)
-
default_shards_per_index integer(int32)
(2.x only - to get the same result in 5.x template mappings must be used) Sets the default number of shards per index, defaulting to 1 if not specified. (Corresponds to the parameter 'index.number_of_shards' in 2.x, not supported in 5.x)
-
monitoring_collection_interval integer(int32)
The default interval at which monitoring information from the cluster if collected, if monitoring is enabled. NOTES: (Corresponds to the parameter 'marvel.agent.interval' in 2.x and 'xpack.monitoring.collection.interval' in 5.x)
-
monitoring_history_duration string
The duration for which monitoring history is stored (format '(NUMBER)d' eg '3d' for 3 days). NOTES: ('Corresponds to the parameter xpack.monitoring.history.duration' in 5.x, defaults to '7d')
-
-
user_settings_json object
An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
Additional properties are allowed.
-
user_settings_yaml string
An arbitrary YAML object allowing cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
-
user_settings_override_json object
An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
Additional properties are allowed.
-
user_settings_override_yaml string
An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
-
enabled_built_in_plugins array[string]
A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)
-
user_plugins array[object]
A list of admin-uploaded plugin objects that are available for this user.
Hide user_plugins attributes Show user_plugins attributes object
-
The name of the plugin
-
The URL of the plugin (must be accessible from the ECE infrastructure)
-
The supported Elasticsearch version (must match the version in the plan)
-
-
user_bundles array[object]
A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.
Hide user_bundles attributes Show user_bundles attributes object
-
The name of the bundle
-
The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle
-
The supported Elasticsearch version (must match the version in the plan)
-
-
curation object
Defines the index curation routing for the cluster
Additional properties are allowed.
Hide curation attributes Show curation attributes object
-
The source instance configuration
-
The destination instance configuration
-
-
node_attributes object
Defines the Elasticsearch node attributes for the instances in the topology
Hide node_attributes attribute Show node_attributes attribute object
-
-
instance_configuration_id string
Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
-
instance_configuration_version integer(int32)
The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.
-
size object
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
Additional properties are allowed.
-
autoscaling_min object
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
Additional properties are allowed.
-
autoscaling_max object
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
Additional properties are allowed.
-
An arbitrary JSON object overriding the default autoscaling policy. Don't set unless you really know what you are doing.
Additional properties are allowed.
-
topology_element_control object
Controls for the topology element. Only used as part of the deployment template. Ignored if included as part of a deployment.
Additional properties are allowed.
Hide topology_element_control attribute Show topology_element_control attribute object
-
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
Additional properties are allowed.
-
-
autoscaling_tier_override boolean
Set to true to enable autoscaling for this topology element, even if the cluster-level 'autoscaling_enabled' field is false. Note that 'autoscaling_tier_override' cannot be set to false if cluster-level 'autoscaling_enabled' is true. Currently only supported for the 'ml' tier
-
-
The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
Additional properties are allowed.
Hide elasticsearch attributes Show elasticsearch attributes object
-
version string
The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.
-
docker_image string
A docker URI that allows overriding of the default docker image specified for this version
-
system_settings object
A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use
ElasticsearchSystemSettings
withuser_settings_override*
anduser_settings*
.Additional properties are allowed.
Hide system_settings attributes Show system_settings attributes object
-
scripting object
Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.
Additional properties are allowed.
Hide scripting attributes Show scripting attributes object
-
painless_enabled boolean
(5.x+ only) If enabled (the default) then the painless scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.painless.[file|stored|inline]')
-
mustache_enabled boolean
(5.x+ only) If enabled (the default) then the mustache scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.mustache.[file|stored|inline]')
-
expressions_enabled boolean
(5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')
-
stored object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide stored attributes Show stored attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
file object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide file attributes Show file attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
inline object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide inline attributes Show inline attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
-
reindex_whitelist array[string]
Limits remote Elasticsearch clusters that can be used as the source for '_reindex' API commands
-
auto_create_index boolean
If true (the default), then any write operation on an index that does not currently exist will create it. NOTES: (Corresponds to the parameter 'action.auto_create_index')
-
enable_close_index boolean
Defaults to false on versions <= 7.2.0, true otherwise. If false, then the API commands to close indices are disabled. This is important because Elasticsearch does not snapshot or migrate close indices on versions under 7.2.0, therefore standard Elastic Cloud configuration operations will cause irretrievable loss of indices' data. NOTES: (Corresponds to the parameter 'cluster.indices.close.enable')
-
destructive_requires_name boolean
If true (default is false) then the index deletion API will not support wildcards or '_all'. NOTES: (Corresponds to the parameter 'action.destructive_requires_name')
-
watcher_trigger_engine string
The trigger engine for Watcher, defaults to 'scheduler' - see the xpack documentation for more information. NOTES: (Corresponds to the parameter '(xpack.)watcher.trigger.schedule.engine', depending on version. Ignored from 6.x onwards.)
-
default_shards_per_index integer(int32)
(2.x only - to get the same result in 5.x template mappings must be used) Sets the default number of shards per index, defaulting to 1 if not specified. (Corresponds to the parameter 'index.number_of_shards' in 2.x, not supported in 5.x)
-
monitoring_collection_interval integer(int32)
The default interval at which monitoring information from the cluster if collected, if monitoring is enabled. NOTES: (Corresponds to the parameter 'marvel.agent.interval' in 2.x and 'xpack.monitoring.collection.interval' in 5.x)
-
monitoring_history_duration string
The duration for which monitoring history is stored (format '(NUMBER)d' eg '3d' for 3 days). NOTES: ('Corresponds to the parameter xpack.monitoring.history.duration' in 5.x, defaults to '7d')
-
-
user_settings_json object
An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
Additional properties are allowed.
-
user_settings_yaml string
An arbitrary YAML object allowing cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
-
user_settings_override_json object
An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
Additional properties are allowed.
-
user_settings_override_yaml string
An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
-
enabled_built_in_plugins array[string]
A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)
-
user_plugins array[object]
A list of admin-uploaded plugin objects that are available for this user.
Hide user_plugins attributes Show user_plugins attributes object
-
The name of the plugin
-
The URL of the plugin (must be accessible from the ECE infrastructure)
-
The supported Elasticsearch version (must match the version in the plan)
-
-
user_bundles array[object]
A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.
Hide user_bundles attributes Show user_bundles attributes object
-
The name of the bundle
-
The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle
-
The supported Elasticsearch version (must match the version in the plan)
-
-
curation object
Defines the index curation routing for the cluster
Additional properties are allowed.
Hide curation attributes Show curation attributes object
-
The source instance configuration
-
The destination instance configuration
-
-
node_attributes object
Defines the Elasticsearch node attributes for the instances in the topology
Hide node_attributes attribute Show node_attributes attribute object
-
-
deployment_template object
Documents which deployment template was used in the creation of this plan
Additional properties are allowed.
-
transient object
Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Elasticsearch settings.
Additional properties are allowed.
Hide transient attributes Show transient attributes object
-
strategy object
The options for performing a plan change. Specify only one property each time. The default is
grow_and_shrink
.Additional properties are allowed.
Hide strategy attributes Show strategy attributes object
-
rolling object
Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.
Additional properties are allowed.
Hide rolling attributes Show rolling attributes object
-
group_by string
Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade
-
allow_inline_resize boolean
Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing
-
skip_synced_flush boolean
Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy
-
shard_init_wait_time integer(int64)
The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
-
-
grow_and_shrink object
A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances.
GrowShrinkStrategyConfig
is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.Additional properties are allowed.
-
rolling_grow_and_shrink object
A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.
Additional properties are allowed.
-
autodetect object
A strategy that lets constructor choose the most optimal way to execute the plan.
Additional properties are allowed.
-
-
plan_configuration object
The configuration settings for the timeout and fallback parameters.
Additional properties are allowed.
Hide plan_configuration attributes Show plan_configuration attributes object
-
timeout integer(int64)
The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB). NOTES: A 3 zone cluster with 2 nodes of 2048 each would have a timeout of 4*2048=8192 seconds. Timeout does not include time required to run rollback actions.
-
calm_wait_time integer(int64)
This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
-
move_instances array[object]
Hide move_instances attributes Show move_instances attributes object
-
The instance id that is going to be moved
-
to array[string]
An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
-
instance_down boolean
Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)
-
-
move_allocators array[object]
Hide move_allocators attributes Show move_allocators attributes object
-
The allocator id off which all instances in the cluster should be moved
-
to array[string]
An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
-
allocator_down boolean
Tells the infrastructure that all instances on the allocator should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will auto-decide (currently: will treat the allocator as up)
-
-
move_only boolean
If true (default: false) only move_instances and move_allocators instructions will be executed, all other changes will be ignored
-
reallocate_instances boolean
If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created
-
preferred_allocators array[string]
List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)
-
preferred_allocator_tags object
Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators
Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
-
skip_snapshot boolean
If true (default: false), does not take (or require) a successful snapshot to be taken before performing any potentially destructive changes to this cluster
-
max_snapshot_attempts integer(int32)
If taking a snapshot (ie unless 'skip_snapshots': true) then will retry on failure at most this number of times (default: 5)
-
max_snapshot_age integer(int64)
When you take a snapshot and 'skip_snapshots' is false, specifies the maximum age in seconds of the most recent snapshot before a new snapshot is created. Default is 300
-
extended_maintenance boolean
If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
-
cluster_reboot string
Set to 'forced' to force a reboot as part of the upgrade plan. NOTES: (ie taking an existing plan and leaving it alone except for setting 'transient.plan_configuration.cluster_reboot': 'forced' will reboot the cluster)
Value is
forced
. -
override_failsafe boolean
If false (the default) then the plan will fail out if it believes the requested sequence of operations can result in data loss - this flag will override some of these restraints
-
skip_data_migration boolean
If true (default: false) then the plan will not wait for data to be migrated from old instances to new instances before continuing the plan (potentially deleting the old instances and losing data)
-
skip_upgrade_checker boolean
If false, the cluster is checked for issues that should be resolved before migration (eg contains old Lucene segments), if true this is bypassed
-
skip_post_upgrade_steps boolean
If false (the default), the cluster will run (currently) 2.x->5.x operations for any plan change ending with a 5.x cluster (eg apply a cluster license, ensure Monitoring is configured)
-
skip_snapshot_post_major_upgrade boolean
If false (the default), the cluster will perform a snapshot after a major version upgrade takes place
-
-
restore_snapshot object
Restores a snapshot from a local or remote repository.
Additional properties are allowed.
Hide restore_snapshot attributes Show restore_snapshot attributes object
-
repository_name string
If specified, contains the name of the snapshot repository - else will default to the Elastic Cloud system repo ('found-snapshots')
-
The name of the snapshot to restore. Use '__latest_success__' to get the most recent snapshot from the specified repository
-
repository_config object
Raw remote snapshot restore settings. Do not send this if you are sending source_cluster_id
Additional properties are allowed.
Hide repository_config attribute Show repository_config attribute object
-
raw_settings object
The remote snapshot settings raw JSON - see the Elasticsearch '_snapshot' documentation for more details on supported formats
Additional properties are allowed.
-
-
restore_payload object
The configuration for the restore command, such as which indices you want to restore.
Additional properties are allowed.
Hide restore_payload attributes Show restore_payload attributes object
-
indices array[string]
The list of indices to restore (supports +ve and -ve selection and wildcarding - see the default Elasticsearch index format documentation)
-
raw_settings object
This JSON object (merged with the 'indices' field (if present) is passed untouched into the restore command - see the Elasticsearch '_snapshot' documentation for more details on supported formats
Additional properties are allowed.
-
-
strategy string
The restore strategy to use. Defaults to a full restore. Partial restore will attempt to restore unavailable indices only
Values are
partial
,full
, orrecovery
. -
source_cluster_id string
If specified, contains the name of the source cluster id. Do not send this if you are sending repository_config
-
-
remote_clusters object
The list of resources that will be configured as remote clusters
Additional properties are allowed.
Hide remote_clusters attribute Show remote_clusters attribute object
-
The remote resources
Hide resources attributes Show resources attributes object
-
The id of the deployment
-
The locally-unique user-specified id of an Elasticsearch Resource
-
The alias for this remote cluster. Aliases must only contain letters, digits, dashes and underscores
-
skip_unavailable boolean
If true, skip this cluster during search if it is disconnected. Default: false
-
info object
Information about a Remote Cluster.
Additional properties are allowed.
Hide info attributes Show info attributes object
-
Whether or not the remote cluster is healthy
-
Whether or not there is at least one connection to the remote cluster.
-
Whether or not the remote cluster version is compatible with this cluster version.
-
Whether or not the remote cluster is trusted by this cluster.
-
Whether or not the remote cluster trusts this cluster back.
-
-
-
-
cluster_settings_json object
If specified, contains transient settings to be applied to an Elasticsearch cluster during changes,default values shown below applied. These can be overridden by specifying them in the map (or null to unset). Additional settings can also be set. Settings will be cleared after the plan has finished. If not specified, no settings will be applied. NOTE: These settings are only explicitly cleared for 5.x+ clusters, they must be hand-reset to their defaults in 2.x- (or a cluster reboot will clear them).
- indices.store.throttle.max_bytes_per_sec: 120Mb
- indices.recovery.max_bytes_per_sec: 120Mb
- cluster.routing.allocation.cluster_concurrent_rebalance: 5
- cluster.routing.allocation.node_initial_primaries_recoveries: 5
- cluster.routing.allocation.node_concurrent_incoming_recoveries: 5 For version 8.1 and later no defaults are provided through this mechanism, but instead hardware dependent settings are provided to each instance.
Additional properties are allowed.
-
-
autoscaling_enabled boolean
Enable autoscaling for this Elasticsearch cluster.
-
-
Hide plan_attempt_log attributes Show plan_attempt_log attributes object
-
ID of current step
-
When the step started (ISO format in UTC)
-
completed string(date-time)
When the step completed (ISO format in UTC)
-
duration_in_millis integer(int64)
The duration of the step in MS
-
The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)
Values are
success
,warning
,error
, orpending
. -
Current stage that the step is in
Values are
starting
,completed
, orin_progress
. -
Human readable summaries of the step, including messages for each stage of the step
Hide info_log attributes Show info_log attributes object
-
Timestamp marking on info log of step
-
delta_in_millis integer(int64)
Time in milliseconds since previous log message
-
-
-
-
-
-
-
-
-