Commited all of suggestions

akira-sky · akira-sky · commit 910a7d3602db · 2024-08-15T21:41:28.000+09:00
diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-kms/test/integ.key-multi-region.ts b/packages/@aws-cdk-testing/framework-integ/test/aws-kms/test/integ.key-multi-region.ts
@@ -2,17 +2,17 @@ import { App, Stack } from 'aws-cdk-lib';
 import * as kms from 'aws-cdk-lib/aws-kms';
 import { IntegTest } from '@aws-cdk/integ-tests-alpha';
 
-class TestStack extends Stack {
+class KmsKeyMultiRegionStack extends Stack {
   constructor(scope: App) {
-    super(scope, 'TestStack');
+    super(scope, 'KmsKeyMultiRegionStack');
     new kms.Key(this, 'key', {
       multiRegion: true,
     });
   }
 }
 
 const app = new App();
-const stack = new TestStack(app);
+const stack = new KmsKeyMultiRegionStack(app);
 
 new IntegTest(app, 'kms-key-multi-region', {
   testCases: [stack],
diff --git a/packages/aws-cdk-lib/aws-kms/README.md b/packages/aws-cdk-lib/aws-kms/README.md
@@ -42,7 +42,7 @@ const key = new kms.Key(this, 'MyKey', {
 ```
 
 
-Creates a multi-Region primary key:
+Create a multi-Region primary key:
 
 ```ts
 const key = new kms.Key(this, 'MyKey', {
diff --git a/packages/aws-cdk-lib/aws-kms/lib/key.ts b/packages/aws-cdk-lib/aws-kms/lib/key.ts
@@ -470,16 +470,15 @@ export interface KeyProps {
 
   /**
    * Creates a multi-Region primary key that you can replicate in other AWS Regions.
-   * You can't change the MultiRegion value after the KMS key is created.
    *
-   * For a multi-Region key, set to this property to true.
-   * For a single-Region key, omit this property or set it to false. The default value is false.
+   * You can't change the `multiRegion` value after the KMS key is created.
    *
-   * IMPORTANT: If you change the value of the MultiRegion property on an existing KMS key, the update request fails,
+   * IMPORTANT: If you change the value of the `multiRegion` property on an existing KMS key, the update request fails,
    * regardless of the value of the UpdateReplacePolicy attribute.
    * This prevents you from accidentally deleting a KMS key by changing an immutable property value.
    *
-   * @default - false
+   * @default false
+   * @see https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html
    */
   readonly multiRegion?: boolean;
 
diff --git a/packages/aws-cdk-lib/aws-kms/test/key.test.ts b/packages/aws-cdk-lib/aws-kms/test/key.test.ts
@@ -646,7 +646,7 @@ test('fails if key policy has no IAM principals', () => {
   expect(() => app.synth()).toThrow(/A PolicyStatement used in a resource-based policy must specify at least one IAM principal/);
 });
 
-test('creates a multi-Region primary key', () => {
+test('multi-region primary key', () => {
   const stack = new cdk.Stack();
   new kms.Key(stack, 'MyKey', {
     multiRegion: true,

Original file line number	Diff line number	Diff line change
`@@ -470,16 +470,15 @@ export interface KeyProps {`
`470`	`470`
`471`	`471`	`/**`
`472`	`472`	`* Creates a multi-Region primary key that you can replicate in other AWS Regions.`
`473`		`- * You can't change the MultiRegion value after the KMS key is created.`
`474`	`473`	`*`
`475`		`- * For a multi-Region key, set to this property to true.`
`476`		`- * For a single-Region key, omit this property or set it to false. The default value is false.`
	`474`	+ * You can't change the `multiRegion` value after the KMS key is created.
`477`	`475`	`*`
`478`		`- * IMPORTANT: If you change the value of the MultiRegion property on an existing KMS key, the update request fails,`
	`476`	+ * IMPORTANT: If you change the value of the `multiRegion` property on an existing KMS key, the update request fails,
`479`	`477`	`* regardless of the value of the UpdateReplacePolicy attribute.`
`480`	`478`	`* This prevents you from accidentally deleting a KMS key by changing an immutable property value.`
`481`	`479`	`*`
`482`		`- * @default - false`
	`480`	`+ * @default false`
	`481`	`+ * @see https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html`
`483`	`482`	`*/`
`484`	`483`	`readonly multiRegion?: boolean;`
`485`	`484`