Skip to content

Commit

Permalink
docs(dynamodb): the documentation is wrong around table encryption (#…
Browse files Browse the repository at this point in the history
…20938)

----
This pull request aims to resolve #16436. As mentioned in the issue, by default, no encryption is done, which is different from the documentation description. Now the documentation descriptions are updated around the table encryption as the default is for the Table to not be encrypted.

Closes #16436

----
*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
Tianyi-W authored Jul 30, 2022
1 parent 47333a1 commit 433a1fa
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions packages/@aws-cdk/aws-dynamodb/lib/table.ts
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ export interface TableOptions extends SchemaOptions {
*
* This property cannot be set if `encryption` and/or `encryptionKey` is set.
*
* @default - server-side encryption is enabled with an AWS owned customer master key
* @default - The table is encrypted with an encryption key managed by DynamoDB, and you are not charged any fee for using it.
*
* @deprecated This property is deprecated. In order to obtain the same behavior as
* enabling this, set the `encryption` property to `TableEncryption.AWS_MANAGED` instead.
Expand All @@ -213,7 +213,7 @@ export interface TableOptions extends SchemaOptions {
* > using CDKv1, make sure the feature flag
* > `@aws-cdk/aws-kms:defaultKeyPolicies` is set to `true` in your `cdk.json`.
*
* @default - server-side encryption is enabled with an AWS owned customer master key
* @default - The table is encrypted with an encryption key managed by DynamoDB, and you are not charged any fee for using it.
*/
readonly encryption?: TableEncryption;

Expand All @@ -224,6 +224,8 @@ export interface TableOptions extends SchemaOptions {
*
* @default - If `encryption` is set to `TableEncryption.CUSTOMER_MANAGED` and this
* property is undefined, a new KMS key will be created and associated with this table.
* If `encryption` and this property are both undefined, then the table is encrypted with
* an encryption key managed by DynamoDB, and you are not charged any fee for using it.
*/
readonly encryptionKey?: kms.IKey;

Expand Down

0 comments on commit 433a1fa

Please sign in to comment.