Skip to main content

ElasticSearchElasticSearchClientOptions

Home > @backstage/plugin-search-backend-module-elasticsearch > ElasticSearchElasticSearchClientOptions

Options used to configure the @elastic/elasticsearch client.

They are drawn from the ClientOptions class of @elastic/elasticsearch, but are maintained separately so that this interface is not coupled to it.

Signature:

export interface ElasticSearchElasticSearchClientOptions extends BaseElasticSearchClientOptions 

Extends: BaseElasticSearchClientOptions

Properties

PropertyModifiersTypeDescription
auth?ElasticSearchAuth(Optional)
cloud?{ id: string; username?: string; password?: string; }(Optional)
Connection?ElasticSearchConnectionConstructor(Optional)
node?string | string[] | ElasticSearchNodeOptions | ElasticSearchNodeOptions[](Optional)
nodes?string | string[] | ElasticSearchNodeOptions | ElasticSearchNodeOptions[](Optional)
provider?'elastic'(Optional)