From c7d73a7ddd06e894683e698e6ae5892aab4be8c9 Mon Sep 17 00:00:00 2001 From: "k.goto" <24818752+go-to-k@users.noreply.github.com> Date: Fri, 30 Jun 2023 00:46:24 +0900 Subject: [PATCH] docs(s3): fix docs for BucketProps (#26140) 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* --- packages/aws-cdk-lib/aws-s3/lib/bucket.ts | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/packages/aws-cdk-lib/aws-s3/lib/bucket.ts b/packages/aws-cdk-lib/aws-s3/lib/bucket.ts index 09a36373baf83..c4129538a3edf 100644 --- a/packages/aws-cdk-lib/aws-s3/lib/bucket.ts +++ b/packages/aws-cdk-lib/aws-s3/lib/bucket.ts @@ -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;