sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ FinSpace/ CreateKxUser.ts

import type * as SVC from "@distilled.cloud/aws/finspace";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";
import type { KxEnvironment } from "./KxEnvironment.ts";

/**
 * Runtime binding for `finspace:CreateKxUser` — creates a kdb user in the bound environment, mapping an IAM role to a kdb identity.
 * Provide the implementation with
 * `Effect.provide(AWS.FinSpace.CreateKxUserHttp)`.
 * ### Managing kdb Users
 * **Example:** Create a User
 * ```typescript
 * const createUser = yield* AWS.FinSpace.CreateKxUser(kdb);
 *
 * const user = yield* createUser({
 *   userName: "analyst",
 *   iamRole: roleArn,
 * });
 * ```
 *
 * @binding
 */
export interface CreateKxUser extends Binding.Service<
  CreateKxUser,
  "AWS.FinSpace.CreateKxUser",
  <K extends KxEnvironment>(
    environment: K,
  ) => Effect.Effect<
    (
      request: Omit<SVC.CreateKxUserRequest, "environmentId">,
    ) => Effect.Effect<SVC.CreateKxUserResponse, SVC.CreateKxUserError>
  >
> {}
export const CreateKxUser = Binding.Service<CreateKxUser>("AWS.FinSpace.CreateKxUser");