AWS

Enable the Database Tools and SQL plugin

This functionality relies on the Database Tools and SQL plugin, which is bundled and enabled in JetBrains Rider by default. If the relevant features are not available, make sure that you did not disable the plugin.

1. Press Ctrl+Alt+S to open settings and then select Plugins.

2. Open the Installed tab, find the Database Tools and SQL plugin, and select the checkbox next to the plugin name.

Step 1. Install a cloud provider plugin

1. In the Database tool window, click New on the toolbar and navigate to Data Source from Cloud Provider | Download Provider Plugin | AWS Cloud Explorer.

   

2. In the Choose Plugins to Install or Enable dialog, make sure that the plugin for your cloud provider is selected. Click OK to confirm.

   JetBrains Rider downloads the plugin.

3. Once the cloud provider plugin is downloaded, the provider is available in the same submenu under New | Data Source from Cloud Provider | AWS.

Step 2. Configure a AWS cloud provider connection

1. In the Database tool window, click New on the toolbar. Navigate to Data Source from Cloud Provider and select AWS.

   

2. JetBrains Rider opens the Clouds section on the left-hand side of Data Sources and Drivers dialog. Iin this section, enter your cloud provider account connection details on the Configuration tab of the settings area.

   1. From the Regions dropdown, select the AWS Regions of the account that you are connecting to.

   2. From the Authentication type dropdown, select the authentication method you want to use.

      • Default credential providers chain: use the credentials from the default provider chain. For more information about the chain, refer to Using the Default Credential Provider Chain.

      • Profile from credentials file: select a profile from your credentials file.

      • Explicit access key and secret key: enter your credentials manually.

      With the Default credential providers chain or Profile from credentials file option selected, you can click Open Credentials to locate the directory where the credential file is stored. If you use the default location, it's usually ~/.aws/credentials on Linux or macOS, or C:\Users\<USERNAME>\.aws\credentials on Windows. Or it can be your custom location if you have selected Use custom configs.

   3. You can also set up Extended Connection Settings:

      • HTTP Proxy: select if you want to use IDE proxy settings or specify custom proxy settings.

   

3. Run a test connection by clicking Test connection at the bottom of the connection details area.

4. Click Apply to save the connection configuration.

Step 2. Create a data source

To create a data source for a database stored in the cloud provider, do the following.

1. In the Clouds section on the left-hand side of the dialog of Data Sources and Drivers dialog, open the Databases tab of the settings area.

2. On the Databases tab, JetBrains Rider displays the list of databases available in the account. Select the databases you want to connect to. To select multiple databases, click them holding Shift.

   

3. To create a data source for the selected database, click Create data source.

   JetBrains Rider saves the cloud provider connection configuration and opens the Data Sources section on the left-hand side of the dialog. The IDE also automatically fills the database connection details in the corresponding fields of the General tab of the settings area.

4. Type your user credentials.

   

5. Ensure that the database connection can be established using the provided details. To do this, click the Test Connection link at the bottom of the connection details section.

   

   If you encounter any connection issues, refer to the Cannot connect to a database page.

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

   

7. Click OK to create the data source.

8. Find your new data source in the Database tool window.

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

   • For more information about working with database objects in JetBrains Rider, 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.