Workiva Support Center

With the Amazon® Redshift® connector, you can use commands in a chain to perform structured query language (SQL) operations in Amazon Redshift. For example, with this connector, you can:

• Execute SQL commands, such as a CREATE or UPDATE statement or SELECT query
• Retrieve details about a table in Redshift
• Insert or update records into a Redshift database

Note: This connector is built by Workiva and connects to a third-party system. While our Support team can help configure this connector within your workspace, we are unable to troubleshoot or otherwise assist with any issues that originate outside of the Workiva platform.

Prerequisites

To enable the connection to Amazon Redshift, the connector uses Java database connectivity (JDBC) secured with basic username and password authentication. To set up the connector, you'll need:

• A designated integration user created in Amazon Redshift for the connector
• The integration user's authentication credentials
• The JDBC connection's URL, such as jdbc:redshift://<cluster>:<port>/<database>

Set up the Amazon Redshift connector

Note: To make the connector available for use in your organization's chains, an org security administrator first enables it from Configuration.

1. From Chain Builder, click Connections  compare_arrows, and then Create at the top right.
2. Under Connector Connection, select Amazon Redshift and the runner to use with the connector.
   
3. Under Basic Info, enter a unique name and description to help identify the connector.
4. Under Properties, enter the connection's details:
   
   

   Property	Details
   Username	Enter the username of the connection's integration user.
   Password	Enter the password for the Username property.
   Connection URL	Enter the URL for the JDBC connection, such as jdbc:redshift://<cluster>:<port>/<database>. To include optional properties for the connection, append them as a query string, such as jdbc:redshift://cluster.abc123xyz789.us-west-2.redshift.amazonaws.com:5439/dev?<options>. For example, to connect using Secure Sockets Layer (SSL), append ?ssl=true. Note: By default, the port for Amazon Redshift is 5439; however, this may be different for your environment.

   Note: All sensitive credentials are automatically encrypted and stored at Advanced Encryption Standard (AES)-256 encryption. For security purposes, avoid including user credentials as optional properties within the Connection URL property.

5. Select the environments to use the connection, and click Save.
6. To test the connection, create and run a chain with the connector's Get Table Definition command, and verify it returns a valid output.

Troubleshooting

If the connection to Amazon Redshift fails:

• Verify the integration user's authentication credentials.
• Check the URL for the JDBC connection, including its cluster and port.

If the connection fails to perform a command, verify its inputs—such as its SQL syntax or table—are valid.