Share
Amazon Redshift Setup Guide

Amazon Redshift is a fully managed, reliable data warehouse service in the cloud that offers large-scale storage and analysis of data set and performs large-scale database migrations. It is a part of the larger cloud-computing platform Amazon Web Services (AWS).

You can ingest data from your Amazon Redshift database using Hevo Pipelines and replicate it to a Destination of your choice.

Prerequisites

Whitelist Hevo’s IP Addresses

You need to whitelist the Hevo IP address for your region to enable Hevo to connect to your Amazon Redshift database.

To do this, you need to add the inbound rules for your database, and verify Hevo IPs are whitelisted:

1. Add Inbound Rules

  1. Log in to the Amazon Redshift dashboard.

  2. In the left navigation pane, click Clusters.

  3. Click the Cluster that you want to connect to Hevo.

    Click Cluster

  4. In the Properties tab, Network and security settings, click the link text under the VPC security group to open the Security Groups page.

    Click Security group ID

  5. On the Security Groups page, click the Inbound rules tab, and then click Edit inbound rules.

    Click Edit

  6. On the Edit inbound rules page:

    Edit inbound rules

    1. Click Add Rule.

    2. In the Type column, select Redshift from the drop-down.

    3. In the Port Range column, enter the port of your Amazon Redshift cluster. Default value: 5439.

    4. In the Source column, select Custom from the drop-down and enter Hevo’s IP address for your region. Repeat this step to whitelist all the IP addresses.

    5. Click Save.

2. (Optional) Verify Hevo IPs are Whitelisted

  1. Log in to the Amazon Redshift dashboard.

  2. In the left navigation pane, click Clusters.

  3. Click the Cluster that you want to connect to Hevo.

    Click Cluster

  4. In the Properties tab, Network and security settings, click the link text under the VPC ID link.

    Click VPC ID

  5. On the Your VPCs page, Details section, click the link text under Main network ACL.

    Main Network ACL

  6. On the Network ACLs page, click the Inbound rules tab and ensure that the IP addresses you added appear in the range of IPs that are set to Allow. Else, click Edit inbound rules to include these IPs in the allowed range.

    Edit Inbound Rules

Create a Database User and Grant Privileges

  1. (Optional) Create a database user.

    1. Log in to your Amazon Redshift database as a superuser or a user with CREATE privilege.

    2. Enter the following command:

      CREATE USER hevo WITH PASSWORD '<password>';

  2. Grant SELECT privilege for all or specific tables to the user.

    1. Log in to your Amazon Redshift database as a superuser.

    2. Enter the following commands:

      GRANT SELECT ON ALL TABLES IN SCHEMA <schema_name> TO hevo; 
GRANT SELECT ON TABLE <schema_name>.<table_name> TO hevo;

  3. Optionally, view the list of tables available in a schema:

    SELECT distinct(<table_name>) FROM pg_table_def WHERE <schema_name> = 'pg_catalog';

(Optional) Retrieve the Hostname and Port Number

  1. Log in to the Amazon Redshift dashboard.

  2. In the left navigation pane, click Clusters.

  3. Click the Cluster that you want to connect to Hevo.

    Click Cluster

  4. On the <Cluster_name> page, do the following:

    Locate hostname

    • Click the Copy icon to copy the JDBC URL and save it securely like any other password.

    • Navigate to the Properties tab, copy the Port and save it.

    Use this JDBC URL (without the jdbc:redshift:// part) as the database host and the Port as the database port in Hevo while creating your Pipeline.

    For example, in the JDBC URL jdbc:redshift://examplecluster.abc123xyz789.us-west-2.redshift.amazonaws.com:5439/dev, the database host is examplecluster.abc123xyz789.us-west-2.redshift.amazonaws.com.

Configure Amazon Redshift Connection Settings

Perform the following steps to configure Amazon Redshift as a Source in Hevo:

  1. Click PIPELINES in the Navigation Bar.

  2. Click + CREATE PIPELINE in the Pipelines List View.

  3. On the Select Source Type page, select Amazon Redshift.

  4. On the Configure your Amazon Redshift Source page, specify the following:

    Redshift settings

    • Pipeline Name: A unique name for your Pipeline, not exceeding 255 characters.

    • Database Cluster Identifier: Amazon Redshift host’s IP address or DNS name.

      Note: For URL-based hostnames, exclude the initial jdbc:redshift:// part. For example, if the hostname URL is jdbc:redshift://examplecluster.abc123xyz789.us-west-2.redshift.amazonaws.com:5439/dev, enter examplecluster.abc123xyz789.us-west-2.redshift.amazonaws.com.

    • Database Port: The port on which your Amazon Redshift server listens for connections. Default value: 5439.

    • Database User: The database user that you created. This authenticated user has the permissions to read tables in your database.

    • Database Password: The password for the database user.

    • Select an Ingestion Mode: The desired mode by which you want to ingest data from the Source. The available ingestion modes are Table, and Custom SQL. Read Ingestion Modes.

      Depending on the ingestion mode you select, you must configure the objects to be replicated. Refer to section, Object and Query Mode Settings for the steps to do this.

      Note: For Custom SQL ingestion mode, all Events loaded to the Destination are billable.

    • Database Name: The database that you wish to replicate.

    • Connect through SSH: Enable this option to connect to Hevo using an SSH tunnel, instead of directly connecting your Amazon Redshift database host to Hevo. This provides an additional level of security to your database by not exposing your Amazon Redshift setup to the public. Read Connecting Through SSH.

      If this option is disabled, you must whitelist Hevo’s IP addresses.

    • Advanced Settings:

      • Include New Tables in the Pipeline: Applicable for all ingestion modes except Custom SQL.

        If enabled, Hevo automatically ingests data from tables created in the Source after the Pipeline has been set up. These may include completely new tables or previously deleted tables that have been re-created in the Source.

        If disabled, new and re-created tables are not ingested automatically. They are added in SKIPPED state in the objects list, on the Pipeline Overview page. You can update their status to INCLUDED to ingest data. You can include these objects post-Pipeline creation to ingest data.

        You can change this setting later.

  5. Click TEST CONNECTION. This button is enabled once you specify all the mandatory fields. Hevo’s underlying connectivity checker validates the connection settings you provide.

  6. Click TEST & CONTINUE to proceed for setting up the Destination. This button is enabled once you specify all the mandatory fields.

Object and Query Mode Settings

Once you have specified the Source connection settings in Step 4 above, do one of the following:

  • For Pipelines with Table mode:

    1. On the Select Objects page, select the objects you want to replicate and click CONTINUE.

      Object Selection

      Note: Each object represents a table in your database.

    2. On the Configure Objects page, specify the query mode you want to use for each selected object.

      Query-Mode Selection

  • For Pipelines with Custom SQL mode:

    1. On the Provide Query Settings page, enter the custom SQL query to fetch data from the Source.

    2. In the Query Mode drop-down, select the query mode, and click CONTINUE.

      Custom SQL

Data Replication

For Teams Created Default Ingestion Frequency Minimum Ingestion Frequency Maximum Ingestion Frequency Custom Frequency Range (in Hrs)
Before Release 2.21 15 Mins 15 Mins 24 Hrs 1-24
After Release 2.21 6 Hrs 30 Mins 24 Hrs 1-24

Note: The custom frequency must be set in hours as an integer value. For example, 1, 2, or 3 but not 1.5 or 1.75.

  • Historical Data: In the first run of the Pipeline, Hevo ingests all available data for the selected objects from your Source database.

  • Incremental Data: Once the historical load is complete, data is ingested as per the ingestion frequency.

Additional Information

Read the detailed Hevo documentation for the following related topics:

Limitations

  • None.

See Also

Revision History

Refer to the following table for the list of key updates made to this page:

Date Release Description of Change
Oct-22-2024 NA Updated sections, Whitelist Hevo’s IP Addresses and (Optional) Retrieve the Hostname and Port Number as per the Amazon Redshift UI.
Mar-05-2024 2.21 Added the Data Replication section.
Nov-03-2023 NA Renamed section, Object Settings to Object and Query Mode Settings.
Apr-21-2023 NA Updated section, Configure Amazon Redshift Connection Settings to add a note to inform users that all loaded Events are billable for Custom SQL mode-based Pipelines.
Dec-19-2022 2.04 Updated section, Configure Amazon Redshift Connection Settings to add information that you must specify all fields to create a Pipeline.
Dec-07-2022 2.03 Updated section, Configure Amazon Redshift Connection Settings to mention about including skipped objects post-Pipeline creation.
Dec-07-2022 2.03 Updated section, Configure Amazon Redshift Connection Settings to mention about the connectivity checker.
Apr-21-2022 1.86 Updated section, Configure Amazon Redshift Connection Settings.
Jan-24-2021 NA Updated section, Whitelist Hevo’s IP Addresses as per the latest Amazon Redshift interface.
Jan-03-2022 1.79 Updated the description of the Include New Tables in the Pipeline advance setting in the Configure Amazon Redshift Connection Settings section.
Jul-26-2021 1.68 Added a note for the Database Cluster Identifier field.
Jul-12-2021 1.67 Added the field Include New Tables in the Pipeline under Source configuration settings.
Feb-22-2021 1.57 Revised the document to include the end-to-end procedure for configuring Amazon Redshift as a Source.
Last updated on Oct 22, 2024

Tell us what went wrong

Skip to the section