sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ MemoryDB/ BatchUpdateCluster.ts

import type * as memorydb from "@distilled.cloud/aws/memorydb";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";

/**
 * Runtime binding for the `BatchUpdateCluster` operation (IAM action
 * `memorydb:BatchUpdateCluster`).
 *
 * Applies a service update (security patch, engine upgrade) to a list of
 * clusters — pair with {@link DescribeServiceUpdates} to build patch
 * automation that applies available updates inside a maintenance window.
 * Clusters that cannot take the update are returned in
 * `UnprocessedClusters` (with the reason) rather than failing the call.
 * Provide the implementation with
 * `Effect.provide(AWS.MemoryDB.BatchUpdateClusterHttp)`.
 * ### Applying Service Updates
 * **Example:** Apply a Service Update to Clusters
 * ```typescript
 * const batchUpdateCluster = yield* MemoryDB.BatchUpdateCluster();
 *
 * const result = yield* batchUpdateCluster({
 *   ClusterNames: [clusterName],
 *   ServiceUpdate: { ServiceUpdateNameToApply: updateName },
 * });
 * // result.ProcessedClusters / result.UnprocessedClusters
 * ```
 *
 * @binding
 */
export interface BatchUpdateCluster extends Binding.Service<
  BatchUpdateCluster,
  "AWS.MemoryDB.BatchUpdateCluster",
  () => Effect.Effect<
    (
      request: memorydb.BatchUpdateClusterRequest,
    ) => Effect.Effect<memorydb.BatchUpdateClusterResponse, memorydb.BatchUpdateClusterError>
  >
> {}
export const BatchUpdateCluster = Binding.Service<BatchUpdateCluster>(
  "AWS.MemoryDB.BatchUpdateCluster",
);