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

# Elasticsearch

You can use the Elasticsearch connector from the CData Sync application to capture data
from Elasticsearch and move it to any supported destination. To do so, you need to add
the connector, authenticate to the connector, and complete your connection.

## Add the Elasticsearch Connector

To enable Sync to use data from Elasticsearch, you first must add the
connector, as follows:

<ol>
  <li>Open the **Connections** page of the Sync dashboard.</li>
  <li>Click **Add Connection** to open the **Select Connectors** page.</li>
  <li>Click the **Sources** tab and locate
  the **Elasticsearch** row.</li>

  <li>
    Click the **Configure Connection** icon at the end of that row to open
    the **New Connection** page. This action opens the
    **Add Connection** dialog.

    **Note:** If the **Configure Connection** icon is not
    available, click the **Download Connector** icon to install
    the Elasticsearch connector.
  </li>

  <li>Enter a name for your connection in the **Add Connection** dialog.</li>
  <li>Click **Add** to open the **Settings** tab for your connector.</li>
</ol>

For more information about installing new connectors, see
[Connections](https://docs.sync.cdata.com/26.4/en/connections/connections.md).

## Authenticate to Elasticsearch

After you add the connector, you need to set the required properties.

* **Server:** Enter the host name or IP address of your Elasticsearch REST server. You can specify multiple nodes in a single cluster, also. However, such nodes must be able to support REST API calls.
* **Port:** Enter the port number for the Elasticsearch REST server. The default port value is **9200**.
* (Optional) **Aliases Filter:** Enter a comma-separated list of alias names or filters that you want to use to filter aliases that are exposed as views.
* (Optional) **Indices and Data Streams Filter:** Enter a comma-separated list of index and data stream names or filters.

CData Sync supports authenticating to Elasticsearch in several ways. Select your authentication method below to proceed to the relevant section that contains the authentication details.

* [**None**](#none)
* [**Basic**](#basic)
* [**Negotiate**](#negotiate)
* [**Aws Root Keys**](#aws-root-keys)
* [**Aws IAM Roles**](#aws-iam-roles)
* [**API Key**](#api-key)

### None

To connect without authentication, select **None** for **Auth Scheme**. No additional properties are required.

### Basic

To connect with your user credentials, set the following properties:

* **Auth Scheme:** Select **BASIC**.
* **User:** Enter the username that you use to authenticate to your Elasticsearch account.
* **Password:** Enter the password that you use to authenticate to your Elasticsearch account.

### Negotiate

To connect with Kerberos credentials, specify the following properties:

<ul><li>**Auth Scheme:** Select **Negotiate**.</li>
<li>**Kerberos KDC:** Enter the Kerberos Key Distribution Center (KDC) service that you use to authenticate.</li>
<li>**Kerberos Realm:** Enter the Kerberos realm that you use to authenticate.</li>
<li>**Kerberos SPN:** Enter the service principal name (SPN) for the Kerberos domain controller.</li>
<li>(Optional) **Kerberos Keytab File:** Enter the path to the keytab file that contains your pairs of the Kerberos principals and encrypted keys.</li>
<li>(Optional) **Kerberos Ticket Cache:** Enter the full path to an MIT Kerberos credential cache file. Sync uses the specified cache file to obtain the Kerberos ticket that is required to connect to Elasticsearch.</li></ul>

### AWS Root Keys

To connect with your account root credentials, specify the following properties:

<ul><li>**Auth Scheme:** Select **AwsRootKeys**.</li>
<li>**AWS Access Key:** Enter your Amazon Web Services (AWS) account access key. You can locate this value on your AWS security credentials page.</li>
<li>**AWS Secret Key:** Enter your AWS account secret key. You can locate this value on your AWS security credentials page.</li></ul>

* **AWS Region:** Select the region that hosts your Amazon Web Services. The default region is **NORTHERNVIRGINIA**.

### AWS IAM Roles

To connect with your IAM user credentials, specify the following properties:

* **Auth Scheme:** Select **AwsIAMRoles**.
* **AWS Access Key:** Enter your Amazon Web Services (AWS) account access key. You can locate this value on your AWS security credentials page.
* **AWS Secret Key:** Enter your AWS account secret key. You can locate this value on your AWS security credentials page.
* **AWS Role ARN:** Enter the Amazon Resource Name (ARN) for the role with which you want to authenticate.
* **AWS Region:** Select the region that hosts your Amazon Web Services. The default region is **NORTHERNVIRGINIA**.
* (Optional) **AWS External Id:** Enter the unique identifier that is required when you assume a role in another account.

### API Key

To connect with an API key, specify the following properties:

* **API Key:** Enter the API key that you use to authenticate to Elasticsearch.
* **API Key Id:** Enter the API key that you use to authenticate to Elasticsearch.

## Complete Your Connection

To complete your connection:

1. Specify the following properties:
   * **Use SSL:** Select whether you want to enable Secure Sockets Layer (SSL). By default, the **Enable** checkbox is not selected.
   * (Optional) **Data Model:** Select the data model that you want to use to parse Elasticsearch documents and generating the database metadata. The default data model is **Document**.
   * (Optional) **Expose Dot Indices:** Specify whether you want to expose dot indices as either tables or views. These indices have names that begin with "." (dot). The default option is **False**.
2. Define advanced connection settings on the **Advanced** tab. (In most cases, though, you should not need these settings.)
3. Click **Create & Test** to create your connection.

## More Information

For more information about interactions between CData Sync and Elasticsearch, see
[Elasticsearch Connector for CData Sync](https://cdn.cdata.com/help/EEN/synch/default.htm).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.