sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ S3Control/ GetMultiRegionAccessPointRoutes.ts

import type * as s3control from "@distilled.cloud/aws/s3-control";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";
import type { MultiRegionAccessPoint } from "./MultiRegionAccessPoint.ts";

/**
 * Runtime binding for `s3:GetMultiRegionAccessPointRoutes`.
 *
 * Reads the bound {@link MultiRegionAccessPoint}'s per-region routing
 * configuration (each region's `TrafficDialPercentage`) — the observe half
 * of an active/passive failover controller. Requests are routed to the
 * `us-west-2` MRAP control plane. Provide the implementation with
 * `Effect.provide(AWS.S3Control.GetMultiRegionAccessPointRoutesHttp)`.
 * ### Controlling Multi-Region Failover
 * **Example:** Read the Current Routes
 * ```typescript
 * // init — bind the operation to the Multi-Region Access Point
 * const getRoutes =
 *   yield* AWS.S3Control.GetMultiRegionAccessPointRoutes(mrap);
 *
 * // runtime
 * const { Routes } = yield* getRoutes();
 * // Routes?.map((r) => `${r.Region}: ${r.TrafficDialPercentage}%`)
 * ```
 *
 * @binding
 */
export interface GetMultiRegionAccessPointRoutes extends Binding.Service<
  GetMultiRegionAccessPointRoutes,
  "AWS.S3Control.GetMultiRegionAccessPointRoutes",
  (
    mrap: MultiRegionAccessPoint,
  ) => Effect.Effect<
    () => Effect.Effect<
      s3control.GetMultiRegionAccessPointRoutesResult,
      s3control.GetMultiRegionAccessPointRoutesError
    >
  >
> {}
export const GetMultiRegionAccessPointRoutes = Binding.Service<GetMultiRegionAccessPointRoutes>(
  "AWS.S3Control.GetMultiRegionAccessPointRoutes",
);