Redshift Setup

Syncaroo

Updated October 17, 2024 19:52

The redshift synapse enables data synchronization between Redshift schema and Syncari entities. Using the sync studio, users can map redshift tables to syncari entities. Data synchronization can be controlled at the entity level i.e, the user can turn off synchronization for a single entity or at the field level.

The typical use case is to sync data from Syncari into Redshift as a destination. However, Redshift can also be used as a source for Syncari, if the goal is to extract computed aggregates and insights from Redshift into Syncari.

If your Redshift security requires you to whitelist an IP you can find that here.

Entities available

All base tables in redshift

Actions available

Create records
Update records
Delete records

Functions available

All functions documented in here are available for use with redshift synapse.

What IAM permissions are required for sync user?

For the Redshift synapse to operate successfully, the Syncari application hosts need to be able to access the Redshift clusters. This can be done by whitelisting the Syncari host IP address under the Redshift cluster settings in AWS.

It's a good practice to create a separate Redshift user for Syncari. This user should have read/write access to the database.

Ensure your redshift cluster is publicly accessible by checking the setting in the Network and security section of the redshift cluster:

Troubleshooting: If Syncari has trouble accessing the redshift cluster, verify all the steps mentioned in the AWS Help are taken care of.

How do I setup a Redshift synapse?

To add a Redshift synapse, navigate to the synapse page, search and drag the redshift synapse from the synapse library onto the main canvas.

Give a name for your synapse instance. This name uniquely identifies your redshift instance. Fill in the username and password for the redshift instance. Enter the endpoint to your redshift cluster. This should be in the format: <cluster-identifier>.<cluster-host>.<region>.redshift.amazonaws.com:5439.

You can find this easily on the Cluster's dashboard. Just click the copy button next to endpoint to grab it. IMPORTANT: Make sure to remove anything after the port number.

Ex: redshift-cluster-1.hvhvdgdt.us-west-1.redshift.amazonaws.com:5439

If the Instantiate with Syncari entities option is selected, all the existing entities in Syncari will be created as tables in Redshift instance. Syncari provides a few standard entities (like Account, Lead, Contact, etc) out of the box. If you need additional entities to be pulled from an external system like Salesforce, it is recommended to setup Redshift after the Salesforce synapse has be fully setup.

Provide the username and password for the Redshift database. The password is encrypted in Syncari. Use the Authenticate button to ensure the credentials are valid.
Finally activating the synapse enables it to be used in the sync studio. NOTE: Before activating the synapse, ensure the IAM permissions in AWS Redshift are enabled.