Skip to content

Commit 14bc6ad

Browse files
Readme edits (#227)
Co-authored-by: Kevin Lee <[email protected]>
1 parent d3e7920 commit 14bc6ad

File tree

1 file changed

+21
-27
lines changed

1 file changed

+21
-27
lines changed

README.md

+21-27
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
# AWS Database Encryption SDK for DynamoDB in Java
22

3-
The AWS Database Encryption SDK for DynamoDB in Java
4-
provides client-side encryption and signing of Amazon DynamoDB items
5-
to help you protect your table's data before you send it to DynamoDB.
3+
The AWS Database Encryption SDK (DB-ESDK) for DynamoDB in Java is a client-side encryption
4+
library that allows you to perform attribute-level encryption, enabling you to encrypt specific
5+
attribute values within items before storing them in your DynamoDB table. All encryption and
6+
decryption are performed within your application. This lets you protect sensitive data in-transit
7+
and at-rest, as data cannot be exposed unless decrypted by your application.
68

7-
For more details about the design and architecture of the
8-
AWS Database Encryption SDK (DB-ESDK) for DynamoDB,
9+
For more details about the design and architecture of the DB-ESDK for DynamoDB,
910
see the [AWS Database Encryption SDK Developer Guide](https://docs.aws.amazon.com/database-encryption-sdk/latest/devguide/).
1011

1112
# Security
1213
If you discover a potential security issue in this project
1314
we ask that you notify AWS/Amazon Security via our
1415
[vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/).
15-
Please do **not** create a public GitHub issue.
16+
Please **do not** create a public GitHub issue.
1617

1718
# Support Policy
1819
See [Support Policy](./SUPPORT_POLICY.rst) for details
@@ -30,14 +31,14 @@ submitting pull requests through the following channels:
3031
* Articulate your
3132
[feature request](https://github.com/aws/aws-database-encryption-sdk-dynamodb-java/issues?q=is%3Aopen+is%3Aissue+label%3A%22feature-request%22)
3233
or upvote existing ones
34+
* Ask [questions](https://repost.aws/tags/TAc3VKZnkNQyimpHnCHetNOQ/aws-crypto-tools) on AWS re:Post under AWS Crypto Tools tag
3335

3436
# Getting Started
3537

3638
## Required Prerequisites
3739
To use the DB-ESDK for DynamoDB in Java, you must have:
3840

3941
* **A Java 8 or newer development environment**
40-
4142
If you do not have one,
4243
go to [Java SE Downloads](https://www.oracle.com/technetwork/java/javase/downloads/index.html) on the Oracle website,
4344
then download and install the Java SE Development Kit (JDK).
@@ -48,11 +49,12 @@ To use the DB-ESDK for DynamoDB in Java, you must have:
4849
the [Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files](http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html).
4950

5051
* **Declare a Dependency on the DB-ESDK for DynamoDB in Java and it's dependencies**
51-
The DB-ESDK for DynamoDB in Java requires the Dynamodb-Enhanced client
52-
from the AWS SDK for Java V2.
53-
It also requires the AWS Cryptographic Material Providers library.
52+
This library requires the DynamoDB client
53+
from the AWS SDK for Java V2
54+
and the AwsCryptographicMaterialProviders library.
5455

55-
The KMS and DynamoDB Clients are **optional** dependencies.
56+
The KMS and DynamoDB-Enhanced Clients from the AWS SDK For Java V2
57+
are **optional** dependencies.
5658

5759
* **Via Gradle Kotlin**
5860
In a Gradle Java Project, add the following to the _dependencies_ section:
@@ -112,35 +114,27 @@ To use the DB-ESDK for DynamoDB in Java, you must have:
112114
```
113115

114116
### AWS Integration
115-
You need an Amazon Web Services (AWS) account to use
116-
the AWS Database Encryption SDK for DynamoDB
117-
(a KMS Key is optional).
117+
You need an Amazon Web Services (AWS) account to use the DB-ESDK for DynamoDB as it's specifically designed to work with Amazon DynamoDB. Optionally, you can use AWS Key Management Service (AWS KMS) as your main keyring provider.
118118

119119
* **To create an AWS account**, go to
120120
[Sign In or Create an AWS Account](https://portal.aws.amazon.com/gp/aws/developer/registration/index.html)
121121
and then choose **I am a new user.**
122122
Follow the instructions to create an AWS account.
123123

124-
* **To create a key in AWS KMS**, see
124+
* **(Optional) To create a key in AWS KMS**, see
125125
[Creating Keys](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html).
126126

127127
### Amazon Corretto Crypto Provider
128-
Many users find that the Amazon Corretto Crypto Provider (ACCP)
129-
significantly improves the performance of
130-
the AWS Database Encryption SDK for DynamoDB in Java.
128+
Many developers find that the Amazon Corretto Crypto Provider (ACCP)
129+
significantly improves the performance of the library.
131130
For help installing and using ACCP, see the
132131
[amazon-corretto-crypto-provider repository](https://github.com/corretto/amazon-corretto-crypto-provider).
133132

134133
## Using the DB-ESDK for DynamoDB in Java
135-
There are several ways to use the
136-
AWS Database Encryption SDK (DB-ESDK) for DynamoDB in Java.
137-
Please read the
138-
[AWS Database Encryption SDK Developer Guide](https://docs.aws.amazon.com/database-encryption-sdk/latest/devguide/)
139-
for guidance.
140-
Also see the
141-
[DynamoDbEncryption Examples](Examples/runtimes/java/DynamoDbEncryption)
142-
and the
143-
[Migration Examples](Examples/runtimes/java/Migration).
134+
There are several ways to use the library.
135+
More details are provided in the
136+
[AWS Database Encryption SDK Developer Guide](https://docs.aws.amazon.com/database-encryption-sdk/latest/devguide/).
137+
Also see the [Examples](Examples/runtimes/java/DynamoDbEncryption).
144138

145139
# Contributing
146140

0 commit comments

Comments
 (0)