> ## 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

export const CommonAuthSchemeAwsrootkeys = ({siteName = "CData Sync", siteNameShort = "Sync", datasource = "the data source"}) => {
  return <>
      <p>To connect with your account root credentials, specify the following properties:</p>
      <ul>
        <li><strong>Auth Scheme:</strong> Select <strong>AwsRootKeys</strong>.</li>
        <li><strong>AWS Access Key:</strong> Enter your Amazon Web Services (AWS) account access key. You can locate this value on your AWS security credentials page.</li>
        <li><strong>AWS Secret Key:</strong> Enter your AWS account secret key. You can locate this value on your AWS security credentials page.</li>
      </ul>
    </>;
};

export const CommonAuthSchemeNegotiate = ({siteNameShort = "Sync", datasource = "the data source"}) => {
  return <>
      <p>To connect with Kerberos credentials, specify the following properties:</p>
      <ul>
        <li><strong>Auth Scheme:</strong> Select <strong>Negotiate</strong>.</li>
        <li><strong>Kerberos KDC:</strong> Enter the Kerberos Key Distribution Center (KDC) service that you use to authenticate.</li>
        <li><strong>Kerberos Realm:</strong> Enter the Kerberos realm that you use to authenticate.</li>
        <li><strong>Kerberos SPN:</strong> Enter the service principal name (SPN) for the Kerberos domain controller.</li>
        <li>(Optional) <strong>Kerberos Keytab File:</strong> Enter the path to the keytab file that contains your pairs of the Kerberos principals and encrypted keys.</li>
        <li>(Optional) <strong>Kerberos Ticket Cache:</strong> Enter the full path to an MIT Kerberos credential cache file. {siteNameShort} uses the specified cache file to obtain the Kerberos ticket that is required to connect to {datasource}.</li>
      </ul>
    </>;
};

export const CommonAuthSchemeNone = ({siteName = "CData Sync", siteNameShort = "Sync", datasource = "the data source"}) => {
  return <>
      <p>To connect without authentication, select <strong>None</strong> for <strong>Auth Scheme</strong>. No additional properties are required.</p>
    </>;
};

export const CommonDatasourceMoreInformation = ({datasource = "the data source", advancedurl = "", siteName = "CData Sync", driverVersion = ""}) => {
  return <>
      <p>
        For more information about interactions between {siteName} and {datasource}, see{' '}
        <a href={`https://cdn.cdata.com/help/${advancedurl}${driverVersion}/synch/default.htm`}>
          {datasource} Connector for {siteName}
        </a>.
      </p>
    </>;
};

export const CommonDatasourceAddConnector = ({datasource = "the data source", title = "the connector", destination = false, siteNameShort = "Sync"}) => {
  return <>
      <p>
        To enable {siteNameShort} to use data from {datasource}, you first must add the
        connector, as follows:
      </p>
      <ol>
        <li>Open the <strong>Connections</strong> page of the {siteNameShort} dashboard.</li>
        <li>Click <strong>Add Connection</strong> to open the <strong>Select Connectors</strong> page.</li>
        <li>
          Click the <strong>{destination ? "Destinations" : "Sources"}</strong> tab and locate
          the <strong>{title}</strong> row.
        </li>
        <li>
          Click the <strong>Configure Connection</strong> icon at the end of that row to open
          the <strong>New Connection</strong> page. This action opens the{' '}
          <strong>Add Connection</strong> dialog box.
          <br />
          <strong>Note:</strong> If the <strong>Configure Connection</strong> icon is not
          available, click the <strong>Download Connector</strong> icon to install
          the {title} connector.
        </li>
        <li>Enter a name for your connection in the <strong>Add Connection</strong> dialog box.</li>
        <li>Click <strong>Add</strong> to open the <strong>Settings</strong> tab for your connector.</li>
      </ol>
      <p>
        For more information about installing new connectors, see{' '}
        <a href="../connections">Connections</a>.
      </p>
    </>;
};

export const CommonDatasourceIntroSource = ({datasource = "the data source", siteName = "CData Sync"}) => {
  return <p>
      You can use the {datasource} connector from the {siteName} application to capture data
      from {datasource} and move it to any supported destination. To do so, you need to add
      the connector, authenticate to the connector, and complete your connection.
    </p>;
};

export const driverVersion = "M";

export const siteNameShort = "Sync";

export const siteName = "CData Sync";

export const datasource = "Elasticsearch";
export const pageTitle = "Elasticsearch";
export const advancedurl = "EE";

<CommonDatasourceIntroSource datasource={datasource} siteName={siteName} />

## Add the Elasticsearch Connector

<CommonDatasourceAddConnector datasource={datasource} title={pageTitle} destination={false} siteNameShort={siteNameShort} />

## 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.

{siteName} supports authenticating to {pageTitle} 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

<CommonAuthSchemeNone siteName={siteName} siteNameShort={siteNameShort} datasource={datasource} />

### 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 {pageTitle} account.
* **Password:** Enter the password that you use to authenticate to your {pageTitle} account.

### Negotiate

<CommonAuthSchemeNegotiate siteName={siteName} siteNameShort={siteNameShort} datasource={datasource} />

### AWS Root Keys

<CommonAuthSchemeAwsrootkeys siteName={siteName} siteNameShort={siteNameShort} datasource={datasource} />

* **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 {pageTitle}.
* **API Key Id:** Enter the API key that you use to authenticate to {pageTitle}.

## 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 {datasource} 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

<CommonDatasourceMoreInformation datasource={datasource} advancedurl={advancedurl} siteName={siteName} driverVersion={driverVersion} />