ApmConfiguration

The configuration options for the APM Server.

Properties

docker_image (string)
A docker URI that allows overriding of the default docker image specified for this version
system_settings (ApmSystemSettings)
A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use ApmSystemSettings with user_settings_override_ and user_settings_.
user_settings_json (object)
An arbitrary JSON object allowing (non-admin) 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'). (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm 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'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm 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'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
user_settings_yaml (string)
An arbitrary YAML object allowing (non-admin) 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'). (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
version (string)
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.)

Example

{
   "docker_image" : "string",
   "system_settings" : {
      "debug_enabled" : true,
      "elasticsearch_password" : "string",
      "elasticsearch_url" : "string",
      "elasticsearch_username" : "string",
      "kibana_url" : "string",
      "secret_token" : "string"
   },
   "user_settings_json" : {},
   "user_settings_override_json" : {},
   "user_settings_override_yaml" : "string",
   "user_settings_yaml" : "string",
   "version" : "string"
}