kibana/docs/development/core/server/kibana-plugin-server.elasticsearchconfig.md

Home > kibana-plugin-server > ElasticsearchConfig

ElasticsearchConfig class

Wrapper of config schema.

Signature:

export declare class ElasticsearchConfig 

Constructors

Constructor	Modifiers	Description
(constructor)(rawConfig)		Constructs a new instance of the ElasticsearchConfig class

Properties

Property	Modifiers	Type	Description
apiVersion		string	Version of the Elasticsearch (6.7, 7.1 or master) client will be connecting to.
customHeaders		ElasticsearchConfigType['customHeaders']	Header names and values to send to Elasticsearch with every request. These headers cannot be overwritten by client-side headers and aren't affected by requestHeadersWhitelist configuration.
healthCheckDelay		Duration	The interval between health check requests Kibana sends to the Elasticsearch.
hosts		string[]	Hosts that the client will connect to. If sniffing is enabled, this list will be used as seeds to discover the rest of your cluster.
ignoreVersionMismatch		boolean	Whether to allow kibana to connect to a non-compatible elasticsearch node.
logQueries		boolean	Specifies whether all queries to the client should be logged (status code, method, query etc.).
password		string	If Elasticsearch is protected with basic authentication, this setting provides the password that the Kibana server uses to perform its administrative functions.
pingTimeout		Duration	Timeout after which PING HTTP request will be aborted and retried.
requestHeadersWhitelist		string[]	List of Kibana client-side headers to send to Elasticsearch when request scoped cluster client is used. If this is an empty array then *no* client-side will be sent.
requestTimeout		Duration	Timeout after which HTTP request will be aborted and retried.
shardTimeout		Duration	Timeout for Elasticsearch to wait for responses from shards. Set to 0 to disable.
sniffInterval		false | Duration	Interval to perform a sniff operation and make sure the list of nodes is complete. If false then sniffing is disabled.
sniffOnConnectionFault		boolean	Specifies whether the client should immediately sniff for a more current list of nodes when a connection dies.
sniffOnStart		boolean	Specifies whether the client should attempt to detect the rest of the cluster when it is first instantiated.
ssl		Pick<SslConfigSchema, Exclude<keyof SslConfigSchema, 'certificateAuthorities' | 'keystore' | 'truststore'>> & { certificateAuthorities?: string[]; }	Set of settings configure SSL connection between Kibana and Elasticsearch that are required when xpack.ssl.verification_mode in Elasticsearch is set to either certificate or full.
username		string	If Elasticsearch is protected with basic authentication, this setting provides the username that the Kibana server uses to perform its administrative functions.