Properties

edit
docker_image (string)
A docker URI that allows overriding of the default docker image specified for this version
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)
system_settings (ElasticsearchSystemSettings)
This structure defines a curated subset of the Elasticsearch settings that are of particular relevance to ECE. (This field together with 'user_settings_override_' and 'user_settings_' defines the total set of Elasticsearch settings)
user_bundles (array[ElasticsearchUserBundle])
A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user. NOTES: Not yet supported in ECE, SaaS only
user_plugins (array[ElasticsearchUserPlugin])
A list of admin-uploaded plugin objects that are available for this user. NOTES: Not yet supported in ECE, SaaS only
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 they are on the whitelist ('user_settings_whitelist') and not on the blacklist ('user_settings_blacklist'). 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)
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)
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 they are on the whitelist ('user_settings_whitelist') and not on the blacklist ('user_settings_blacklist'). NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
version (string, required)
The version of the Elasticsearch cluster (must be one of the ECE supported versions)