Field | Description |
Protocol | Specifies the communication protocol used to establish communication between API Gateway and the external Elasticsearch. |
Hostname | Specifies the host name or IP address of the machine on which the external Elasticsearch is running. |
Port | Specifies the port where the external Elasticsearch server runs. The default port number is 9240. |
Index alias | Specifies the index alias for the external Elasticsearch, where certain data is stored. This data stored helps in simplifying operations like searches, filtering, and routing across multiple indices The index alias links two or more indices. By linking multiple indices, you can designate one index as the primary write index while others serve as read-only replicas. This configuration allows you to define a destination alias. The size or age of the write index grows based on the configured ILM policy. The external Elasticsearch automatically creates a new write index while marking the previous one as read-only. Through this approach, you can effectively manage index size and age. For detailed instructions on configuring ILM policies and implementing index lifecycle management, see
https://www.elastic.co/guide/en/elasticsearch/reference/current/aliases.html and
https://www.elastic.co/guide/en/elasticsearch/reference/current/index-lifecycle-management.html. |
Username | Specifies the external Elasticsearch user ID for authenticating the external Elasticsearch when API Gateway communicates with it. |
Password | Specifies the password of the external Elasticsearch instance to be used for establishing communication between API Gateway and the external Elasticsearch. |