Skip to content

Commit

Permalink
fix(Java): ESDK does not support KmsAsyncClient
Browse files Browse the repository at this point in the history
  • Loading branch information
texastony authored Jun 8, 2022
1 parent 9863c71 commit 0bb2108
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc_source/java.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ If you don't have Bouncy Castle, go to [Bouncy Castle latest releases](https://b
**AWS SDK for Java \(Optional\)**
The AWS Encryption SDK for Java does not require the AWS SDK for Java\. However, the AWS SDK for Java is required to use [AWS Key Management Service](https://aws.amazon.com/kms/) \(AWS KMS\) as a master key provider\. It's also required for some of the Java code examples in this guide\.
Beginning in the AWS Encryption SDK for Java version 2\.4\.0, the AWS Encryption SDK for Java supports both version 1\.x and 2\.x of the AWS SDK for Java\. AWS Encryption SDK code for the AWS SDK for Java 1\.x and 2\.x are interoperable\. For example, you can encrypt data with AWS Encryption SDK code that supports AWS SDK for Java 1\.x and decrypt it using code that supports AWS SDK for Java 2\.x \(or vice versa\)\. Versions of the AWS Encryption SDK for Java earlier than 2\.4\.0 support only AWS SDK for Java 1\.x\. For information about updating your version of the AWS Encryption SDK, see [Migrating to AWS Encryption SDK Versions 2\.0\.*x* and later](migration.md)\.
When updating your AWS Encryption SDK for Java code from the AWS SDK for Java 1\.x to AWS SDK for Java 2\.x, replace references to the [`AWSKMS` interface](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/kms/package-summary.html) in AWS SDK for Java 1\.x with references to the [`KmsClient` interface](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/kms/package-summary.html) in AWS SDK for Java 2\.x\. Also, update your code to use the AWS KMS\-related objects in the `kmssdkv2` namespace, instead of the `kms` namespace\.
When updating your AWS Encryption SDK for Java code from the AWS SDK for Java 1\.x to AWS SDK for Java 2\.x, replace references to the [`AWSKMS` interface](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/kms/package-summary.html) in AWS SDK for Java 1\.x with references to the [`KmsClient` interface](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/kms/package-summary.html) in AWS SDK for Java 2\.x\. The AWS Encryption SDK for Java does not support the `KmsAsyncClient` interface. Also, update your code to use the AWS KMS\-related objects in the `kmssdkv2` namespace, instead of the `kms` namespace\.
To install the AWS SDK for Java, use Apache Maven\.
+ To [import the entire AWS SDK for Java](https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/setup-project-maven.html#build-the-entire-sdk-into-your-project) as a dependency, declare it in your `pom.xml` file\.
+ To create a dependency only for the AWS KMS module in AWS SDK for Java 1\.x, follow the instructions for [specifying particular modules](https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/setup-project-maven.html#modules-dependencies), and set the `artifactId` to `aws-java-sdk-kms`\.
Expand All @@ -50,4 +50,4 @@ The AWS Encryption SDK for Java is available through [Apache Maven](https://mave
</dependency>
```

After you install the SDK, get started by looking at the [example Java code](java-example-code.md) in this guide and the [Javadoc on GitHub](https://aws.github.io/aws-encryption-sdk-java/)\.
After you install the SDK, get started by looking at the [example Java code](java-example-code.md) in this guide and the [Javadoc on GitHub](https://aws.github.io/aws-encryption-sdk-java/)\.

0 comments on commit 0bb2108

Please sign in to comment.