feat(client-opensearch): The CreateApplication API now supports an optional kms key arn parameter to allow customers to specify a CMK for application encryption.

Author: awstools

clients/client-opensearch/src/commands/CreateApplicationCommand.ts

@@ -62,6 +62,7 @@ export interface CreateApplicationCommandOutput extends CreateApplicationRespons
  *       Value: "STRING_VALUE", // required
  *     },
  *   ],
+ *   kmsKeyArn: "STRING_VALUE",
  * };
  * const command = new CreateApplicationCommand(input);
  * const response = await client.send(command);
@@ -94,6 +95,7 @@ export interface CreateApplicationCommandOutput extends CreateApplicationRespons
  * //     },
  * //   ],
  * //   createdAt: new Date("TIMESTAMP"),
+ * //   kmsKeyArn: "STRING_VALUE",
  * // };
  *
  * ```

clients/client-opensearch/src/commands/GetApplicationCommand.ts

@@ -67,6 +67,7 @@ export interface GetApplicationCommandOutput extends GetApplicationResponse, __M
  * //   ],
  * //   createdAt: new Date("TIMESTAMP"),
  * //   lastUpdatedAt: new Date("TIMESTAMP"),
+ * //   kmsKeyArn: "STRING_VALUE",
  * // };
  *
  * ```

clients/client-opensearch/src/models/models_0.ts

@@ -1667,6 +1667,14 @@ export interface CreateApplicationRequest {
    * @public
    */
   tagList?: Tag[] | undefined;
+
+  /**
+   * <p>The Amazon Resource Name (ARN) of the KMS key used to encrypt the application's data at rest.
+   *               If provided, the application uses your customer-managed key for encryption. If omitted, the application
+   *               uses an AWS-managed key. The KMS key must be in the same region as the application.</p>
+   * @public
+   */
+  kmsKeyArn?: string | undefined;
 }
 
 /**
@@ -1758,6 +1766,12 @@ export interface CreateApplicationResponse {
    * @public
    */
   createdAt?: Date | undefined;
+
+  /**
+   * <p>The Amazon Resource Name (ARN) of the KMS key used to encrypt the application's data at rest.</p>
+   * @public
+   */
+  kmsKeyArn?: string | undefined;
 }
 
 /**
@@ -5961,6 +5975,12 @@ export interface GetApplicationResponse {
    * @public
    */
   lastUpdatedAt?: Date | undefined;
+
+  /**
+   * <p>The Amazon Resource Name (ARN) of the KMS key used to encrypt the application's data at rest.</p>
+   * @public
+   */
+  kmsKeyArn?: string | undefined;
 }
 
 /**

clients/client-opensearch/src/schemas/schemas_0.ts

@@ -755,6 +755,7 @@ const _iICO = "iamIdentityCenterOptions";
 const _iRFICAA = "iamRoleForIdentityCenterApplicationArn";
 const _iT = "instanceType";
 const _k = "key";
+const _kKA = "kmsKeyArn";
 const _lDRC = "loadDryRunConfig";
 const _lUA = "lastUpdatedAt";
 const _m = "message";
@@ -1067,16 +1068,16 @@ export var CreateApplicationRequest: StaticStructureSchema = [
   n0,
   _CAR,
   0,
-  [_cT, _n, _dS, _iICO, _aC, _tL],
-  [[0, 4], 0, () => DataSources, () => IamIdentityCenterOptionsInput, () => AppConfigs, () => TagList],
+  [_cT, _n, _dS, _iICO, _aC, _tL, _kKA],
+  [[0, 4], 0, () => DataSources, () => IamIdentityCenterOptionsInput, () => AppConfigs, () => TagList, 0],
 ];
 export var CreateApplicationResponse: StaticStructureSchema = [
   3,
   n0,
   _CARr,
   0,
-  [_i, _n, _a, _dS, _iICO, _aC, _tL, _cA],
-  [0, 0, 0, () => DataSources, () => IamIdentityCenterOptions, () => AppConfigs, () => TagList, 4],
+  [_i, _n, _a, _dS, _iICO, _aC, _tL, _cA, _kKA],
+  [0, 0, 0, () => DataSources, () => IamIdentityCenterOptions, () => AppConfigs, () => TagList, 4, 0],
 ];
 export var CreateDomainRequest: StaticStructureSchema = [
   3,
@@ -1670,8 +1671,8 @@ export var GetApplicationResponse: StaticStructureSchema = [
   n0,
   _GARe,
   0,
-  [_i, _a, _n, _en, _s, _iICO, _dS, _aC, _cA, _lUA],
-  [0, 0, 0, 0, 0, () => IamIdentityCenterOptions, () => DataSources, () => AppConfigs, 4, 4],
+  [_i, _a, _n, _en, _s, _iICO, _dS, _aC, _cA, _lUA, _kKA],
+  [0, 0, 0, 0, 0, () => IamIdentityCenterOptions, () => DataSources, () => AppConfigs, 4, 4, 0],
 ];
 export var GetCompatibleVersionsRequest: StaticStructureSchema = [3, n0, _GCVR, 0, [_DN], [[0, { [_hQ]: _dN }]]];
 export var GetCompatibleVersionsResponse: StaticStructureSchema = [

codegen/sdk-codegen/aws-models/opensearch.json

@@ -3701,6 +3701,12 @@
         },
         "tagList": {
           "target": "com.amazonaws.opensearch#TagList"
+        },
+        "kmsKeyArn": {
+          "target": "com.amazonaws.opensearch#KmsKeyArn",
+          "traits": {
+            "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the KMS key used to encrypt the application's data at rest.\n              If provided, the application uses your customer-managed key for encryption. If omitted, the application\n              uses an AWS-managed key. The KMS key must be in the same region as the application.</p>"
+          }
         }
       },
       "traits": {
@@ -3751,6 +3757,12 @@
           "traits": {
             "smithy.api#documentation": "<p>The timestamp indicating when the OpenSearch application was created.</p>"
           }
+        },
+        "kmsKeyArn": {
+          "target": "com.amazonaws.opensearch#KmsKeyArn",
+          "traits": {
+            "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the KMS key used to encrypt the application's data at rest.</p>"
+          }
         }
       },
       "traits": {
@@ -8009,6 +8021,12 @@
           "traits": {
             "smithy.api#documentation": "<p>The timestamp of the last update to the OpenSearch application.</p>"
           }
+        },
+        "kmsKeyArn": {
+          "target": "com.amazonaws.opensearch#KmsKeyArn",
+          "traits": {
+            "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the KMS key used to encrypt the application's data at rest.</p>"
+          }
         }
       },
       "traits": {
@@ -9516,6 +9534,16 @@
         "smithy.api#documentation": "<p>The configuration parameters to enable access to the key store required by the\n            package.</p>"
       }
     },
+    "com.amazonaws.opensearch#KmsKeyArn": {
+      "type": "string",
+      "traits": {
+        "smithy.api#length": {
+          "min": 20,
+          "max": 2048
+        },
+        "smithy.api#pattern": "^arn:aws[a-zA-Z-]*:kms:[a-z0-9-]+:[0-9]{12}:key/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$"
+      }
+    },
     "com.amazonaws.opensearch#KmsKeyId": {
       "type": "string",
       "traits": {