AWS aurora-dsql documentation change
Summary
Restructured client access documentation by removing detailed instructions for AWS CloudShell, local CLI/psql, DBeaver, and JetBrains DataGrip. Replaced with links to dedicated pages and added SQLTools/VSCode support.
Security assessment
No security vulnerabilities or incidents are addressed. Changes are organizational, moving existing connection instructions to dedicated pages. Removed sections contained security notes (SSL enforcement, IAM tokens) but these weren't altered—merely relocated.
Diff
diff --git a/aurora-dsql/latest/userguide/accessing.md b/aurora-dsql/latest/userguide/accessing.md index 163c93522..580fb0c0c 100644 --- a//aurora-dsql/latest/userguide/accessing.md +++ b//aurora-dsql/latest/userguide/accessing.md @@ -5 +5 @@ -SQL clientsAccess with AWS CloudShellAccess with the local CLIAccess with DBeaverAccess with JetBrains DataGripTroubleshooting +SQL clientsTroubleshooting @@ -30 +30 @@ Aurora DSQL supports multiple PostgreSQL-compatible clients for connecting to yo - * Use AWS CloudShell to access Aurora DSQL with the PostgreSQL interactive terminal (psql) + * [Use DBeaver to access Aurora DSQL](./accessing-dbeaver.html) @@ -32 +32 @@ Aurora DSQL supports multiple PostgreSQL-compatible clients for connecting to yo - * Use the local CLI to access Aurora DSQL with the PostgreSQL interactive terminal (psql) + * [Use JetBrains DataGrip to access Aurora DSQL](./accessing-datagrip.html) @@ -34 +34 @@ Aurora DSQL supports multiple PostgreSQL-compatible clients for connecting to yo - * Use DBeaver to access Aurora DSQL + * [Use the PostgreSQL interactive terminal (psql) to access Aurora DSQL](./accessing-psql.html) @@ -36 +36 @@ Aurora DSQL supports multiple PostgreSQL-compatible clients for connecting to yo - * Use JetBrains DataGrip to access Aurora DSQL + * [Use Aurora DSQL driver for SQLTools](./accessing-vscode.html) @@ -43,129 +42,0 @@ Aurora DSQL supports multiple PostgreSQL-compatible clients for connecting to yo -## Use AWS CloudShell to access Aurora DSQL with the PostgreSQL interactive terminal (psql) - -Use the following procedure to access Aurora DSQL with the PostgreSQL interactive terminal from AWS CloudShell. For more information, see [What is AWS CloudShell](https://docs.aws.amazon.com/cloudshell/latest/userguide/welcome.html). - -###### To connect using AWS CloudShell - - 1. Sign in to the [Aurora DSQL console](https://console.aws.amazon.com/dsql). - - 2. Choose the cluster for which you would like to open in CloudShell. If you haven't yet created a cluster, follow the steps in [Step 1: Create an Aurora DSQL single-Region cluster](./getting-started.html#getting-started-create-cluster) or [Create a multi-Region cluster](./getting-started.html#getting-started-multi-region). - - 3. Choose **Connect with Query Editor** and then choose **Connect with CloudShell**. - - 4. Choose whether you want to connect as an admin or with a [custom database role](https://docs.aws.amazon.com/aurora-dsql/latest/userguide/authentication-authorization.html#authentication-authorization-iam-role-connect). - - 5. Choose **Launch in CloudShell** and choose **Run** in the following CloudShell dialog. - - - - -## Use the local CLI to access Aurora DSQL with the PostgreSQL interactive terminal (psql) - -Use `psql`, a terminal-based front-end to PostgreSQL utility, to interactively enter in queries, issue them to PostgreSQL, and view the query results. - -###### Note - -To improve query response times, use the PostgreSQL version 17 client. If you use the CLI in a different environment, make sure you manually set up Python version 3.8+ and psql version 14+. - -Download your operating system's installer from the [PostgreSQL Downloads](https://www.postgresql.org/download/) page. For more information about `psql`, see [PostgreSQL Client Applications](https://www.postgresql.org/docs/current/app-psql.htm) on the _PostgreSQL_ website. - -If you already have the AWS CLI installed, use the following example to connect to your cluster. - - - # Aurora DSQL requires a valid IAM token as the password when connecting. - # Aurora DSQL provides tools for this and here we're using Python. - export PGPASSWORD=$(aws dsql generate-db-connect-admin-auth-token \ - --region us-east-1 \ - --expires-in 3600 \ - --hostname your_cluster_endpoint) - - # Aurora DSQL requires SSL and will reject your connection without it. - export PGSSLMODE=require - - # Connect with psql, which automatically uses the values set in PGPASSWORD and PGSSLMODE. - # Quiet mode suppresses unnecessary warnings and chatty responses but still outputs errors. - psql --quiet \ - --username admin \ - --dbname postgres \ - --host your_cluster_endpoint - -## Use DBeaver to access Aurora DSQL - -DBeaver is a universal SQL client that can be used to manage any database that has a JDBC driver. It is widely used among developers and database administrators because of its robust data viewing, editing, and management capabilities. Using DBeaver's cloud connectivity options, you can connect DBeaver to Aurora DSQL natively. - -**DBeaver PRO** products ([DBeaver Ultimate](https://dbeaver.com/dbeaver-ultimate/), [DBeaver Team](https://dbeaver.com/dbeaver-team-edition/), [CloudBeaver Enterprise](https://dbeaver.com/cloudbeaver-enterprise/), and [CloudBeaver AWS](https://aws.amazon.com/marketplace/pp/prodview-kijugxnqada5i)) offer native integration with Aurora DSQL as of version 25.3 through a dedicated Aurora DSQL connection type as well as via the Cloud Explorer with a seamless authentication experience. - -If you are using a different DBeaver version, including DBeaver Community Edition which is the free and open-source version, visit the [download page](https://dbeaver.io/download/) for installation instructions. Use the following procedure to connect to your cluster. - -###### To set up a new Aurora DSQL connection in DBeaver - - 1. Choose **New Database Connection**. - - 2. In the **New Database Connection** window, choose PostgreSQL. - - 3. In the **Connection settings/Main** tab, choose **Connect by: Host** and enter the following information: - - 1. **Host** – Use your cluster endpoint. - -**Database** – Enter `postgres` - -**Authentication** – Choose `Database Native` - -**Username** – Enter `admin` - -**Password** – Generate an [ authentication token](https://docs.aws.amazon.com/aurora-dsql/latest/userguide/SECTION_authentication-token.html). Copy the generated token and use it as your password. - - 4. Ignore any warnings and paste your authentication token into the **DBeaver Password** field. - -###### Note - -You must set SSL mode in the client connections. Aurora DSQL supports `PGSSLMODE=require and PGSSLMODE=verify-full`. Aurora DSQL enforces SSL communication on the server side and rejects non-SSL connections. For the `verify-full` option you will need to install the SSL certificates locally. For more information see [SSL/TLS certificates](https://docs.aws.amazon.com/aurora-dsql/latest/userguide/configure-root-certificates.html). - - 5. You should be connected to your cluster and can begin running SQL statements. - - - - -###### Important - -The administrative features provided by DBeaver for PostgreSQL databases (such as **Session Manager** and **Lock Manager**) don't apply to Aurora DSQL databases due to their unique architecture. While accessible, these screens don't provide reliable information about database health or status. - -## Use JetBrains DataGrip to access Aurora DSQL - -JetBrains DataGrip is a cross-platform IDE for working with SQL and databases, including PostgreSQL. DataGrip includes a robust GUI with an intelligent SQL editor. To download DataGrip, go to the [download page](https://www.jetbrains.com/datagrip/download) on the _JetBrains_ website. - -###### To set up a new Aurora DSQL connection in JetBrains DataGrip - - 1. Choose **New Data Source** and choose PostgreSQL. - - 2. In the **Data Sources/General** tab, enter the following information: - - 1. **Host** – Use your cluster endpoint. - -**Port** – Aurora DSQL uses the PostgreSQL default: `5432` - -**Database** – Aurora DSQL uses the PostgreSQL default of `postgres` - -**Authentication** – Choose `User & Password `. - -**Username** – Enter `admin`. - -**Password** – [ Generate a token](https://docs.aws.amazon.com/aurora-dsql/latest/userguide/SECTION_authentication-token.html) and paste it into this field. - -**URL** – Don't modify this field. It will be auto-populated based on the other fields. - - 3. **Password** – Provide this by generating an authentication token. Copy the resulting output of the token generator and paste it into the password field. - -###### Note - -You must set SSL mode in the client connections. Aurora DSQL supports `PGSSLMODE=require and PGSSLMODE=verify-full`. Aurora DSQL enforces SSL communication on the server side and rejects non-SSL connections. For the `verify-full` option you will need to install the SSL certificates locally. For more information see [SSL/TLS certificates](https://docs.aws.amazon.com/aurora-dsql/latest/userguide/configure-root-certificates.html). - - 4. You should be connected to your cluster and can start running SQL statements: - - - - -###### Important - -Some views provided by DataGrip for PostgreSQL databases (such as Sessions) don't apply to Aurora DSQL databases because of their unique architecture. While accessible, these screens don't provide reliable information about the actual sessions connected to the database. - @@ -188 +59 @@ Postgres.js connector -Database Connectivity Tools +DBeaver