> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cloud.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Elasticsearch

export const title_3 = "Elasticsearch";

export const title_2 = "Elasticsearch";

export const title_1 = "Elasticsearch";

export const title_0 = "Elasticsearch";

## Prerequisites

In Elasticsearch, add the Connect AI static IP addresses to your connection whitelist.

## Setup Guide

Follow these steps to connect Elasticsearch to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Elasticsearch* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the REST **Server**'s host name or IP address.
  </Step>

  <Step>
    Enter the port for connecting to the Elasticsearch server.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="BASIC">
    <Steps>
      <Step>
        Enter the Elasticsearch username for authentication in the **User** field.
      </Step>

      <Step>
        In the **Password** field, enter the user password.
      </Step>

      <Step>
        Select the **Data Model** from the drop down.
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_0} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWS RootKeys">
    <Steps>
      <Step>
        Enter the **AWS Access Key** associated with the AWS root account.
      </Step>

      <Step>
        Enter the **AWS Secret Key** associated with the AWS root account.
      </Step>

      <Step>
        Enter the **AWS Region** where the ElasticSearch instance is hosted.
      </Step>

      <Step>
        Select the **Data Model** from the drop down.
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_1} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWSIAMRoles">
    <Steps>
      <Step>
        Enter the **AWS Access Key** associated with the AWS root account.
      </Step>

      <Step>
        Enter the **AWS Secret Key** associated with the AWS root account.
      </Step>

      <Step>
        Enter the **AWS Role ARN** for the authenticating User Id.
      </Step>

      <Step>
        Enter the **AWS Region** where the ElasticSearch instance is hosted.
      </Step>

      <Step>
        (Optional) If emulating a different role, enter it into the **AWS External Id** field.
      </Step>

      <Step>
        Select the **Data Model** from the drop down.
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_2} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="API Key">
    <Steps>
      <Step>
        Enter the **API Key** received from ElasticSearch.
      </Step>

      <Step>
        Enter the **API Key Id** returned alongside the above API Key.
      </Step>

      <Step>
        Select the **Data Model** from the drop down.
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_3} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Elasticsearch, see [this information page](https://cdn.cdata.com/help/EEM/cloud/default.htm#default).