Endpoints create a hostname which is required for external cluster connectivity with any tool such as Apache Superset/Tableau Cloud. While creating the endpoints support three types of connectivity:

  • Direct Connectivity - Direct connectivity enables users to establish connections with external clients. This type of connectivity is recommended for users in Proof of Concept (POC) mode.

  • TLS Connectivity - TLS connectivity allows the user to connect to external clients by using an e6data Python connector or JDBC drivers to the e6data cluster. This type of connectivity is recommended for enterprise-level users.

  • Gateway Connectivity - Gateway connectivity allows the user to connect to external clients without direct connectivity enabled. For more information contact e6data support.


  1. The endpoints might take 10 to 12 minutes for the GCP workspace to become ACTIVE.

  2. Gateway-type connectivity only works with low-concurrency rates (up to 20 queries per second)

How to Create an Endpoint?

Creating Endpoints is a two-step process:

Only users with SuperAdmin or DataAdmin privileges can manage Cluster Connectivity.

Create Hostname

  1. Click on the Connectivity option in the left navigation panel

  2. From the dropdown, select Endpoints,

  3. Click on the CREATE option provided in the top right corner

  4. Enter the following details in the create form -

    1. Name: Provide a name to the load balancer

    2. Type of connectivity:

    3. Scheme: Select a scheme as per your requirement.

      1. Select "Internal" when accessing the cluster within the same network boundary (VPC).

      2. Select "Internet-facing" when accessing the cluster in a different network boundary (VPC).

      3. Add tags to help monitor costs associated with the Endpoint components.

Direct connectivity does not require DNS mapping.

Assign DNS to Endpoint

Once the endpoint is created, the status will be updated to Assign DNS to Enpoint, follow the further details to

  1. Click on the name of the endpoint from the listing page

  2. A hostname will be generated. Assign it to your domain using the DNS mapping process.

  3. Once the DNS Mapping process is completed. Fill in the following details -

    1. Domain Name: Provide the sub-domain name.

    2. ACM Certificate ARN: Provide the ACM certificate ARN in the input field. The above endpoint connectivity works only over SSL, hence TLS certificates are required which can be provided through ACM.

    3. Clusters: Select the cluster to which you want to attach the endpoint.

    4. IP Sets: Select the IP Sets for which you would like to connect external tool

  4. After adding all the details to the form, please confirm to delete the existing connection details created via cluster connector. Deleting these details requires the establishment of new cluster connectivity. This action will disconnect the cluster connection with any external tool if any. To reconnect, use the new details to establish a fresh connection between the cluster and the external tool.

  5. Click on Create.

Points to remember

  • Direct and Gateway types of connectivity can be connected to only one cluster at a time.

  • TLS type of connectivity can be associated with multiple clusters.

  • Multiple IP Sets can be connected to each endpoint.

  • Ensure to attach an IP Set to access the cluster outside the control plane; by default, access is denied.

When creating an endpoint, ensure the cluster is not in use, as the users won't be able to access the cluster, and running queries will fail.

DNS Mapping Process

To add the CNAME record to your preferred domain host, follow the steps below. See your domain host’s documentation for more specific instructions.

  1. Go to your domain’s DNS records.

  2. Add a record to your DNS settings, selecting CNAME as the record type.

  3. Provide the desired subdomain name into the Label or Host field with your DNS records.

  4. Copy the endpoint hostname from above in the Destination/Target field.

  5. Your record should look similar to one of the tables below:

Record typeLabel/Host fieldTime to Live (TTL)Destination/Target field





  1. Save your record. CNAME record changes can take up to 72 hours to go into effect, but typically they happen much sooner.

Edit Endpoint

To edit endpoints, follow the below steps:

  1. Navigate to Endpoint.

  2. Click on the endpoint name that you want to edit

  3. In the edit form, you can update the following fields:

    1. Cost Tags: You can add, update and delete the cost tags.

    2. Domain and ACM certificate: Before editing these two fields, please ensure that you assign the hostname to the domain using the DNS mapping process.

    3. Clusters: You can attach or detach any cluster from the dropdown.

    4. IP Sets: You can attach or detach any IP Set from the dropdown.

  4. Click on Update.

Delete Endpoint

  1. Navigate to Endpoint.

  2. Select a cluster and click on delete.

  3. Confirm and delete the endpoint.

Last updated