sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ DMS/ StartReplicationTask.ts

import type * as dms from "@distilled.cloud/aws/database-migration-service";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";

/**
 * Runtime binding for `dms:StartReplicationTask`.
 *
 * Bind this operation (account-level) to start, resume, or reload a
 * replication task by ARN — the canonical DMS automation (a scheduled
 * Function that starts CDC during business hours, an event-driven Function
 * that kicks off a migration when upstream data lands). Provide the
 * implementation with `Effect.provide(AWS.DMS.StartReplicationTaskHttp)`.
 * ### Orchestrating Replication Tasks
 * **Example:** Start a Task
 * ```typescript
 * // init — account-level, no target resource
 * const startReplicationTask = yield* AWS.DMS.StartReplicationTask();
 *
 * // runtime
 * const { ReplicationTask } = yield* startReplicationTask({
 *   ReplicationTaskArn: taskArn,
 *   StartReplicationTaskType: "start-replication",
 * });
 * ```
 *
 * @binding
 */
export interface StartReplicationTask extends Binding.Service<
  StartReplicationTask,
  "AWS.DMS.StartReplicationTask",
  () => Effect.Effect<
    (
      request: dms.StartReplicationTaskMessage,
    ) => Effect.Effect<dms.StartReplicationTaskResponse, dms.StartReplicationTaskError>
  >
> {}

export const StartReplicationTask = Binding.Service<StartReplicationTask>(
  "AWS.DMS.StartReplicationTask",
);