Cloud Explorer
Please note: This article has been updated and its content is now available in a revised form at a new location. Please refer to the updated article Cloud Explorer for the most current information.
Please note: This article has been updated and its content is now available in a revised form at a new location. Please refer to the updated article Cloud Explorer for the most current information.
CloudBeaver AWS is a multi-user web tool for managing databases, built to work with Amazon Web Services (AWS). It allows teams to collaborate easily and take advantage of AWS infrastructure. This edition is especially useful for teams and organizations using AWS cloud environments. It provides a shared, web-based platform for managing databases, making it easier to collaborate, access, and manage data while using AWS infrastructure.
The CloudBeaver AWS Edition provides a powerful set of features tailored for database management within the AWS ecosystem. These features focus on seamless integration with AWS services, scalability, security, and collaboration.
AWS Services
Secure access
Collaboration
Data management and SQL development
Data import/export
Data Visualization
Query development
CloudBeaver AWS has a comprehensive set of JDBC drivers, offering connectivity to various databases without needing separate downloads and configurations.
The CloudBeaver AWS provides support for a wide range of databases. For a full list of supported databases, refer to Supported databases.
CloudBeaver AWS is available for subscription through the AWS Marketplace. The subscription price depends on the instance size you choose. A bigger instance allows more users to work with the application at the same time.
You get a one-month free trial with access to all CloudBeaver features. After the trial, billing is managed based on the AWS pricing plan for the chosen instance size. You don’t need an extra license, as everything is handled through the AWS Marketplace subscription.
In rare cases, CloudBeaver AWS may request a license if access to the EC2 metadata service is restricted. This is often due to enforced IMDSv2 policies by AWS. Since CloudBeaver runs inside a Docker container with a different network interface, it might be unable to communicate with the EC2 instance metadata. Refer to the Troubleshooting section for guidance on resolving this issue.
After subscribing, navigate to
For more information on initial configuration, see Server configuration wizard.
CloudBeaver AWS runs inside a Docker container on your EC2 instance. To update it manually, connect to your EC2 instance via SSH or the instance console, and pull the desired Docker image.
To update CloudBeaver AWS:
Refer to the following documentation for additional guidance:
For technical support with CloudBeaver AWS, you will need to submit a ticket through the DBeaver customer portal on dbeaver.com. When creating a support request, ensure to include your AWS Agreement ID, which is necessary for verifying your subscription.
You can locate your Agreement ID by going to AWS Marketplace > Manage Subscriptions and selecting CloudBeaver AWS. This ID is essential for the CloudBeaver support team to handle your request properly.
Tip: If you need assistance on how to access the Manage Subscriptions section, refer to the official AWS documentation.
Once you have your Agreement ID, log into your account on the DBeaver website, navigate to Profile -> Tickets, and create a new support ticket. Be sure to include all relevant details about the issue to allow the support team to assist you effectively.
CloudBeaver AWS installations from the AWS Marketplace may prompt for a license due to issues with EC2 metadata service availability. This can happen when AWS policies enforce the use of IMDSv2 and restrict access to IMDSv1.
Since CloudBeaver runs inside a Docker container, it operates with a different IP address, which prevents it from connecting to the EC2 metadata service using IMDSv2. As a result, CloudBeaver cannot verify that it was launched through a Marketplace installation.
Solution: To resolve this, ensure your Docker container is run with the
Note: This feature is available in Enterprise, AWS, Team editions only.
This article guides you through the initial steps to configure AWS integration in CloudBeaver.
Once AWS integration is configured, you can access Cloud Explorer, and Cloud Storage.
Tip: For users of the AWS Edition, activating Cloud (AWS) is not required as it comes pre-enabled.
Configuring an Identity Provider is essential for authenticating and authorizing user access to AWS resources.
For a list of available Identity Providers and detailed configuration instructions, see Authentication Methods.
You can configure how AWS credentials are applied for authentication in Cloud Explorer, and Cloud Storage.
Setting | Description |
---|---|
Use default instance credentials | Enable to use AWS instance credentials for authentication. |
Shared Access Role | Specify an IAM role that will be assumed for user access. Requires Use default instance credentials to be enabled. |
Tips:
- Enable Use default machine credentials to simplify authentication by automatically using credentials from your AWS instance.
You can configure the AWS partitions and regions where your resources are located. This ensures the system connects to the correct environment based on your selection.
Note: This feature is available in Enterprise, AWS, Team editions only.
CloudBeaver allows for database connections through AWS SAML with Okta authentication. This guide details the process for establishing such connections. Please ensure you meet all the prerequisites outlined below before proceeding with the configuration steps.
For this type of authentication, proxy access keys and secret keys are not required. This means there is no need to generate static keys in AWS.
Log in to CloudBeaver as an Administrator.
Enable AWS services and AWS SAML provider:
Create a blank Identity Provider:
For instructions on configuring AWS Regions, see AWS Settings.
Copy links:
Create SAML 2.0 application in Okta:
Configure SAML settings in CloudBeaver:
Retrieve SAML configuration URLs from Okta:
Enter SAML details into CloudBeaver:
Field Name | Description |
---|---|
Description (Optional) | Provide a brief description of the identity provider. |
Icon URL (Optional) | Enter the URL of an icon to represent this identity provider in CloudBeaver. |
User group mapping attribute (Optional) | Specify the attribute that will be used for mapping user groups between CloudBeaver and the identity provider. |
Add users to application in Okta:
Add Identity Provider in AWS IAM:
Add a SAML identity provider in AWS IAM. This allows AWS to authenticate users managed by Okta. For comprehensive instructions, refer to the official AWS documentation on identity providers.
Hint to obtain the Metadata document:
- Navigate to Okta and select your application under Applications.
- Proceed to the Sign On tab, locate the SAML 2.0 section, and click on the Metadata URL.
- Then, paste this URL into a new browser tab to open the XML content. Copy the XML content displayed in your browser into a new file.
The next step involves configuring an AWS role for SAML. This role will be used to grant permissions based on the authenticated identity from Okta. For a detailed walkthrough, visit the official AWS documentation on creating roles for SAML 2.0 federation.
Hints for filling fields on the initial page when creating a role:
- Attribute: You can choose
.SAML:iss- Value: To find Issuer, navigate to Okta and select your application under Applications. Then proceed to the Sign On tab, locate the SAML 2.0 section, and there you will find the Issuer URL to copy.
To ensure proper session management and permissions during SAML authentication with AWS, configure the following SAML attributes in Okta:
Steps to Configure SAML Attributes:
Attribute Name | Name Format | Value Example | Notes |
---|---|---|---|
https://aws.amazon.com/SAML/Attributes/SessionDuration | Basic |
3600 | Set in seconds, range: 900 to 43200 seconds. |
https://aws.amazon.com/SAML/Attributes/Role | Basic |
arn:aws:iam::123456789012:role/SAMLRole,arn:aws:iam::123456789012:saml-provider/Okta | Format:
{roleArn},{identityProviderArn} |
https://aws.amazon.com/SAML/Attributes/RoleSessionName | Basic |
user.email | Use a unique identifier like
user.email user.id |
Note: In the Value for the Role attribute, ensure the ARNs are correctly copied from AWS IAM. The
is the ARN for the role created for SAML integration, androleArnis the ARN for the identity provider (Okta) configured in AWS IAM.identityProviderArn
Set a default role and AWS session lifetime in the SAML configuration for consistent permissions, or customize via attribute mapping for user-specific roles. See documentation for details.
Verify the integration of AWS SAML and Okta
Following successful login, you can access the databases listed in Cloud Explorer that are integrated with your AWS account.
Note: This feature is available in Enterprise, AWS, Team editions only.
CloudBeaver supports AWS IAM authentication to enhance security for database operations within AWS environments.
This guide details the configuration process for AWS IAM authentication, applicable to all CloudBeaver versions, with an emphasis on the initial setup required for the AWS version.
For comprehensive setup information of AWS IAM itself, refer to the official AWS IAM documentation.
As an administrator, go to Settings -> Server Configuration.
Find the AWS option (in the Configuration section) and AWS IAM (in the Authentication Settings section). Activate this setting to enable AWS authentication.
Save the changes.
For instructions on configuring AWS Regions, see AWS Settings.
As an administrator, navigate to Settings -> Identity Providers.
Click on the + Add button.
Fill in the following fields:
Field | Description |
---|---|
Provider | Select
AWS IAM |
ID | Enter a unique identifier for the configuration. |
Configuration name | Enter a descriptive name for this configuration. |
Description | Provide a brief description of this identity provider configuration. |
Icon URL | Enter the URL of an icon to represent this provider. |
Disabled | Leave unchecked to enable this identity provider. |
Account IDs | Enter AWS Account IDs, separated by commas. Only users from these accounts are allowed. |
AWS session lifetime | Specify the duration for the AWS session in seconds. |
Tip for Account IDs: You can create entries for different Identity Providers for a more flexible configuration.
With the AWS configuration now established, proceed to the login screen.
You will be presented with two options for key types:
Input your
Confirm your details and click the
Note: To make databases available for users who log in via AWS IAM, the administrator must first add the desired databases. This is done by navigating to Connections -> Cloud Connections and including them in the Database Navigator.
When configuring the CloudBeaver AWS Edition for the first time, AWS IAM credentials are mandatory. This version is optimized for the AWS Marketplace and specifically requires IAM authentication to integrate with AWS services.
During the initial launch, you are required to input your IAM user’s Access Key ID and Secret Access Key to establish the necessary AWS integrations.
No Server-Side Key Storage: CloudBeaver is designed not to store AWS access and secret keys on the server, ensuring they are not held in databases or configuration files. This approach is crucial for maintaining the security of your data.
Automatic administrator role assignment: The AWS user responsible for configuring CloudBeaver automatically receives administrator privileges in the CloudBeaver instance. This user will have comprehensive control over the instance’s settings and configurations.
AWS account association: Upon completing the server configuration, the AWS account of the administrator is associated with the CloudBeaver instance. This means that only AWS users belonging to this specific account can authenticate and access this instance of CloudBeaver.
User management within AWS scope: CloudBeaver for AWS does not support the creation of new users within its platform. It solely operates with existing AWS user accounts. Consequently, every user who needs access must authenticate through their AWS account.
Database Authentication Requirements: AWS databases typically have their own authorization mechanisms, requiring additional authentication parameters such as a username and password. For RDS/Aurora databases using IAM authentication, you may only need to provide the database username, leaving the password field empty.
CloudBeaver uses the following AWS services in order to operate with databases (most of them are optional):
CloudBeaver uses native database clients to connect and operate with most databases. It uses AWS services only to find database instances and configure database connection.
The only exception is the DynamoDB service which is a database driver by itself. You can limit DynamoDB access directly in the AWS console.
Note: This feature is available in Enterprise, AWS, Team editions only.
CloudBeaver allows for database connections through AWS OpenID with Okta authentication. This guide details the process for establishing such connections. Please ensure you meet all the prerequisites outlined below before proceeding with the configuration steps.
CloudBeaver administrative access: Ensure administrative privileges in CloudBeaver.
Create an Application in Okta:
Add Identity Provider in AWS IAM:
Hints for AWS IAM Identity Provider configuration: >- Provider URL: Use your Okta domain, for example,
. >- Audience: Enter Okta’s client ID, which can be copied from the application created in Okta.your-domain.okta.com/
Configure a Role for Web Identity in AWS:
Configure Identity Provider
Click on the + Add button to begin configuring a new identity provider.
Below is the table with fields to be completed for configuring the identity provider:
Field | Description | |
---|---|---|
Provider | Select
AWS OpenID | |
ID | Enter a custom name for the identity provider. | |
Configuration name | Specify the configuration name. | |
Description (optional) | Provide a brief description of the identity provider. | |
Icon URL (optional) | Enter the URL of an icon to represent this identity provider in CloudBeaver. | |
Client ID | Use the Client ID from the Okta application. | |
Client Secret | Use the Client Secret from the Okta application. | |
IDP auth endpoint URL | Format as
https://{okta_domain}/oauth2/v1/authorize | |
IDP token endpoint URL | Format as
https://{okta_domain}/oauth2/v1/token | |
Custom scopes | The custom scopes. Use with
; | |
Role ARN | Enter the ARN for the WebIdentity role from AWS. | |
Name of an AWS role claim | Name of the AWS role claim that contains the name of the AWS role. |
> Important: The Role ARN added during this step acts as the default role. It’s not advisable to use an > administrator role at this step. It is recommended to use a role with minimum privileges during provider setup. > After the provider is configured, you will see an AWS Role ARN field for each user, where > you can specify a role with higher privileges, if necessary.
> For instructions on configuring AWS Regions, see AWS Settings.
Copy Redirect and Sign out Links:
Update Redirect URIs in Okta:
Now you can log in through the newly created Federated authentication method in CloudBeaver, using the Configuration name you assigned during the setup.
Verify the Integration of AWS OpenID and Okta
Following successful login, you can access the databases listed in Cloud Explorer that are integrated with your AWS account.
Note: This feature is available in Enterprise, AWS, Team editions only.
CloudBeaver offers the ability to construct SQL queries using natural language through AI smart completion feature. This capability is achieved through integrations with OpenAI’s GPT language model, Azure OpenAI, Google Gemini and Ollama.
Note: CloudBeaver is not affiliated with OpenAI. Integration is achieved through the public API.
- To utilize this feature, register with OpenAI and obtain a secret key.
With the AI smart completion feature, you can type queries in natural language and CloudBeaver will convert them into SQL statements. This tool simplifies writing complex queries by interpreting your input and automatically generating the correct SQL code.
To activate the AI features in CloudBeaver, configure the API token:
Navigate to Settings -> Administration -> Server Configuration
Ensure the AI option is activated.
Navigate to AI Settings tab -> Choose an engine
Insert credentials.
Save the changes.
For instructions on utilizing the AI features, visit the AI Smart completion usage section.
We prioritize data safety and user privacy. In this section, we outline how data is managed and the measures taken to protect user privacy when using the AI features.
To enable AI features capabilities, metadata such as table and column names from the current database schema are transmitted to third-party AI services. This step is crucial for accurately translating user requests into SQL queries.
Google Gemini privacy: When utilizing Google Gemini, it is important to understand the specific data privacy measures.
To utilize the AI-enhanced functionalities within CloudBeaver, certain configurations and setup processes are required. This section offers a comprehensive guide on initial setup and customization options to tailor the AI integration according to specific preferences.
Sign up on the OpenAI platform.
Navigate to the API Keys section and generate a new secret key.
Insert this key into CloudBeaver’s Engine Settings.
Here is a list of the currently supported models:
gpt-4o-mini.
Sign up on the Azure platform.
Navigate to the Azure Portal and create a new AI service under the AI + Machine Learning section.
Generate and copy the credentials for the newly created service.
Insert these credentials into CloudBeaver’s Engine Settings.
Sign up on the Google Cloud Platform.
Navigate to the Google Cloud Console and create a new project.
Enable the Gemini API for your project by searching for the Gemini API in the marketplace and clicking Enable.
Create credentials for your project by navigating to the Credentials page under APIs & Services. Choose Create credentials and select the appropriate type for your Gemini integration.
Insert these credentials into CloudBeaver’s Engine Settings.
Ensure that Ollama is already installed and running on a server. You will need the host address where Ollama is installed to proceed.
For specific requirements or troubleshooting, you might want to adjust some of the following settings:
Setting | Description |
---|---|
API token | Input your secret key from the OpenAI platform. |
Model | Choose the AI model (recommended: gpt-3.5-turbo for SQL). |
Temperature | Control AI’s creativity from
0.0 0.9 |
Write GPT queries to debug log | Logs your AI requests. |
There is also an option to switch the Engine from OpenAI to Azure OpenAI, Gemini and Ollama. These services provide a set of distinct settings:
Setting | Description |
---|---|
Endpoint | Configure a custom endpoint URL for Azure OpenAPI interactions. |
API version | Select the version of the API you wish to use. |
Deployment | Specify the deployment name chosen during model deployment. |
Context size | Choose the context size between
2048 32768 |
To interact with databases using the AI Smart completion feature:
Launch the SQL Editor.
Click on the AI smart completion icon located in the left toolbar of the SQL Editor.
Input your natural language request in the AI smart completion window.
Click Translate to obtain the SQL query.
Prompts history allows you to review previous prompts in the scope of the session for the chosen tab.
To hide the AI smart completion icon in the SQL Editor:
Deselect AI option.
When using AI to generate SQL queries, it’s essential to provide clear and specific input. Here’s how to optimize your questions:
For instance, if you’re using the CloudBeaver sample SQLite database, you might phrase your request as:
Example 1: “List all customers from Italy”
Resulting SQL:
SELECT *
FROM customers
WHERE country = 'Italy';
Example 2: “montre les clients de France”
SELECT *
FROM customer
WHERE country = 'France';
Example 3: “show customers who purchased blues tracks, use joins”
SELECT c.FirstName, c.LastName, t.Name, g.Name
FROM Customer c
JOIN Invoice i ON c.CustomerId = i.CustomerId
JOIN InvoiceLine il ON i.InvoiceId = il.InvoiceId
JOIN Track t ON il.TrackId = t.TrackId
JOIN Genre g ON t.GenreId = g.GenreId
WHERE g.Name = 'Blues'
ORDER BY c.LastName, c.FirstName;
Example 4: “get names of customers who purchased blues tracks, use joins”
SELECT DISTINCT c.FirstName, c.LastName
FROM Customer c
JOIN Invoice i ON c.CustomerId = i.CustomerId
JOIN InvoiceLine il ON i.InvoiceId = il.InvoiceId
JOIN Track t ON il.TrackId = t.TrackId
JOIN Genre g ON t.GenreId = g.GenreId
WHERE g.Name = 'Blues';
Features
API