Update Deployment
https://api.elastic-cloud.com/api/v1
- PUT /deployments/{deployment_id}
Updates a Deployment.
Path Parameters
-
deployment_idstringrequired -
Identifier for the Deployment
Query Parameters
-
hide_pruned_orphansboolean · default: false Whether or not to hide orphaned resources that were shut down (relevant if prune on the request is true)
-
skip_snapshotboolean · default: false Whether or not to skip snapshots before shutting down orphaned resources (relevant if prune on the request is true)
-
validate_onlyboolean · default: false If true, will just validate the Deployment definition but will not perform the update
-
versionstring If specified then checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request)
Request
The deployment definition
-
namestring -
A new name for the deployment, otherwise stays the same.
-
prune_orphansbooleanrequired -
Whether or not to prune orphan resources that are no longer mentioned in this request. Note that resourcesare tracked by ref_id, and if a resource's ref_id is changed, any previous running resources created with that previousref_id are considered to be orphaned as well.
-
resourcesDeploymentUpdateResources -
Describes the Deployment resource updates
-
elasticsearchElasticsearchPayload -
A list of payloads for Elasticsearch cluster updates
-
ref_idstringrequired -
A locally-unique user-specified id for this Elasticsearch cluster
-
display_namestring -
The human readable name for the cluster (defaults to the generated cluster id if not specified)
-
regionstringrequired -
The region where this resource exists
-
planElasticsearchClusterPlanrequired -
The plan for the Elasticsearch cluster.
-
cluster_topologyElasticsearchClusterTopologyElementrequired -
idstring -
Unique identifier of this topology element
-
node_typeElasticsearchNodeType -
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.
-
masterboolean -
Defines whether this node can be elected master (default: false)
-
databoolean -
Defines whether this node can hold data (default: false)
-
ingestboolean -
Defines whether this node can run an ingest pipeline (default: false)
-
mlboolean -
Defines whether this node can run ml jobs, valid only for versions 5.4.0 or greater (default: false)
-
node_roles -
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:
masteringestmldata_hotdata_contentdata_warmdata_colddata_frozenremote_cluster_clienttransform -
zone_countinteger -
The default number of zones in which data nodes will be placed
-
elasticsearchElasticsearchConfiguration -
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.
-
versionstring -
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_imagestring -
A docker URI that allows overriding of the default docker image specified for this version
-
system_settingsElasticsearchSystemSettings -
A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use
ElasticsearchSystemSettingswithuser_settings_override*anduser_settings*. -
scriptingElasticsearchScriptingUserSettings -
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.
-
painless_enabledboolean -
(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_enabledboolean -
(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_enabledboolean -
(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]')
-
storedElasticsearchScriptTypeSettings -
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). -
enabledboolean -
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_modeboolean -
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]')
-
fileElasticsearchScriptTypeSettings -
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). -
enabledboolean -
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_modeboolean -
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]')
-
inlineElasticsearchScriptTypeSettings -
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). -
enabledboolean -
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_modeboolean -
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_whiteliststring -
Limits remote Elasticsearch clusters that can be used as the source for '_reindex' API commands
-
auto_create_indexboolean -
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_indexboolean -
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_nameboolean -
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_enginestring -
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_indexinteger -
(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_intervalinteger -
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_durationstring -
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_jsonobject -
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)
-
user_settings_yamlstring -
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_jsonobject -
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)
-
user_settings_override_yamlstring -
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_pluginsstring -
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_pluginsElasticsearchUserPlugin -
A list of admin-uploaded plugin objects that are available for this user.
-
namestringrequired -
The name of the plugin
-
urlstringrequired -
The URL of the plugin (must be accessible from the ECE infrastructure)
-
elasticsearch_versionstringrequired -
The supported Elasticsearch version (must match the version in the plan)
-
user_bundlesElasticsearchUserBundle -
A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.
-
namestringrequired -
The name of the bundle
-
urlstringrequired -
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
-
elasticsearch_versionstringrequired -
The supported Elasticsearch version (must match the version in the plan)
-
curationElasticsearchCuration -
The structure that defines the routing settings for index curation.
-
from_instance_configuration_idstringrequired -
The source instance configuration
-
to_instance_configuration_idstringrequired -
The destination instance configuration
-
node_attributesmap string to string -
Defines the Elasticsearch node attributes for the instances in the topology
-
instance_configuration_idstring -
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_versioninteger -
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'.
-
sizeTopologySize -
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
-
autoscaling_minTopologySize -
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
-
autoscaling_maxTopologySize -
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
-
autoscaling_policy_override_jsonobject -
An arbitrary JSON object overriding the default autoscaling policy. Don't set unless you really know what you are doing.
-
topology_element_controlTopologyElementControl -
Controls for the topology element. Only used as part of the deployment template. Ignored if included as part of a deployment.
-
minTopologySizerequired -
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
-
autoscaling_tier_overrideboolean -
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
-
elasticsearchElasticsearchConfigurationrequired -
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.
-
deployment_templateDeploymentTemplateReference -
Specifies the deployment template used to create the plan.
-
transientTransientElasticsearchPlanConfiguration -
Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Elasticsearch settings.
-
strategyPlanStrategy -
The options for performing a plan change. Specify only one property each time. The default is
grow_and_shrink. -
rollingRollingStrategyConfig -
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.
-
group_bystring -
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_resizeboolean -
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_flushboolean -
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_timeinteger -
The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
-
grow_and_shrinkGrowShrinkStrategyConfig -
A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances.
GrowShrinkStrategyConfigis safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters. -
rolling_grow_and_shrinkRollingGrowShrinkStrategyConfig -
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.
-
autodetectAutodetectStrategyConfig -
A strategy that lets constructor choose the most optimal way to execute the plan.
-
plan_configurationElasticsearchPlanControlConfiguration -
The configuration settings for the timeout and fallback parameters.
-
timeoutinteger -
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_timeinteger -
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
-
skip_snapshotboolean -
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_attemptsinteger -
If taking a snapshot (ie unless 'skip_snapshots': true) then will retry on failure at most this number of times (default: 5)
-
max_snapshot_ageinteger -
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_maintenanceboolean -
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 -
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)
-
Values:
forced -
restore_snapshotRestoreSnapshotConfiguration -
Restores a snapshot from a local or remote repository.
-
repository_namestring -
If specified, contains the name of the snapshot repository - else will default to the Elastic Cloud system repo ('found-snapshots')
-
snapshot_namestringrequired -
The name of the snapshot to restore. Use '__latest_success__' to get the most recent snapshot from the specified repository
-
repository_configRestoreSnapshotRepoConfiguration -
Configures the location of a remote repository. The default is the system repository.
-
raw_settingsobject -
The remote snapshot settings raw JSON - see the Elasticsearch '_snapshot' documentation for more details on supported formats
-
restore_payloadRestoreSnapshotApiConfiguration -
The configuration for the restore command, such as which indices you want to restore.
-
indicesstring -
The list of indices to restore (supports +ve and -ve selection and wildcarding - see the default Elasticsearch index format documentation)
-
raw_settingsobject -
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
-
strategy -
The restore strategy to use. Defaults to a full restore. Partial restore will attempt to restore unavailable indices only
-
Values:
partialfullrecovery -
source_cluster_idstring -
If specified, contains the name of the source cluster id. Do not send this if you are sending repository_config
-
snapshot_dependencySnapshotDependencyConfiguration -
Configuration for attaching a snapshot repository dependency from another cluster. This creates a snapshot repository in the target cluster pointing to the source cluster's snapshots.
-
source_cluster_idstringrequired -
The cluster ID of the source cluster whose snapshots will be made available
-
remote_clustersRemoteResources -
The list of resources used as remote clusters
-
resourcesRemoteResourceRefrequired -
The remote resources
-
deployment_idstringrequired -
The id of the deployment
-
elasticsearch_ref_idstringrequired -
The locally-unique user-specified id of an Elasticsearch Resource
-
aliasstringrequired -
The alias for this remote cluster. Aliases must only contain letters, digits, dashes and underscores
-
If true, skip this cluster during search if it is disconnected. Default: false
-
infoRemoteResourceInfo -
Information about a Remote Cluster.
-
healthybooleanrequired -
Whether or not the remote cluster is healthy
-
connectedbooleanrequired -
Whether or not there is at least one connection to the remote cluster.
-
compatiblebooleanrequired -
Whether or not the remote cluster version is compatible with this cluster version.
-
trustedbooleanrequired -
Whether or not the remote cluster is trusted by this cluster.
-
trusted_backbooleanrequired -
Whether or not the remote cluster trusts this cluster back.
-
cluster_settings_jsonobject -
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.
-
autoscaling_enabledboolean -
Enable autoscaling for this Elasticsearch cluster.
-
settingsElasticsearchClusterSettings -
The settings for an Elasticsearch cluster.
-
snapshotClusterSnapshotSettings -
The snapshot configuration settings for an Elasticsearch cluster.
-
intervalstring -
Interval between snapshots, with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute). Default is 30 minutes
-
retentionClusterSnapshotRetention -
Information about the Elasticsearch cluster snapshot retention.
-
slmboolean -
When set to true, the deployment will have SLM enabled. Default value is true.
-
cron_expressionstring -
Cron expression indicating when should snapshots be taken. This can be enabled only if SLM is enabled for the deployment and 'interval' is not present
-
monitoringManagedMonitoringSettings -
The settings for sending monitoring information to another cluster.
-
target_cluster_idstringrequired -
The Id of the target cluster to which to send monitoring information
-
metadataClusterMetadataSettings -
The top-level configuration settings for the Elasticsearch cluster.
-
namestring -
The display name of the cluster
-
curationClusterCurationSettings -
The index curation settings for an Elasticsearch cluster.
-
specsClusterCurationSpecrequired -
Specifications for curation
-
index_patternstringrequired -
Index matching pattern
-
trigger_interval_secondsintegerrequired -
Number of seconds after index creation to trigger this spec
-
dedicated_masters_thresholdinteger -
Threshold starting from which the number of instances in the cluster results in the introduction of dedicated masters. If the cluster is downscaled to a number of nodes below this one, dedicated masters will be removed. Limit is inclusive. When provided the threshold setting is updated. A
nullvalue removes the field. Otherwise, the setting remains as it was set previously. -
traffic_filterTrafficFilterSettings -
The configuration settings for the traffic filter.
-
rulesetsstringrequired -
IDs of the traffic filter rulesets
-
trustElasticsearchClusterTrustSettings -
Configuration of trust with other clusters.
-
accountsAccountTrustRelationship -
The list of trust relationships with different accounts
-
account_idstringrequired -
the ID of the Account
-
namestring -
A human readable name of the trust relationship
-
trust_allbooleanrequired -
If true, all clusters in this account will by default be trusted and the
trust_allowlistis ignored. -
trust_allowliststring -
The list of clusters to trust. Only used when
trust_allis false. -
externalExternalTrustRelationship -
The list of trust relationships with external entities
-
trust_relationship_idstringrequired -
The ID of the external trust relationship
-
namestring -
The name of the external trust relationship. Retrieved from the TrustRelationship and ignored on write.
-
trust_allbooleanrequired -
If true, all clusters in this external entity will be trusted and the
trust_allowlistis ignored. -
trust_allowliststring -
The list of clusters to trust. Only used when
trust_allis false. -
directDirectTrustRelationship -
The list of trust relationships where the certificate is bundled with the trust setting. Allows configuring trust for clusters running outside of an Elastic Cloud managed environment or in an Elastic Cloud environment without an environment level trust established.
-
uidstring -
Auto generated identifier for this trust, allows distinguishing between update vs remove and add.
-
namestringrequired -
a human readable name of the trust relationship
-
type -
The type can either be ESS, ECE, generic or proxy. If none is specified, then generic is assumed. If proxy is specified, trust_all should be false and trust_allowlist, scope_id and additional_node_names should be omitted.
-
Values:
ECEESSgenericproxy -
trust_allbooleanrequired -
If true, scope_id is required and the
trust_allowlistis ignored and all clusters matching the scope id will be trusted. -
trust_allowliststring -
The list of clusters with matching scope to trust. Only used when
trust_allis false. Providing one or more clusters makes scope_id mandatory. -
scope_idstring -
A lowercase alphanumerical string of max 32 characters. Usually an organization id or an environment id, but could really be any suitable suffix for clusters using the CA certificate of this trust. Required unless trust_all is false and trust_allowlist is empty.
-
additional_node_namesstring -
A list of node names trusted in addition to those deducible from trust_allowlist and scope id. Allows trusting nodes that don't have a scoped name at the cost of maintaining the list. Mandatory if scope id is not defined. Wildcards are not allowed.
-
certificatesTrustedCertificaterequired -
The public ca certificate(s) to trust. Only one is required, but it is possible to specify multiple certificates in order to facilitate key rotation.
-
pemstringrequired -
The public ca certificate as string in PEM format.
-
metadataCertificateMetaData -
The certificate MetaData
-
fingerprintstringrequired -
The fingerprint of the certificate
-
valid_tostringrequired -
The expiry date of the certificate in UTC
-
valid_fromstringrequired -
The valid from date of the certificate in UTC
-
also_trusted_bystring -
Other deployments also trusting this certificate
-
keystore_contentsKeystoreContents -
The contents of the Elasticsearch keystore.
-
secretsmap string to KeystoreSecretrequired -
List of secrets
-
<string>KeystoreSecret -
valueobject -
Value of this setting. This can either be a string or a JSON object that is stored as a JSON string in the keystore. NOTE: When the keystore secret is unspecified, it is removed.
-
as_fileboolean -
Stores the keystore secret as a file. The default is false, which stores the keystore secret as string when value is a plain string, or true when value is an object.
-
is_allowlistedboolean -
Read-only field, ignored on write. Only returned when calling the set-deployment-es-resource-keystore endpoint with
validate_only=true. True if this setting/value pair is allowlisted (the allowlist is for informational purposes). -
is_reloadableboolean -
Read-only field, ignored on write. Only returned when calling the set-deployment-es-resource-keystore endpoint with
validate_only=true. True if this setting is reloadable, or if false it requires a cluster restart. -
kibanaKibanaPayload -
A list of payloads for Kibana updates
-
ref_idstringrequired -
A locally-unique user-specified id for Kibana
-
elasticsearch_cluster_ref_idstringrequired -
Alias to the Elasticsearch Cluster to attach Kibana to
-
display_namestring -
The human readable name for the Kibana cluster (default: takes the name of its Elasticsearch cluster)
-
regionstringrequired -
The region where this resource exists
-
planKibanaClusterPlanrequired -
The plan for the Kibana instance.
-
cluster_topologyKibanaClusterTopologyElement -
instance_configuration_idstring -
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_versioninteger -
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'.
-
sizeTopologySize -
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
-
zone_countinteger -
number of zones in which nodes will be placed
-
kibanaKibanaConfiguration -
The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
-
versionstring -
The version of the Kibana cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)
-
docker_imagestring -
A docker URI that allows overriding of the default docker image specified for this version
-
system_settingsKibanaSystemSettings -
A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use
KibanaSystemSettingswithuser_settings_override_anduser_settings_. -
elasticsearch_usernamestring -
Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
-
elasticsearch_passwordstring -
Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
-
user_settings_jsonobject -
An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)
-
user_settings_yamlstring -
An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)
-
user_settings_override_jsonobject -
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'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)
-
user_settings_override_yamlstring -
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'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)
-
kibanaKibanaConfigurationrequired -
The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
-
versionstring -
The version of the Kibana cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)
-
docker_imagestring -
A docker URI that allows overriding of the default docker image specified for this version
-
system_settingsKibanaSystemSettings -
A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use
KibanaSystemSettingswithuser_settings_override_anduser_settings_. -
elasticsearch_usernamestring -
Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
-
elasticsearch_passwordstring -
Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
-
user_settings_jsonobject -
An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)
-
user_settings_yamlstring -
An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)
-
user_settings_override_jsonobject -
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'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)
-
user_settings_override_yamlstring -
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'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)
-
transientTransientKibanaPlanConfiguration -
Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Kibana instance settings.
-
strategyPlanStrategy -
The options for performing a plan change. Specify only one property each time. The default is
grow_and_shrink. -
rollingRollingStrategyConfig -
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.
-
group_bystring -
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_resizeboolean -
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_flushboolean -
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_timeinteger -
The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
-
grow_and_shrinkGrowShrinkStrategyConfig -
A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances.
GrowShrinkStrategyConfigis safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters. -
rolling_grow_and_shrinkRollingGrowShrinkStrategyConfig -
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.
-
autodetectAutodetectStrategyConfig -
A strategy that lets constructor choose the most optimal way to execute the plan.
-
plan_configurationKibanaPlanControlConfiguration -
The configuration settings for the timeout and fallback parameters.
-
timeoutinteger -
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)
-
calm_wait_timeinteger -
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
-
extended_maintenanceboolean -
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
-
apmApmPayload -
A list of payloads for APM updates
-
ref_idstringrequired -
A locally-unique user-specified id for APM
-
elasticsearch_cluster_ref_idstringrequired -
Alias to the Elasticsearch Cluster to attach APM to
-
display_namestring -
The human readable name for the APM cluster (default: takes the name of its Elasticsearch cluster)
-
regionstringrequired -
The region where this resource exists
-
planApmPlanrequired -
The plan for the APM Server.
-
cluster_topologyApmTopologyElement -
instance_configuration_idstring -
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_versioninteger -
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'.
-
sizeTopologySize -
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
-
zone_countinteger -
number of zones in which nodes will be placed
-
apmApmConfiguration -
The configuration options for the APM Server.
-
versionstring -
The version of the Apm cluster (must be one of the ECE supported versions, and won't work unless it matches the APM version. Leave blank to auto-detect version.)
-
docker_imagestring -
A docker URI that allows overriding of the default docker image specified for this version
-
system_settingsApmSystemSettings -
A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use
ApmSystemSettingswithuser_settings_override_anduser_settings_. -
elasticsearch_usernamestring -
Optionally override the account within APM - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
-
elasticsearch_passwordstring -
Optionally override the account within APM - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
-
secret_tokenstring -
Optionally override the secret token within APM - defaults to the previously existing secretToken
-
debug_enabledboolean -
Optionally enable debug mode for APM servers - defaults false
-
user_settings_jsonobject -
An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
-
user_settings_yamlstring -
An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
-
user_settings_override_jsonobject -
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'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
-
user_settings_override_yamlstring -
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'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
-
apmApmConfigurationrequired -
The configuration options for the APM Server.
-
transientTransientApmPlanConfiguration -
Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and APM Server settings.
-
strategyPlanStrategy -
The options for performing a plan change. Specify only one property each time. The default is
grow_and_shrink. -
rollingRollingStrategyConfig -
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.
-
group_bystring -
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_resizeboolean -
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_flushboolean -
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_timeinteger -
The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
-
grow_and_shrinkGrowShrinkStrategyConfig -
A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances.
GrowShrinkStrategyConfigis safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters. -
rolling_grow_and_shrinkRollingGrowShrinkStrategyConfig -
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.
-
autodetectAutodetectStrategyConfig -
A strategy that lets constructor choose the most optimal way to execute the plan.
-
plan_configurationApmPlanControlConfiguration -
The plan control configuration options for the APM Server.
-
timeoutinteger -
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)
-
calm_wait_timeinteger -
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
-
extended_maintenanceboolean -
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
-
appsearchAppSearchPayload -
A list of payloads for AppSearch updates. AppSearch has been replaced by Enterprise Search in the Elastic Stack 7.7 and higher
-
ref_idstringrequired -
A locally-unique user-specified id for AppSearch
-
elasticsearch_cluster_ref_idstringrequired -
Alias to the Elasticsearch Cluster to attach AppSearch to
-
display_namestring -
The human readable name for the AppSearch cluster (default: takes the name of its Elasticsearch cluster)
-
regionstringrequired -
The region where this resource exists
-
planAppSearchPlanrequired -
The plan for the App Search cluster.
-
cluster_topologyAppSearchTopologyElement -
node_typeAppSearchNodeTypes -
Node types to enable for an AppSearch instance
-
instance_configuration_idstring -
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_versioninteger -
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'.
-
sizeTopologySize -
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
-
zone_countinteger -
number of zones in which nodes will be placed
-
appsearchAppSearchConfiguration -
versionstring -
The version of the AppSearch cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)
-
docker_imagestring -
A docker URI that allows overriding of the default docker image specified for this version
-
system_settingsAppSearchSystemSettings -
This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of AppSearch settings)
-
elasticsearch_urlstring -
Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
-
elasticsearch_usernamestring -
Optionally override the account within App Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
-
elasticsearch_passwordstring -
Optionally override the account within App Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
-
secret_session_keystring -
Optionally override the secret session key within App Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.
-
user_settings_jsonobject -
An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)
-
user_settings_yamlstring -
An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)
-
user_settings_override_jsonobject -
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'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)
-
user_settings_override_yamlstring -
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'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)
-
appsearchAppSearchConfigurationrequired -
transientTransientAppSearchPlanConfiguration -
Defines configuration parameters that control how the plan (ie consisting of the cluster topology and AppSearch settings) is applied
-
strategyPlanStrategy -
The options for performing a plan change. Specify only one property each time. The default is
grow_and_shrink. -
rollingRollingStrategyConfig -
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.
-
group_bystring -
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_resizeboolean -
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_flushboolean -
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_timeinteger -
The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
-
grow_and_shrinkGrowShrinkStrategyConfig -
A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances.
GrowShrinkStrategyConfigis safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters. -
rolling_grow_and_shrinkRollingGrowShrinkStrategyConfig -
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.
-
autodetectAutodetectStrategyConfig -
A strategy that lets constructor choose the most optimal way to execute the plan.
-
plan_configurationAppSearchPlanControlConfiguration -
timeoutinteger -
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)
-
calm_wait_timeinteger -
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_instancesInstanceMoveRequest -
fromstringrequired -
The instance id that is going to be moved
-
tostring -
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_downboolean -
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_allocatorsAllocatorMoveRequest -
fromstringrequired -
The allocator id off which all instances in the cluster should be moved
-
tostring -
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_downboolean -
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)
-
reallocate_instancesboolean -
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_allocatorsstring -
List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)
-
extended_maintenanceboolean -
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
-
enterprise_searchEnterpriseSearchPayload -
A list of payloads for Enterprise Search updates
-
ref_idstringrequired -
A locally-unique user-specified id for Enterprise Search
-
elasticsearch_cluster_ref_idstringrequired -
Alias to the Elasticsearch Cluster to attach Enterprise Search to
-
display_namestring -
The human readable name for the Enterprise Search cluster (default: takes the name of its Elasticsearch cluster)
-
regionstringrequired -
The region where this resource exists
-
planEnterpriseSearchPlanrequired -
The plan for the Enterprise Search cluster.
-
cluster_topologyEnterpriseSearchTopologyElement -
node_typeEnterpriseSearchNodeTypes -
Node types to enable for an Enterprise Search instance
-
instance_configuration_idstring -
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_versioninteger -
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'.
-
sizeTopologySize -
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
-
zone_countinteger -
number of zones in which nodes will be placed
-
enterprise_searchEnterpriseSearchConfiguration -
versionstring -
The version of the Enterprise Search cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)
-
docker_imagestring -
A docker URI that allows overriding of the default docker image specified for this version
-
system_settingsEnterpriseSearchSystemSettings -
This structure defines a curated subset of the Enterprise Search settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of Enterprise Search settings)
-
elasticsearch_usernamestring -
Optionally override the account within Enterprise Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
-
elasticsearch_passwordstring -
Optionally override the account within Enterprise Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
-
secret_session_keystring -
Optionally override the secret session key within Enterprise Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.
-
user_settings_jsonobject -
An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Enterprise Search settings)
-
user_settings_yamlstring -
An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Enterprise Search settings)
-
user_settings_override_jsonobject -
An arbitrary JSON object allowing ECE admins to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), i.e. in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Enterprise Search settings)
-
user_settings_override_yamlstring -
An arbitrary YAML object allowing ECE admins to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), i.e. in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Enterprise Search settings)
-
allocator_filterobject -
node_configurationstring -
memory_per_nodeobject -
node_count_per_zoneobject -
enterprise_searchEnterpriseSearchConfigurationrequired -
transientTransientEnterpriseSearchPlanConfiguration -
Defines configuration parameters that control how the plan (i.e. consisting of the cluster topology and Enterprise Search settings) is applied
-
strategyPlanStrategy -
The options for performing a plan change. Specify only one property each time. The default is
grow_and_shrink. -
rollingRollingStrategyConfig -
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.
-
group_bystring -
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_resizeboolean -
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_flushboolean -
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_timeinteger -
The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
-
grow_and_shrinkGrowShrinkStrategyConfig -
A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances.
GrowShrinkStrategyConfigis safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters. -
rolling_grow_and_shrinkRollingGrowShrinkStrategyConfig -
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.
-
autodetectAutodetectStrategyConfig -
A strategy that lets constructor choose the most optimal way to execute the plan.
-
plan_configurationEnterpriseSearchPlanControlConfiguration -
timeoutinteger -
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)
-
calm_wait_timeinteger -
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_instancesInstanceMoveRequest -
fromstringrequired -
The instance id that is going to be moved
-
tostring -
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_downboolean -
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_allocatorsAllocatorMoveRequest -
fromstringrequired -
The allocator id off which all instances in the cluster should be moved
-
tostring -
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_downboolean -
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)
-
reallocate_instancesboolean -
If true (default: false) does not allow re-using any existing instances currently in the cluster, i.e. even unchanged instances will be re-created
-
preferred_allocatorsstring -
List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)
-
extended_maintenanceboolean -
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
-
integrations_serverIntegrationsServerPayload -
A list of payloads for Integrations Server updates
-
ref_idstringrequired -
A locally-unique user-specified id for the Integrations Server
-
elasticsearch_cluster_ref_idstringrequired -
Alias to the Elasticsearch Cluster to attach the Integrations Server to
-
display_namestring -
The human readable name for the Integrations Server cluster (default: takes the name of its Elasticsearch cluster)
-
regionstringrequired -
The region where this resource exists
-
planIntegrationsServerPlanrequired -
The plan for the Integrations Server.
-
cluster_topologyIntegrationsServerTopologyElement -
instance_configuration_idstring -
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_versioninteger -
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'.
-
sizeTopologySize -
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
-
zone_countinteger -
number of zones in which nodes will be placed
-
integrations_serverIntegrationsServerConfiguration -
The configuration options for the Integrations Server.
-
versionstring -
The version of the Integrations Server cluster (must be one of the ECE supported versions, and won't work unless it matches the Integrations Server version. Leave blank to auto-detect version.)
-
docker_imagestring -
A docker URI that allows overriding of the default docker image specified for this version
-
system_settingsIntegrationsServerSystemSettings -
A structure that defines a curated subset of the Integrations Server settings. TIP: To define the complete set of Integrations Server setting, use
IntegrationsSystemSettingswithuser_settings_override_anduser_settings_. -
elasticsearch_usernamestring -
Optionally override the account within Integrations Server - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
-
elasticsearch_passwordstring -
Optionally override the account within Integrations Server - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
-
secret_tokenstring -
Optionally override the secret token within Integrations Server - defaults to the previously existing secretToken
-
debug_enabledboolean -
Optionally enable debug mode for Integrations Server - defaults false
-
user_settings_jsonobject -
An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Integrations Server settings)
-
user_settings_yamlstring -
An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Integrations Server settings)
-
user_settings_override_jsonobject -
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'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings)
-
user_settings_override_yamlstring -
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'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings)
-
integrations_serverIntegrationsServerConfigurationrequired -
The configuration options for the Integrations Server.
-
transientTransientIntegrationsServerPlanConfiguration -
Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Integrations Server settings.
-
strategyPlanStrategy -
The options for performing a plan change. Specify only one property each time. The default is
grow_and_shrink. -
rollingRollingStrategyConfig -
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.
-
group_bystring -
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_resizeboolean -
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_flushboolean -
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_timeinteger -
The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
-
grow_and_shrinkGrowShrinkStrategyConfig -
A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances.
GrowShrinkStrategyConfigis safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters. -
rolling_grow_and_shrinkRollingGrowShrinkStrategyConfig -
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.
-
autodetectAutodetectStrategyConfig -
A strategy that lets constructor choose the most optimal way to execute the plan.
-
plan_configurationIntegrationsServerPlanControlConfiguration -
The plan control configuration options for the Integrations Server.
-
timeoutinteger -
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)
-
calm_wait_timeinteger -
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
-
extended_maintenanceboolean -
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
-
settingsDeploymentUpdateSettings -
Additional configuration for the new deployment object.
-
observabilityDeploymentObservabilitySettings -
The observability settings for a deployment
-
loggingDeploymentLoggingSettings -
The logging settings for a deployment
-
destinationObservabilityAbsoluteDeploymentrequired -
The destination to send logs and metrics to
-
deployment_idstringrequired -
The deployment to send logs and/or metrics to. Contains either the deployment's ID or 'self'.
-
ref_idstring -
RefId of the Elasticsearch cluster to send logs and/or metrics to. If not specified, refId is resolved automatically as long as the destination deployment contains a single Elasticsearch resource.
-
metricsDeploymentMetricsSettings -
The metrics settings for a deployment
-
destinationObservabilityAbsoluteDeploymentrequired -
The destination to send logs and metrics to
-
deployment_idstringrequired -
The deployment to send logs and/or metrics to. Contains either the deployment's ID or 'self'.
-
ref_idstring -
RefId of the Elasticsearch cluster to send logs and/or metrics to. If not specified, refId is resolved automatically as long as the destination deployment contains a single Elasticsearch resource.
-
autoscaling_enabledboolean -
Enable autoscaling for this deployment.
-
metadataDeploymentUpdateMetadata -
Additional information about the current deployment object.
-
Arbitrary user-defined metadata associated with this deployment
-
The metadata field name
-
The metadata value
-
aliasstring -
A user-defined alias to use in place of Cluster IDs for user-friendly URLs
Responses
The request was valid and the deployment was updated.
-
idstringrequired -
The id of the deployment
-
namestringrequired -
The name of the deployment
-
aliasstring -
A user-defined alias to use in place of ResourceIds for user-friendly resource URLs
-
resourcesDeploymentResourcerequired -
List of resources that are part of the deployment after the update operation.
-
ref_idstringrequired -
A locally-unique friendly alias for this Elasticsearch cluster
-
elasticsearch_cluster_ref_idstring -
The Elasticsearch cluster that this resource depends on.
-
idstringrequired -
A system-unique id for the created resource
-
kindstringrequired -
The kind of resource
-
regionstringrequired -
Identifier of the region in which this resource runs.
-
cloud_idstring -
An encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana
-
credentialsClusterCredentials -
The username and password for the new Elasticsearch cluster, which is returned from the Elasticsearch cluster
createcommand. -
secret_tokenstring -
Secret token for using a created resource. Only provided on initial create and absent otherwise.
-
shutdown_resourcesOrphaned -
Details about orphaned resources.
-
elasticsearchOrphanedElasticsearchrequired -
List of orphaned Elasticsearch resources
-
idstringrequired -
The id of the orphaned resource
-
dependentsElasticsearchDependantrequired -
List of orphaned dependent resources
-
kibanastringrequired -
List of orphaned Kibana resource ids
-
apmstringrequired -
List of orphaned APM resource ids
-
appsearchstringrequired -
List of orphaned AppSearch resource ids
-
enterprise_searchstringrequired -
List of orphaned Enterprise Search resource ids
-
integrations_serverstringrequired -
List of orphaned Integrations Server resource ids
-
diagnosticsDeploymentDiagnostics -
Describes the diagnostics for a given Deployment-modifying payload
-
createsCreates -
Holds diagnostics for resources that will be created
-
elasticsearchElasticsearch -
Diagnostics for Elasticsearch clusters
-
ref_idstringrequired -
A locally-unique user-specified id
-
display_namestringrequired -
The human readable name for the cluster (defaults to the generated cluster id if not specified)
-
backend_planobjectrequired -
The backend plan as JSON
-
kibanaKibana -
Diagnostics for Kibanas
-
ref_idstringrequired -
A locally-unique user-specified id
-
display_namestringrequired -
The human readable name (defaults to the generated cluster id if not specified)
-
elasticsearch_cluster_ref_idstringrequired -
The user-specified id of the Elasticsearch Cluster that this will link to
-
backend_planobjectrequired -
The backend plan as JSON
-
apmApm -
Diagnostics for APMs
-
ref_idstringrequired -
A locally-unique user-specified id
-
display_namestringrequired -
The human readable name (defaults to the generated cluster id if not specified)
-
elasticsearch_cluster_ref_idstringrequired -
The user-specified id of the Elasticsearch Cluster that this will link to
-
backend_planobjectrequired -
The backend plan as JSON
-
integrations_serverIntegrationsServer -
Diagnostics for Integrations Server
-
ref_idstringrequired -
A locally-unique user-specified id
-
display_namestringrequired -
The human readable name (defaults to the generated cluster id if not specified)
-
elasticsearch_cluster_ref_idstringrequired -
The user-specified id of the Elasticsearch Cluster that this will link to
-
backend_planobjectrequired -
The backend plan as JSON
-
appsearchAppSearch -
Diagnostics for AppSearches
-
ref_idstringrequired -
A locally-unique user-specified id
-
display_namestringrequired -
The human readable name (defaults to the generated cluster id if not specified)
-
elasticsearch_cluster_ref_idstringrequired -
The user-specified id of the Elasticsearch Cluster that this will link to
-
backend_planobjectrequired -
The backend plan as JSON
-
enterprise_searchEnterpriseSearch -
Diagnostics for Enterprise Search resources
-
ref_idstringrequired -
A locally-unique user-specified id
-
display_namestringrequired -
The human readable name (defaults to the generated cluster id if not specified)
-
elasticsearch_cluster_ref_idstringrequired -
The user-specified id of the Elasticsearch Cluster that this will link to
-
backend_planobjectrequired -
The backend plan as JSON
-
updatesUpdates -
Holds diagnostics for existing resources that might be updated
-
elasticsearchElasticsearch -
Diagnostics for Elasticsearch clusters
-
ref_idstringrequired -
A locally-unique user-specified id
-
display_namestringrequired -
The human readable name for the cluster (defaults to the generated cluster id if not specified)
-
backend_planobjectrequired -
The backend plan as JSON
-
kibanaKibana -
Diagnostics for Kibanas
-
ref_idstringrequired -
A locally-unique user-specified id
-
display_namestringrequired -
The human readable name (defaults to the generated cluster id if not specified)
-
elasticsearch_cluster_ref_idstringrequired -
The user-specified id of the Elasticsearch Cluster that this will link to
-
backend_planobjectrequired -
The backend plan as JSON
-
apmApm -
Diagnostics for APMs
-
ref_idstringrequired -
A locally-unique user-specified id
-
display_namestringrequired -
The human readable name (defaults to the generated cluster id if not specified)
-
elasticsearch_cluster_ref_idstringrequired -
The user-specified id of the Elasticsearch Cluster that this will link to
-
backend_planobjectrequired -
The backend plan as JSON
-
integrations_serverIntegrationsServer -
Diagnostics for Integrations Server
-
ref_idstringrequired -
A locally-unique user-specified id
-
display_namestringrequired -
The human readable name (defaults to the generated cluster id if not specified)
-
elasticsearch_cluster_ref_idstringrequired -
The user-specified id of the Elasticsearch Cluster that this will link to
-
backend_planobjectrequired -
The backend plan as JSON
-
appsearchAppSearch -
Diagnostics for AppSearches
-
ref_idstringrequired -
A locally-unique user-specified id
-
display_namestringrequired -
The human readable name (defaults to the generated cluster id if not specified)
-
elasticsearch_cluster_ref_idstringrequired -
The user-specified id of the Elasticsearch Cluster that this will link to
-
backend_planobjectrequired -
The backend plan as JSON
-
enterprise_searchEnterpriseSearch -
Diagnostics for Enterprise Search resources
-
ref_idstringrequired -
A locally-unique user-specified id
-
display_namestringrequired -
The human readable name (defaults to the generated cluster id if not specified)
-
elasticsearch_cluster_ref_idstringrequired -
The user-specified id of the Elasticsearch Cluster that this will link to
-
backend_planobjectrequired -
The backend plan as JSON
-
settingsDeploymentSettings -
Additional configuration about the current deployment object.
-
traffic_filter_settingsTrafficFilterSettings -
The configuration settings for the traffic filter.
-
rulesetsstringrequired -
IDs of the traffic filter rulesets
-
observabilityDeploymentObservabilitySettings -
The observability settings for a deployment
-
loggingDeploymentLoggingSettings -
The logging settings for a deployment
-
destinationObservabilityAbsoluteDeploymentrequired -
The destination to send logs and metrics to
-
deployment_idstringrequired -
The deployment to send logs and/or metrics to. Contains either the deployment's ID or 'self'.
-
ref_idstring -
RefId of the Elasticsearch cluster to send logs and/or metrics to. If not specified, refId is resolved automatically as long as the destination deployment contains a single Elasticsearch resource.
-
metricsDeploymentMetricsSettings -
The metrics settings for a deployment
-
destinationObservabilityAbsoluteDeploymentrequired -
The destination to send logs and metrics to
-
deployment_idstringrequired -
The deployment to send logs and/or metrics to. Contains either the deployment's ID or 'self'.
-
ref_idstring -
RefId of the Elasticsearch cluster to send logs and/or metrics to. If not specified, refId is resolved automatically as long as the destination deployment contains a single Elasticsearch resource.
-
autoscaling_enabledboolean -
If autoscaling is enabled for this deployment.
-
auto_opsAutoOpsSettingsrequired -
AutoOps settings for this deployment.
-
status -
See AutoOps integration status for this deployment.
-
Values:
connectednot_connectedexcluded -
byokByokSettings -
Information required to create a Bring Your Own Key (BYOK) deployment.
-
key_resource_pathstringrequired -
Key path (i.e arn:aws:kms:us-east-1:1234567890:key/12345678-0000-0000-0000-000000000000).
-
solution_typestring -
An optional string that declares the deployment's expected application. Example supported values are: elasticsearch, observability, security.
Response Headers
-
x-cloud-resource-versionstring The resource version, which is used to avoid update conflicts with concurrent operations
-
x-cloud-resource-createdstring The date-time when the resource was created (ISO format relative to UTC)
-
x-cloud-resource-last-modifiedstring The date-time when the resource was last modified (ISO format relative to UTC)
The deployment request had errors.
-
errorsBasicFailedReplyElementrequired -
A list of errors that occurred in the failing request
You are not authorized to perform this action.
-
errorsBasicFailedReplyElementrequired -
A list of errors that occurred in the failing request
The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)
-
errorsBasicFailedReplyElementrequired -
A list of errors that occurred in the failing request
Response Headers
-
x-cloud-error-codes The error codes associated with the response