Amazon S3 Encryption Client for Java - Amazon S3 Encryption Client
PrerequisitesInstallation

Amazon S3 Encryption Client for Java

Note

This documentation describes the Amazon S3 Encryption Client version 3.x, which is an independent library. For information about previous versions of the Amazon S3 Encryption Client, see the AWS SDK Developer Guide for your programming language.

This topic explains how to install and use the Amazon S3 Encryption Client for Java. For details about programming with the Amazon S3 Encryption Client for Java, see the amazon-s3-encryption-client-java repository on GitHub.

Topics

Prerequisites

Before you install the Amazon S3 Encryption Client for Java, be sure you have the following prerequisites.

A Java development environment

You will need Java 8 or later. On the Oracle website, go to Java SE Downloads, and then download and install the Java SE Development Kit (JDK).

If you use the Oracle JDK, you must also download and install the Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files.

AWS SDK for Java 2.x

The Amazon S3 Encryption Client for Java requires the Amazon S3 module of the AWS SDK for Java 2.x. You can install the entire SDK or just this module.

For information about updating your version of the AWS SDK for Java, see Migrating from version 1.x to 2.x of the AWS SDK for Java.

To install the AWS SDK for Java, use Apache Maven.

Installation

You can install the latest version of the Amazon S3 Encryption Client for Java in the following ways.

Manually

To install the Amazon S3 Encryption Client for Java, clone or download the amazon-s3-encryption-client-java GitHub repository.

Using Apache Maven

The Amazon S3 Encryption Client for Java is available through Apache Maven with the following dependency definition. Install the latest version offered.

<dependency>
  <groupId>software.amazon.encryption.s3</groupId>
  <artifactId>amazon-s3-encryption-client-java</artifactId>
  <version>3.x</version>
</dependency>

Optional dependencies

AWS KMS wrapping key

To use use a symmetric KMS key as your wrapping key, install the entire SDK or create a dependency for the AWS KMS module. To create a dependency, follow the instructions for specifying particular modules. Set the groupId to software.amazon.awssdk and the artifactId to kms.

Multipart upload (high-level API)

To perform multipart uploads with the high-level API, create dependencies for the AWS CRT-based Amazon S3 client. For help creating these dependencies, see Add dependencies to use the AWS CRT-based Amazon S3 client in the AWS SDK for Java 2.x Developer Guide.

For more information on multipart uploads in the Amazon S3 Encryption Client, see Multipart upload.