feat(client-kafka): This release adds support for Tiered Storage. UpdateStorage allows you to control the Storage Mode for supported storage tiers.

awstools · awstools · commit 0fd7c7128d91 · 2022-10-26T18:33:57.000Z
diff --git a/clients/client-kafka/src/Kafka.ts b/clients/client-kafka/src/Kafka.ts
@@ -168,6 +168,11 @@ import {
   UpdateSecurityCommandInput,
   UpdateSecurityCommandOutput,
 } from "./commands/UpdateSecurityCommand";
+import {
+  UpdateStorageCommand,
+  UpdateStorageCommandInput,
+  UpdateStorageCommandOutput,
+} from "./commands/UpdateStorageCommand";
 import { KafkaClient } from "./KafkaClient";
 
 /**
@@ -1275,4 +1280,36 @@ export class Kafka extends KafkaClient {
       return this.send(command, optionsOrCb);
     }
   }
+
+  /**
+   * Updates cluster broker volume size (or) sets cluster storage mode to TIERED.
+   */
+  public updateStorage(
+    args: UpdateStorageCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<UpdateStorageCommandOutput>;
+  public updateStorage(
+    args: UpdateStorageCommandInput,
+    cb: (err: any, data?: UpdateStorageCommandOutput) => void
+  ): void;
+  public updateStorage(
+    args: UpdateStorageCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: UpdateStorageCommandOutput) => void
+  ): void;
+  public updateStorage(
+    args: UpdateStorageCommandInput,
+    optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateStorageCommandOutput) => void),
+    cb?: (err: any, data?: UpdateStorageCommandOutput) => void
+  ): Promise<UpdateStorageCommandOutput> | void {
+    const command = new UpdateStorageCommand(args);
+    if (typeof optionsOrCb === "function") {
+      this.send(command, optionsOrCb);
+    } else if (typeof cb === "function") {
+      if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
+      this.send(command, optionsOrCb || {}, cb);
+    } else {
+      return this.send(command, optionsOrCb);
+    }
+  }
 }
diff --git a/clients/client-kafka/src/KafkaClient.ts b/clients/client-kafka/src/KafkaClient.ts
@@ -130,6 +130,7 @@ import {
 import { UpdateConnectivityCommandInput, UpdateConnectivityCommandOutput } from "./commands/UpdateConnectivityCommand";
 import { UpdateMonitoringCommandInput, UpdateMonitoringCommandOutput } from "./commands/UpdateMonitoringCommand";
 import { UpdateSecurityCommandInput, UpdateSecurityCommandOutput } from "./commands/UpdateSecurityCommand";
+import { UpdateStorageCommandInput, UpdateStorageCommandOutput } from "./commands/UpdateStorageCommand";
 import {
   ClientInputEndpointParameters,
   ClientResolvedEndpointParameters,
@@ -173,7 +174,8 @@ export type ServiceInputTypes =
   | UpdateConfigurationCommandInput
   | UpdateConnectivityCommandInput
   | UpdateMonitoringCommandInput
-  | UpdateSecurityCommandInput;
+  | UpdateSecurityCommandInput
+  | UpdateStorageCommandInput;
 
 export type ServiceOutputTypes =
   | BatchAssociateScramSecretCommandOutput
@@ -210,7 +212,8 @@ export type ServiceOutputTypes =
   | UpdateConfigurationCommandOutput
   | UpdateConnectivityCommandOutput
   | UpdateMonitoringCommandOutput
-  | UpdateSecurityCommandOutput;
+  | UpdateSecurityCommandOutput
+  | UpdateStorageCommandOutput;
 
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
   /**
diff --git a/clients/client-kafka/src/commands/UpdateStorageCommand.ts b/clients/client-kafka/src/commands/UpdateStorageCommand.ts
@@ -0,0 +1,112 @@
+// smithy-typescript generated code
+import { EndpointParameterInstructions, getEndpointPlugin } from "@aws-sdk/middleware-endpoint";
+import { getSerdePlugin } from "@aws-sdk/middleware-serde";
+import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import {
+  FinalizeHandlerArguments,
+  Handler,
+  HandlerExecutionContext,
+  HttpHandlerOptions as __HttpHandlerOptions,
+  MetadataBearer as __MetadataBearer,
+  MiddlewareStack,
+  SerdeContext as __SerdeContext,
+} from "@aws-sdk/types";
+
+import { KafkaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KafkaClient";
+import {
+  UpdateStorageRequest,
+  UpdateStorageRequestFilterSensitiveLog,
+  UpdateStorageResponse,
+  UpdateStorageResponseFilterSensitiveLog,
+} from "../models/models_0";
+import {
+  deserializeAws_restJson1UpdateStorageCommand,
+  serializeAws_restJson1UpdateStorageCommand,
+} from "../protocols/Aws_restJson1";
+
+export interface UpdateStorageCommandInput extends UpdateStorageRequest {}
+export interface UpdateStorageCommandOutput extends UpdateStorageResponse, __MetadataBearer {}
+
+/**
+ * Updates cluster broker volume size (or) sets cluster storage mode to TIERED.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { KafkaClient, UpdateStorageCommand } from "@aws-sdk/client-kafka"; // ES Modules import
+ * // const { KafkaClient, UpdateStorageCommand } = require("@aws-sdk/client-kafka"); // CommonJS import
+ * const client = new KafkaClient(config);
+ * const command = new UpdateStorageCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link UpdateStorageCommandInput} for command's `input` shape.
+ * @see {@link UpdateStorageCommandOutput} for command's `response` shape.
+ * @see {@link KafkaClientResolvedConfig | config} for KafkaClient's `config` shape.
+ *
+ */
+export class UpdateStorageCommand extends $Command<
+  UpdateStorageCommandInput,
+  UpdateStorageCommandOutput,
+  KafkaClientResolvedConfig
+> {
+  // Start section: command_properties
+  // End section: command_properties
+
+  public static getEndpointParameterInstructions(): EndpointParameterInstructions {
+    return {
+      UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" },
+      Endpoint: { type: "builtInParams", name: "endpoint" },
+      Region: { type: "builtInParams", name: "region" },
+      UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" },
+    };
+  }
+
+  constructor(readonly input: UpdateStorageCommandInput) {
+    // Start section: command_constructor
+    super();
+    // End section: command_constructor
+  }
+
+  /**
+   * @internal
+   */
+  resolveMiddleware(
+    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
+    configuration: KafkaClientResolvedConfig,
+    options?: __HttpHandlerOptions
+  ): Handler<UpdateStorageCommandInput, UpdateStorageCommandOutput> {
+    this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
+    this.middlewareStack.use(getEndpointPlugin(configuration, UpdateStorageCommand.getEndpointParameterInstructions()));
+
+    const stack = clientStack.concat(this.middlewareStack);
+
+    const { logger } = configuration;
+    const clientName = "KafkaClient";
+    const commandName = "UpdateStorageCommand";
+    const handlerExecutionContext: HandlerExecutionContext = {
+      logger,
+      clientName,
+      commandName,
+      inputFilterSensitiveLog: UpdateStorageRequestFilterSensitiveLog,
+      outputFilterSensitiveLog: UpdateStorageResponseFilterSensitiveLog,
+    };
+    const { requestHandler } = configuration;
+    return stack.resolve(
+      (request: FinalizeHandlerArguments<any>) =>
+        requestHandler.handle(request.request as __HttpRequest, options || {}),
+      handlerExecutionContext
+    );
+  }
+
+  private serialize(input: UpdateStorageCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
+    return serializeAws_restJson1UpdateStorageCommand(input, context);
+  }
+
+  private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<UpdateStorageCommandOutput> {
+    return deserializeAws_restJson1UpdateStorageCommand(output, context);
+  }
+
+  // Start section: command_body_extra
+  // End section: command_body_extra
+}
diff --git a/clients/client-kafka/src/commands/index.ts b/clients/client-kafka/src/commands/index.ts
@@ -34,3 +34,4 @@ export * from "./UpdateConfigurationCommand";
 export * from "./UpdateConnectivityCommand";
 export * from "./UpdateMonitoringCommand";
 export * from "./UpdateSecurityCommand";
+export * from "./UpdateStorageCommand";
diff --git a/clients/client-kafka/src/models/models_0.ts b/clients/client-kafka/src/models/models_0.ts
@@ -4,16 +4,16 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-cl
 import { KafkaServiceException as __BaseException } from "./KafkaServiceException";
 
 /**
- * Contains information about provisioned throughput for EBS storage volumes attached to kafka broker nodes.
+ * <p>Contains information about provisioned throughput for EBS storage volumes attached to kafka broker nodes.</p>
  */
 export interface ProvisionedThroughput {
   /**
-   * Provisioned throughput is enabled or not.
+   * <p>Provisioned throughput is enabled or not.</p>
    */
   Enabled?: boolean;
 
   /**
-   * Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
+   * <p>Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.</p>
    */
   VolumeThroughput?: number;
 }
@@ -28,7 +28,7 @@ export interface BrokerEBSVolumeInfo {
   KafkaBrokerNodeId: string | undefined;
 
   /**
-   * EBS volume provisioned throughput information.
+   * <p>EBS volume provisioned throughput information.</p>
    */
   ProvisionedThroughput?: ProvisionedThroughput;
 
@@ -72,7 +72,7 @@ export interface ConnectivityInfo {
  */
 export interface EBSStorageInfo {
   /**
-   * EBS volume provisioned throughput information.
+   * <p>EBS volume provisioned throughput information.</p>
    */
   ProvisionedThroughput?: ProvisionedThroughput;
 
@@ -358,6 +358,11 @@ export interface OpenMonitoringInfo {
   Prometheus: PrometheusInfo | undefined;
 }
 
+export enum StorageMode {
+  LOCAL = "LOCAL",
+  TIERED = "TIERED",
+}
+
 /**
  * <p>Provisioned cluster.</p>
  */
@@ -411,6 +416,11 @@ export interface Provisioned {
    * <p>The connection string to use to connect to the Apache ZooKeeper cluster on a TLS port.</p>
    */
   ZookeeperConnectStringTls?: string;
+
+  /**
+   * <p>This controls storage mode for supported storage tiers.</p>
+   */
+  StorageMode?: StorageMode | string;
 }
 
 /**
@@ -669,6 +679,11 @@ export interface ClusterInfo {
    * <p>The connection string to use to connect to zookeeper cluster on Tls port.</p>
    */
   ZookeeperConnectStringTls?: string;
+
+  /**
+   * <p>This controls storage mode for supported storage tiers.</p>
+   */
+  StorageMode?: StorageMode | string;
 }
 
 /**
@@ -784,6 +799,11 @@ export interface MutableClusterInfo {
    * <p>Information about the broker access configuration.</p>
    */
   ConnectivityInfo?: ConnectivityInfo;
+
+  /**
+   * <p>This controls storage mode for supported storage tiers.</p>
+   */
+  StorageMode?: StorageMode | string;
 }
 
 /**
@@ -1406,6 +1426,11 @@ export interface CreateClusterRequest {
    * <p>Create tags when creating the cluster.</p>
    */
   Tags?: Record<string, string>;
+
+  /**
+   * <p>This controls storage mode for supported storage tiers.</p>
+   */
+  StorageMode?: StorageMode | string;
 }
 
 export interface CreateClusterResponse {
@@ -1473,6 +1498,11 @@ export interface ProvisionedRequest {
    * <p>The number of broker nodes in the cluster.</p>
    */
   NumberOfBrokerNodes: number | undefined;
+
+  /**
+   * <p>This controls storage mode for supported storage tiers.</p>
+   */
+  StorageMode?: StorageMode | string;
 }
 
 /**
@@ -2410,6 +2440,48 @@ export interface UpdateSecurityResponse {
   ClusterOperationArn?: string;
 }
 
+/**
+ * <p>Request object for UpdateStorage api. Its used to update the storage attributes for the cluster.</p>
+ */
+export interface UpdateStorageRequest {
+  /**
+   * <p>The Amazon Resource Name (ARN) of the cluster to be updated.</p>
+   */
+  ClusterArn: string | undefined;
+
+  /**
+   * <p>The version of cluster to update from. A successful operation will then generate a new version.</p>
+   */
+  CurrentVersion: string | undefined;
+
+  /**
+   * <p>EBS volume provisioned throughput information.</p>
+   */
+  ProvisionedThroughput?: ProvisionedThroughput;
+
+  /**
+   * <p>Controls storage mode for supported storage tiers.</p>
+   */
+  StorageMode?: StorageMode | string;
+
+  /**
+   * <p>size of the EBS volume to update.</p>
+   */
+  VolumeSizeGB?: number;
+}
+
+export interface UpdateStorageResponse {
+  /**
+   * <p>The Amazon Resource Name (ARN) of the cluster.</p>
+   */
+  ClusterArn?: string;
+
+  /**
+   * <p>The Amazon Resource Name (ARN) of the cluster operation.</p>
+   */
+  ClusterOperationArn?: string;
+}
+
 /**
  * @internal
  */
@@ -3271,3 +3343,17 @@ export const UpdateSecurityRequestFilterSensitiveLog = (obj: UpdateSecurityReque
 export const UpdateSecurityResponseFilterSensitiveLog = (obj: UpdateSecurityResponse): any => ({
   ...obj,
 });
+
+/**
+ * @internal
+ */
+export const UpdateStorageRequestFilterSensitiveLog = (obj: UpdateStorageRequest): any => ({
+  ...obj,
+});
+
+/**
+ * @internal
+ */
+export const UpdateStorageResponseFilterSensitiveLog = (obj: UpdateStorageResponse): any => ({
+  ...obj,
+});
diff --git a/clients/client-kafka/src/protocols/Aws_restJson1.ts b/clients/client-kafka/src/protocols/Aws_restJson1.ts
diff --git a/codegen/sdk-codegen/aws-models/kafka.json b/codegen/sdk-codegen/aws-models/kafka.json
