- Open the connections page in preferences, see managing connections for more information.
- Click the
Add new Connectionbutton at the top of the connections page.
Redshiftfrom the list.
- Give a
Connection namefor your own internal reference.
Hostname, enter the hostname of your database server.
Port, use the default
5439, or enter the port used by your server.
Database, enter the name of your database.
- Select how to connect to database. See below for details on using AWS IAM.
- If using Username/Password, for
Password, enter the username and password for PostgreSQL. These are optional.
- Toggle connection type for direct or cloud.
- Share the connection with your team.
SSLsettings. These are optional.
Connectand you're all set!
Happy querying! 🍭
Once enabled, you will be able to select one of the "Amazon RDS IAM" authentication methods for the connection. When using the credentials method, you will be asked for the
AWS Access Key ID,
AWS Secret Access Key, and optionally the
AWS Session Token, which can be acquired by going through the My Security Credentials page on AWS or provided by your administrator. For the profile method, you will be asked for
Profile which corresponds to the named profile you have configured within the AWS CLI. When authenticating, PopSQL will then open that file to read the stored credential information.
For the "Okta" method, it will utilize the AWS Account Federation integration through Okta to authenticate. You will need to provide your Okta organization (e.g.
acme.okta.com), the "App Embed Url" for the integration, the region you wish to use, the role to authenticate with, and your okta username / password.
For all methods, you will also be asked for a
Username corresponds to the DB user you wish to use to connect to the database. Your administrator should have created the GetClusterCredentials IAM role for the user, as well as created the Database User Account for you to use. You can prefix the username with
IAMA: to disable or enable the
AutoCreate parameter for the connection. If the
Username field is left blank, then it will default to your OS' username with the
AutoCreate flag enabled.
This authentication mechanism only works with direct connections, so please make sure your computer can reach RDS (i.e. you may need to configure the RedShift VPC to allow your IP address).
Updated 9 months ago