Skip to content

Latest commit

 

History

History
78 lines (54 loc) · 3.85 KB

GettingStarted.md

File metadata and controls

78 lines (54 loc) · 3.85 KB
Raw

Getting Started

Minimum Requirements

Before using the AWS Advanced JDBC Driver, you must install:

  • Amazon Corretto 8+ or Java 8+.
  • The AWS Advanced JDBC Driver.
  • Your choice of underlying JDBC driver.

If you are using the AWS JDBC Driver as part of a Gradle project, include the wrapper and underlying driver as dependencies. For example, to include the AWS JDBC Driver and the PostgreSQL JDBC Driver as dependencies in a Gradle project, update the build.gradle file as follows:

Note: Depending on which features of the AWS JDBC Driver you use, you may have additional package requirements. Please refer to this table for more information.

dependencies {
    implementation group: 'software.amazon.jdbc', name: 'aws-advanced-jdbc-wrapper', version: '2.3.5'
    implementation group: 'org.postgresql', name: 'postgresql', version: '42.5.0'
}

Obtaining the AWS JDBC Driver

Direct Download and Installation

You can use pre-compiled packages that can be downloaded directly from GitHub Releases or Maven Central to install the AWS JDBC Driver. After downloading the AWS JDBC Driver, install it by including the .jar file in the application's CLASSPATH.

For example, the following command uses wget to download the wrapper:

wget https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/download/2.3.5/aws-advanced-jdbc-wrapper-2.3.5.jar

Then, the following command adds the AWS JDBC Driver to the CLASSPATH:

export CLASSPATH=$CLASSPATH:/home/userx/libs/aws-advanced-jdbc-wrapper-2.3.5.jar

Note: There is also a JAR suffixed with -bundle-federated-auth. It is an Uber JAR that contains the AWS JDBC Driver as well as all the dependencies needed to run the Federated Authentication Plugin. Our general recommendation is to use the aws-advanced-jdbc-wrapper-2.3.5.jar for use cases unrelated to complex Federated Authentication environments. To learn more, please check out the Federated Authentication Plugin.

As a Maven Dependency

You can use Maven's dependency management to obtain the AWS JDBC Driver by adding the following configuration to the application's Project Object Model (POM) file:

<dependencies>
    <dependency>
        <groupId>software.amazon.jdbc</groupId>
        <artifactId>aws-advanced-jdbc-wrapper</artifactId>
        <version>2.3.5</version>
    </dependency>
</dependencies>

As a Gradle Dependency

You can use Gradle's dependency management to obtain the AWS JDBC Driver by adding the following configuration to the application's build.gradle file:

dependencies {
    implementation group: 'software.amazon.jdbc', name: 'aws-advanced-jdbc-wrapper', version: '2.3.5'
}

To add a Gradle dependency in a Kotlin syntax, use the following configuration:

dependencies {
    implementation("software.amazon.jdbc:aws-advanced-jdbc-wrapper:2.3.5")
}

Using the AWS JDBC Driver

For more detailed information about how to use and configure the AWS JDBC Driver, please visit this page.