OpenSearchElasticSearchClientOptions

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

Options used to configure the @opensearch-project/opensearch client.

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

Signature:

export interface OpenSearchElasticSearchClientOptions extends BaseElasticSearchClientOptions 

Extends: BaseElasticSearchClientOptions

Properties

Property	Modifiers	Type	Description
auth?		OpenSearchAuth	(Optional)
connection?		OpenSearchConnectionConstructor	(Optional)
node?		string | string[] | OpenSearchNodeOptions | OpenSearchNodeOptions[]	(Optional)
nodes?		string | string[] | OpenSearchNodeOptions | OpenSearchNodeOptions[]	(Optional)
provider?		'aws' | 'opensearch'	(Optional)
region?		string	(Optional)
service?		'es' | 'aoss'	(Optional)