Connect to Amazon Redshift

Connect to a Redshift cluster or Serverless workgroup over a direct TLS connection or the Data API, with IAM, a password or a secret.

A Redshift connection starts with two choices: the deployment and the transport. The deployment is either a provisioned cluster, which needs a cluster identifier, or Serverless, which needs a workgroup name. Every connection also needs a database.

Transport

The direct connection uses TLS and needs a host, with an optional port. It can go through an SSH tunnel, and you can add a custom certificate authority if your cluster uses one. The Data API is HTTPS to AWS, signed with SigV4. It needs an AWS region and does not use an SSH tunnel. If you add a tunnel to a Data API connection, Tablyne refuses it and explains why.

Authentication

Three methods exist, and not every one fits both transports.

  • IAM uses temporary credentials from an AWS profile and region. It works on both transports. On a provisioned cluster you also give the database user. On Serverless the user comes from the credentials.
  • User and password works on the direct connection only.
  • A Secrets Manager ARN works on the Data API only.

Tablyne rejects a combination that cannot work before it tries to connect.

Testing the connection

The test shows the server version and the round-trip time. After the first query, the server confirms whether it is a provisioned cluster or Serverless. If that does not match what you saved, the sidebar warns you, and Tablyne uses the mode the server reported for activity and sessions.

Limits

The Data API does not carry an SSH tunnel and does not accept NULL as a query parameter. The direct connection cannot use a secret ARN.