Skip to content

Commit

Permalink
chore: Add DB-ESDK 3.x section to README
Browse files Browse the repository at this point in the history
  • Loading branch information
lavaleri committed Aug 15, 2023
1 parent ba75855 commit 3f8b162
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Client-side Encryption for Amazon DynamoDB

📣 Note: Version 3.x of this library is available,
and has been renamed to the AWS Database Encryption SDK.
See the [AWS Database Encryption SDK 3.x](#aws-database-encryption-sdk-3.x) section for more information.

The **[Amazon DynamoDB][ddb] Client-side Encryption in Java** supports encryption and signing of your data when stored in Amazon DynamoDB.

A typical use of this library is when you are using [DynamoDBMapper][ddbmapper], where transparent protection of all objects serialized through the mapper can be enabled via configuring an [AttributeEncryptor][attrencryptor].
Expand All @@ -13,6 +17,15 @@ For more advanced use cases where tighter control over the encryption and signin

See [Support Policy](./SUPPORT_POLICY.rst) for for details on the current support status of all major versions of this library.

## AWS Database Encryption SDK 3.x

The 3.x version of this library is generally available, and has been [renamed to the AWS Database Encryption SDK](https://docs.aws.amazon.com/database-encryption-sdk/latest/devguide/DDBEC-rename.html).
It is a major rewrite of the DynamoDB Encryption Client for Java
and includes many updates, such as a new structured data format, improved multitenancy support, seamless schema changes, and searchable encryption support.

For more information see the [AWS Database Encryption SDK Developer Guide](https://docs.aws.amazon.com/database-encryption-sdk/latest/devguide/what-is-database-encryption-sdk.html).
or check the project repository at [https://github.com/aws/aws-database-encryption-sdk-dynamodb-java/](https://github.com/aws/aws-database-encryption-sdk-dynamodb-java/).

## Getting Started

### Required Prerequisites
Expand Down

0 comments on commit 3f8b162

Please sign in to comment.