Amazon DynamoDB

Official documentation and software

For full information about DynamoDB, refer to the official documentation.
To download DynamoDB database software, refer to the official software downloads.

Before you begin

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

For example, if you want to run a database on your machine and connect to that database, the corresponding DBMS software must be installed on the machine first.

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

Connect to an DynamoDB database

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 DynamoDB.
- In the Database tool window (View | Tool Windows | Database) , click the New icon () in the toolbar. Navigate to Data Source and select DynamoDB.
In the General tab of Data Sources and Drivers dialog right pane, specify the driver and connection type.
1. In the Driver list, leave the default driver option, unless another driver is required for your connection.
2. From the Connection type list, select the connection type depending on the connection details that you have:
  - default: connect by using Host, Port, Region, and URL.
  - URL only: connect by using only the URL.
  For the URL only connection type, the JDBC URL that you enter is used and as is, including the database credentials.
  For the URL only connection type, the JDBC URL is stored in plain text as is, and is also available in IDE log file and data source information.
  For the other connection types, the JDBC URL is broken down into connection details. You can either specify them separately and use the automatically generated URL, or you can enter the URL directly in the corresponding field.
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 WebStorm configuration directory.
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.
Specify the database connection details. Alternatively, paste the JDBC URL in the URL field.
1. (Optional, local instance only) In the Host field, type your server address.
2. (Optional) In the Port field, type the port of DynamoDB.
3. In the Region field, enter the AWS Region of the database that you are connecting to.
4. From the Authentication list, select the authentication method that you want to use to authenticate the connection. The following options are available:
  - 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.
5. In the Profile field, enter your named profile.
6. In the URL field, WebStorm generates the JDBC URL automatically using the values of other connection settings.
  If you need to use a JDBC URL with certain additional settings, paste it in the URL field.
  Consider the following examples:
  1. Local instance: jdbc:dynamodb://localhost:8000.
  2. Named profile: jdbc:dynamodb://.
  3. Named profile and redefined region: jdbc:dynamodb://?region=eu-west-1.
1. From the Authentication list, select the authentication method that you want to use to authenticate the connection. The following options are available:
  - 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.
2. In the Profile field, enter your named profile.
3. In the URL field, WebStorm generates the JDBC URL automatically using the values of other connection settings.
  If you need to use a JDBC URL with certain additional settings, paste it in the URL field.
  Consider the following examples:
  1. Local instance: jdbc:dynamodb://localhost:8000.
  2. Named profile: jdbc:dynamodb://.
  3. Named profile and redefined region: jdbc:dynamodb://?region=eu-west-1.
  For the URL only connection type, the URL field contents are stored in plain text, and are also available in the IDE log file.
  Use the designated fields to provide your sensitive connection details instead of putting them into the URL field.
For the reference information about connection settings and properties on the General and other tabs of Data Sources and Drivers dialog (Ctrl+Alt+Shift+S) , see Connection settings and DBMS-specific properties.
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.
In case of any connection issues, refer to the Cannot connect to a database page.
(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.
Click OK to create the data source.
Find your new data source in the Database tool window (⌘ 1) .
- For more information about the Database tool window, see the corresponding reference topic.
  To see more schemas under your new data source node, click the N of M button and select the ones you need. WebStorm will introspect and show them.
- For more information about working with database objects in WebStorm, 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 (Ctrl+Alt+Shift+S) , see Data Sources.

DBMS-specific properties

General tab

Item	Description	Connection type
Region	The AWS Region that is available for the DynamoDB.	default
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)

Item

Description

Connection type

Region

The AWS Region that is available for the DynamoDB.

default

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)

Last modified: 21 November 2024