Opensearch dashboards.opensearchclientconfig

Home > opensearch-dashboards > OpenSearchClientConfig

OpenSearchClientConfig type

Configuration options to be used to create a cluster client using the createClient API

Signature:

export declare type OpenSearchClientConfig = Pick<OpenSearchConfig, 'customHeaders' | 'logQueries' | 'sniffOnStart' | 'sniffOnConnectionFault' | 'requestHeadersWhitelist' | 'sniffInterval' | 'hosts' | 'username' | 'password'> & {
    memoryCircuitBreaker?: OpenSearchConfig['memoryCircuitBreaker'] | ClientOptions['memoryCircuitBreaker'];
    pingTimeout?: OpenSearchConfig['pingTimeout'] | ClientOptions['pingTimeout'];
    requestTimeout?: OpenSearchConfig['requestTimeout'] | ClientOptions['requestTimeout'];
    ssl?: Partial<OpenSearchConfig['ssl']>;
    keepAlive?: boolean;
};

References: OpenSearchConfig