Skip to content

GettingStarted.md

Latest commit

 

History

History
78 lines (54 loc) · 4.04 KB

GettingStarted.md

File metadata and controls

78 lines (54 loc) · 4.04 KB

Getting Started

Minimum Requirements

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

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

If you are using the AWS Advanced JDBC Wrapper as part of a Gradle project, include the wrapper and underlying driver as dependencies. For example, to include the AWS Advanced JDBC Wrapper 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 Advanced JDBC Wrapper 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: '3.2.0'
    implementation group: 'org.postgresql', name: 'postgresql', version: '42.7.8'
}

Obtaining the AWS Advanced JDBC Wrapper

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 Advanced JDBC Wrapper. After downloading the AWS Advanced JDBC Wrapper, 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/aws/aws-advanced-jdbc-wrapper/releases/download/3.2.0/aws-advanced-jdbc-wrapper-3.2.0.jar

Then, the following command adds the AWS Advanced JDBC Wrapper to the CLASSPATH:

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

Note: There is also a JAR suffixed with -bundle-federated-auth. It is an Uber JAR that contains the AWS Advanced JDBC Wrapper as well as all the dependencies needed to run the Federated Authentication Plugin. Our general recommendation is to use the aws-advanced-jdbc-wrapper-3.2.0.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 Advanced JDBC Wrapper 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>3.2.0</version>
    </dependency>
</dependencies>

As a Gradle Dependency

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

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

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

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

Using the AWS Advanced JDBC Wrapper

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