Skip to main content

Add the Elasticsearch Connector

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.
supports authenticating to in several ways. Select your authentication method below to proceed to the relevant section that contains the authentication details.

None

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 account.
  • Password: Enter the password that you use to authenticate to your account.

Negotiate

AWS Root Keys

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

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