sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ GlobalAccelerator/ RemoveEndpoints.ts

import type * as ga from "@distilled.cloud/aws/global-accelerator";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";
import type { EndpointGroup } from "./EndpointGroup.ts";

/**
 * Runtime binding for `globalaccelerator:RemoveEndpoints`.
 *
 * Deregisters endpoints from the bound {@link EndpointGroup} at runtime —
 * e.g. draining an instance before it is terminated. Unlike a full
 * `UpdateEndpointGroup`, removing endpoints leaves the group's other
 * endpoints and health-check configuration untouched. The endpoint group
 * ARN is injected from the binding. Provide the implementation with
 * `Effect.provide(AWS.GlobalAccelerator.RemoveEndpointsHttp)`.
 * ### Managing Endpoints
 * **Example:** Deregister an Endpoint
 * ```typescript
 * // init — bind the operation to the endpoint group
 * const removeEndpoints = yield* AWS.GlobalAccelerator.RemoveEndpoints(group);
 *
 * // runtime
 * yield* removeEndpoints({
 *   EndpointIdentifiers: [{ EndpointId: allocationId }],
 * });
 * ```
 *
 * @binding
 */
export interface RemoveEndpoints extends Binding.Service<
  RemoveEndpoints,
  "AWS.GlobalAccelerator.RemoveEndpoints",
  (
    endpointGroup: EndpointGroup,
  ) => Effect.Effect<
    (
      request: Omit<ga.RemoveEndpointsRequest, "EndpointGroupArn">,
    ) => Effect.Effect<ga.RemoveEndpointsResponse, ga.RemoveEndpointsError>
  >
> {}
export const RemoveEndpoints = Binding.Service<RemoveEndpoints>(
  "AWS.GlobalAccelerator.RemoveEndpoints",
);