Amazon Redshift

Configure an Amazon Redshift database connection

1. Open the New Amazon Redshift connection dialog. Select the tab for one of the two options:

   • From the editor, to attach the new database connection to a specific notebook

   • From the Home page, to add a database connection to a workspace

   1. Open the Attached data tool from the left-hand sidebar.

   2. Switch to the Databases tab. You will see the list of all database connections available from the respective workspace.

   3. At the bottom of the tab, click New database.

      

   4. In the New database connection dialog, select Amazon Redshift.

   1. On the Home page, select the workspace where you want to create the connection.

   2. In the selected workspace, go to Data | Databases.

      

   3. Click the Add button in the upper right corner. The New database connection dialog will open.

   4. In the New database connection dialog, select Amazon Redshift.

      

2. On the General tab, select the connection type.

   • Default: to connect by specifying the Host, Port, and Database.

   • IAM cluster/region: to connect by using Database, Region, and Cluster.

   • URL only: to connect by providing the URL of a pre-built connection.

3. Proceed based on the selected connection type:

   1. In the Host field, type your server address.

   2. In the Port field, type the port of Amazon Redshift. The default port is 5439.

   3. From the Authentication list, select the authentication method that you want to use to authenticate the connection. The following options are available:

      • User & Password: by using your login and password.

      • AWS Vault AppRole: by using AWS Vault for your AWS credentials. Visit this page for more details.

      • AWS profile: by using a named profile. A named profile is a collection of settings and credentials that you can use for authentication. Named profiles are stored in CREDENTIALS files. Default directories for these files are ~/.aws/credentials (Linux and macOS) and %USERPROFILE%\.aws\credentials (Windows).

      • No auth: without authentication.

   4. In the User and Password, provide your credentials if required by the selected authentication type.

   5. In the Database field, enter the name of the database to which you want to connect.

   • From the Authentication list, select the authentication method that you want to use to authenticate the connection. The following options are available:

     • User & Password: by using your login and password.

     • AWS Vault AppRole :by using AWS Vault for your AWS credentials. Visit this page for more details.

     • AWS profile: by using a named profile. A named profile is a collection of settings and credentials that you can use for authentication. Named profiles are stored in CREDENTIALS files. Default directories for these files are ~/.aws/credentials (Linux and macOS) and %USERPROFILE%\.aws\credentials (Windows).

     • No auth: without authentication.

   • In the User and Password, provide your credentials if required by the selected authentication type.

   • In the Database field, enter the name of the database to which you want to connect.

   • In the Region field, enter the AWS Region of the database that you are connecting to.

   • In the Cluster field, enter the name of Amazon Redshift cluster that contains your database.

   • From the Authentication list, select the authentication method that you want to use to authenticate the connection. The following options are available:

     • User & Password: by using your login and password.

     • AWS Vault AppRole :by using AWS Vault for your AWS credentials. Visit this page for more details.

     • AWS profile: by using a named profile. A named profile is a collection of settings and credentials that you can use for authentication. Named profiles are stored in CREDENTIALS files. Default directories for these files are ~/.aws/credentials (Linux and macOS) and %USERPROFILE%\.aws\credentials (Windows).

     • No auth: without authentication.

   • In the User and Password, provide your credentials if required by the selected authentication type.

   • In the URL field, provide the URL of the pre-built connection you want to establish.

4. (Optional) For other options (SSH tunneling, scope inspection, or additional connection parameters), switch to the respective tab of the dialog and follow one of these procedures.

5. Click the Test connection button at the bottom of the dialog.

6. Once the connection is successfully tested, click the Create and close button.