AWS aurora-dsql documentation change
Summary
Updated documentation to consistently use 'Aurora DSQL Connector for JDBC' naming convention, revised examples section, and removed detailed example table in favor of linking to external repository
Security assessment
Changes primarily involve branding/naming standardization and documentation structure improvements. No security vulnerabilities or new security features are mentioned. The IAM authentication functionality remains unchanged from previous documentation.
Diff
diff --git a/aurora-dsql/latest/userguide/SECTION_program-with-jdbc-connector.md b/aurora-dsql/latest/userguide/SECTION_program-with-jdbc-connector.md index df6a970b8..df08b12e5 100644 --- a//aurora-dsql/latest/userguide/SECTION_program-with-jdbc-connector.md +++ b//aurora-dsql/latest/userguide/SECTION_program-with-jdbc-connector.md @@ -5 +5 @@ -About the connectorKey featuresPrerequisitesUsing the JDBC connector +About the connectorKey featuresPrerequisitesUsing the Aurora DSQL Connector for JDBC @@ -9 +9 @@ About the connectorKey featuresPrerequisitesUsing the JDBC connector -The Aurora DSQL JDBC connector is designed as an authentication plugin that extends the functionality of the PostgreSQL JDBC driver to enable applications to authenticate with Aurora DSQL using IAM credentials. The connector does not connect directly to the database, but provides seamless IAM authentication on top of the underlying PostgreSQL JDBC driver. +The Aurora DSQL Connector for JDBC is designed as an authentication plugin that extends the functionality of the PostgreSQL JDBC driver to enable applications to authenticate with Aurora DSQL using IAM credentials. The connector does not connect directly to the database, but provides seamless IAM authentication on top of the underlying PostgreSQL JDBC driver. @@ -11 +11 @@ The Aurora DSQL JDBC connector is designed as an authentication plugin that exte -The Aurora DSQL JDBC connector is built to work with the [PostgreSQL JDBC Driver](https://github.com/pgjdbc/pgjdbc) and provides seamless integration with Aurora DSQL's IAM authentication requirements. +The Aurora DSQL Connector for JDBC is built to work with the [PostgreSQL JDBC Driver](https://github.com/pgjdbc/pgjdbc) and provides seamless integration with Aurora DSQL's IAM authentication requirements. @@ -13 +13 @@ The Aurora DSQL JDBC connector is built to work with the [PostgreSQL JDBC Driver -In conjunction with the PostgreSQL JDBC Driver, the Aurora DSQL JDBC connector enables IAM-based authentication for Aurora DSQL. It introduces deep integration with AWS authentication services such as [AWS Identity and Access Management](https://aws.amazon.com/iam/) (IAM). +In conjunction with the PostgreSQL JDBC Driver, the Aurora DSQL Connector for JDBC enables IAM-based authentication for Aurora DSQL. It introduces deep integration with AWS authentication services such as [AWS Identity and Access Management](https://aws.amazon.com/iam/) (IAM). @@ -19 +19 @@ Aurora DSQL is a distributed SQL database service that provides high availabilit -The main idea behind the Aurora DSQL JDBC connector is to add an authentication layer on top of the PostgreSQL JDBC driver that handles IAM token generation, allowing users to connect to Aurora DSQL without changing their existing JDBC workflows. +The main idea behind the Aurora DSQL Connector for JDBC is to add an authentication layer on top of the PostgreSQL JDBC driver that handles IAM token generation, allowing users to connect to Aurora DSQL without changing their existing JDBC workflows. @@ -32 +32 @@ In Aurora DSQL, **authentication** involves: -The Aurora DSQL JDBC connector is designed to understand these requirements and automatically generate IAM authentication tokens when establishing connections. +The Aurora DSQL Connector for JDBC is designed to understand these requirements and automatically generate IAM authentication tokens when establishing connections. @@ -34 +34 @@ The Aurora DSQL JDBC connector is designed to understand these requirements and -### Benefits of the Aurora DSQL JDBC connector +### Benefits of the Aurora DSQL Connector for JDBC @@ -36 +36 @@ The Aurora DSQL JDBC connector is designed to understand these requirements and -Although Aurora DSQL provides a PostgreSQL-compatible interface, existing PostgreSQL drivers do not currently support Aurora DSQL's IAM authentication requirements. The Aurora DSQL JDBC connector allows customers to continue using their existing PostgreSQL workflows while enabling IAM authentication through: +Although Aurora DSQL provides a PostgreSQL-compatible interface, existing PostgreSQL drivers do not currently support Aurora DSQL's IAM authentication requirements. The Aurora DSQL Connector for JDBC allows customers to continue using their existing PostgreSQL workflows while enabling IAM authentication through: @@ -47 +47 @@ Although Aurora DSQL provides a PostgreSQL-compatible interface, existing Postgr -### Using the Aurora DSQL JDBC connector with connection pooling +### Using the Aurora DSQL Connector for JDBC with connection pooling @@ -49 +49 @@ Although Aurora DSQL provides a PostgreSQL-compatible interface, existing Postgr -The Aurora DSQL JDBC connector works with connection pooling libraries such as HikariCP. The connector handles IAM token generation during connection establishment, allowing connection pools to operate normally. +The Aurora DSQL Connector for JDBC works with connection pooling libraries such as HikariCP. The connector handles IAM token generation during connection establishment, allowing connection pools to operate normally. @@ -88 +88 @@ Before you begin, make sure that you have completed the following prerequisites: -## Using the JDBC connector +## Using the Aurora DSQL Connector for JDBC @@ -90 +90 @@ Before you begin, make sure that you have completed the following prerequisites: -To use the Aurora DSQL JDBC connector in your Java application, follow these steps: +To use the Aurora DSQL Connector for JDBC in your Java application, follow these steps: @@ -95 +95 @@ To use the Aurora DSQL JDBC connector in your Java application, follow these ste - <!-- Aurora DSQL JDBC Connector --> + <!-- Aurora DSQL Connector for JDBC --> @@ -148 +148 @@ For Gradle projects, add this dependency: -The Aurora DSQL JDBC connector supports the following connection properties: +The Aurora DSQL Connector for JDBC supports the following connection properties: @@ -185 +185 @@ The connector uses the built-in logging system (java.util.logging) of Java. You - # Show Aurora DSQL JDBC Connector FINE logs for detailed debugging + # Show Aurora DSQL Connector for JDBC FINE logs for detailed debugging @@ -198,7 +198 @@ The connector uses the built-in logging system (java.util.logging) of Java. You -For more comprehensive examples and use cases, refer to the [Aurora DSQL samples repository](https://github.com/aws-samples/aurora-dsql-samples), which includes: - -Description | Example ----|--- -Using the Aurora DSQL JDBC connector for basic connections | [Basic JDBC Connector Example](https://github.com/aws-samples/aurora-dsql-samples/tree/main/java/pgjdbc_using_dsql_connector) -Using HikariCP with the Aurora DSQL JDBC connector for connection pooling | [HikariCP with DSQL Connector](https://github.com/aws-samples/aurora-dsql-samples/tree/main/java/pgjdbc_hikaricp_using_dsql_connector) -Using Spring Boot with HikariCP and the Aurora DSQL JDBC connector | [Spring Boot HikariCP Example](https://github.com/aws-samples/aurora-dsql-samples/tree/main/java/springboot_hikaricp_using_dsql_connector) +For more comprehensive examples and use cases, refer to the [Aurora DSQL Connector for JDBC repository](https://github.com/awslabs/aurora-dsql-jdbc-connector?tab=readme-ov-file#examples) @@ -214 +208 @@ Connectors -Backup and restore +Python connector