DataGrip
 
2024.3
Shortcuts: Windows
Get DataGrip

Connect to Amazon Redshift with Okta

Last modified: 04 December 2024

note

You need to create and open a project from the Welcome Screen. Only after that you will see the DataGrip interface and will be able to create connections.

Before you begin

This topic presents a general procedure on how you can create a data source for the connection to your Amazon Redshift database in DataGrip, and run a test connection. It is assumed that you already have the necessary connection details and the database is up and running.

To learn about your DBMS software, refer to its official documentation.

Prerequisites

Your Amazon Redshift dashboard must have a Amazon Redshift cluster in it. For more information about the Amazon Redshift cluster, refer to Getting Started with Amazon Redshift.

Connect to an Amazon Redshift database

  1. To connect to the database, create a data source that will store your connection details. You can do this using one of the following ways:

    • In the main menu, go to File | New | Data Source and select Amazon Redshift.

    • In the Database Explorer (View | Tool Windows | Database Explorer) , click the New icon (the New icon) in the toolbar. Navigate to Data Source and select Amazon Redshift.

    Create a new data source

  2. In the General tab of Data Sources and Drivers dialog right pane, select IAM cluster/region in the Connection type list.

  3. Check if there is a Download missing driver files link at the bottom of the connection settings area. Click this link to download drivers that are required to interact with a database. For a direct download link, refer to the JetBrains JDBC drivers page.

    Location for the downloaded JDBC drivers is the DataGrip configuration directory.

    The Download missing driver files link

    You can also use your drivers for the database instead of the provided ones. For more information about connecting to a database with your driver, refer to Add a user driver to an existing connection.

    If there is no Download missing driver files link, then you already have the required drivers.

  4. Specify the database connection details. Alternatively, paste the JDBC URL in the URL field.

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

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

      • pgpass: by using the pgpass file. You can store this file in the user's home directory. You can read more about the password file and its location in The Password File at postgresql.org.

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

      • AWS Profile: by using an AWS named profile in the Profile field.

        For more information about AWS named profiles, refer to the DBMS-specific properties chapter.

      • No auth: authentication is not required.

    3. In the Database field, type the database name to which you want to connect.

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

    5. In the Advanced tab, specify the following settings by adding them as <user defined>: plugin_name, app_id, idp_host, role_arn.

      For more information about these settings and values, refer to Amazon AWS official website.

    Database connection details

    For the reference information about connection settings and properties on the General and other tabs of Data Sources and Drivers dialog (CtrlAltShift0S) , see Connection settings and DBMS-specific properties.

  5. In the settings of the Amazon Redshift cluster, copy the JDBC URL.

  6. Paste the JDBC URL from the Amazon Redshift cluster settings to the URL field in DataGrip.

    The general URL to use is as follows:

    • Format: jdbc:redshift://<connection_url>:<port_number>/<database_name>

    • Example: jdbc:redshift://server.redshift.amazonaws.com:5439/myDatabase

    For full information about the JDBC URL format, refer to the Amazon Redshift official documentation.

  7. In User and Password fields, specify your Redshift credentials.

  8. Ensure that the connection to the database can be established using the provided details. To do that, click the Test Connection link at the bottom of the connection details area.

    Test Connection link

    In case of any connection issues, refer to the Cannot connect to a database page.

  9. (Optional) By default, only the default introspected and available to work with. If you also want to work with other databases, schemas, and shared databases, in the Schemas tab, select them for the introspection.

    Schemas tab of the Data Sources and Drivers dialog

  10. Click OK to create the data source.

  11. Find your new data source in Database Explorer () .

    • For more information about Database Explorer, see the corresponding reference topic.

      tip

      To see more databases, schemas, and shared databases under your new data source node, click the N of M button and select the ones you need. DataGrip will introspect and show them.

      Select databases and schemas to introspect and display in Database Explorer

      For more information about displaying databases, schemas, and shared databases in Database Explorer, refer to the Show all databases or schemas tutorial.

    • For more information about working with database objects in DataGrip, refer to Database objects.

    • To write and run queries, open the default query console by clicking the data source and pressing F4.

    • To view and edit data of a database object, open Data editor and viewer by double-clicking the object.

Connection settings and DBMS-specific properties

Connection settings

For the reference information about connection settings (for example, Host, Port, and so on) on the General and other tabs of Data Sources and Drivers dialog (CtrlAltShift0S) , see Data Sources.

DBMS-specific properties

General tab

Item

Description

Connection type

Region

The AWS Region that is available for the Amazon Redshift.

IAM cluster/region

Cluster

Amazon Redshift cluster is a group of computing resources. For more information, refer to the Amazon Redshift official documentation.

Profile

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

Consider the following example of the credentials file:

[default]
aws_access_key_id=ASIAIOSFODNN7EXAMPLE
aws_secret_access_key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
aws_session_token = IQoJb3JpZ2luX2IQoJb3JpZ2luX2IQoJb3JpZ2luX2IQoJb3JpZ2luX2IQoJb3JpZVERYLONGSTRINGEXAMPLE

[user1]
aws_access_key_id=ASIAI44QH8DHBEXAMPLE
aws_secret_access_key=je7MtGbClwBF/2Zp9Utk/h3yCo8nvbEXAMPLEKEY
aws_session_token = fcZib3JpZ2luX2IQoJb3JpZ2luX2IQoJb3JpZ2luX2IQoJb3JpZ2luX2IQoJb3JpZVERYLONGSTRINGEXAMPLE

To use the credentials stored in the user1 profile, enter user1 in the Profile field.

For more information about named profiles, refer to the Amazon AWS official documentation.

all types (AWS Profile authentication method)

Schemas tab

Item

Description

Show internal system schemas

Show internal system schemas like pg_temp or p_toast.

Show template databases

Show template databases.

See also

Related

Reference

Tool Windows