Skip to content

Commit

Permalink
docs(s3): fix docs for BucketProps (#26140)
Browse files Browse the repository at this point in the history
This PR fixes BucketProps documentation for S3 that is not so good.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
go-to-k authored Jun 29, 2023
1 parent 8153237 commit c7d73a7
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions packages/aws-cdk-lib/aws-s3/lib/bucket.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1344,18 +1344,18 @@ export interface BucketProps {
* If you choose KMS, you can specify a KMS key via `encryptionKey`. If
* encryption key is not specified, a key will automatically be created.
*
* @default - `Kms` if `encryptionKey` is specified, or `Managed` otherwise.
* @default - `KMS` if `encryptionKey` is specified, or `UNENCRYPTED` otherwise.
* But if `UNENCRYPTED` is specified, the bucket will be encrypted as `S3_MANAGED` automatically.
*/
readonly encryption?: BucketEncryption;

/**
* External KMS key to use for bucket encryption.
*
* The 'encryption' property must be either not specified or set to "Kms".
* An error will be emitted if encryption is set to "Unencrypted" or
* "Managed".
* The `encryption` property must be either not specified or set to `KMS` or `DSSE`.
* An error will be emitted if `encryption` is set to `UNENCRYPTED` or `S3_MANAGED`.
*
* @default - If encryption is set to "Kms" and this property is undefined,
* @default - If `encryption` is set to `KMS` and this property is undefined,
* a new KMS key will be created and associated with this bucket.
*/
readonly encryptionKey?: kms.IKey;
Expand Down

0 comments on commit c7d73a7

Please sign in to comment.