| 1 | import type * as docdb from "@distilled.cloud/aws/docdb"; |
| 2 | import type * as Effect from "effect/Effect"; |
| 3 | import * as Binding from "../../Binding.ts"; |
| 4 | import type { DBInstance } from "./DBInstance.ts"; |
| 5 | |
| 6 | /** |
| 7 | * Runtime binding for the `RebootDBInstance` operation (IAM action |
| 8 | * `rds:RebootDBInstance`). |
| 9 | * |
| 10 | * Reboots the bound {@link DBInstance} — e.g. an ops function applying a |
| 11 | * parameter-group change that requires a restart. The instance identifier |
| 12 | * is injected from the binding. Provide the implementation with |
| 13 | * `Effect.provide(AWS.DocDB.RebootDBInstanceHttp)`. |
| 14 | * ### Operating an Instance |
| 15 | * **Example:** Reboot an Instance |
| 16 | * ```typescript |
| 17 | * // init — bind the operation to the instance |
| 18 | * const rebootDBInstance = yield* AWS.DocDB.RebootDBInstance(instance); |
| 19 | * |
| 20 | * // runtime — optionally force a failover during the reboot |
| 21 | * yield* rebootDBInstance({ ForceFailover: false }); |
| 22 | * ``` |
| 23 | * |
| 24 | * @binding |
| 25 | */ |
| 26 | export interface RebootDBInstance extends Binding.Service< |
| 27 | RebootDBInstance, |
| 28 | "AWS.DocDB.RebootDBInstance", |
| 29 | ( |
| 30 | instance: DBInstance, |
| 31 | ) => Effect.Effect< |
| 32 | ( |
| 33 | request?: Omit<docdb.RebootDBInstanceMessage, "DBInstanceIdentifier">, |
| 34 | ) => Effect.Effect< |
| 35 | docdb.RebootDBInstanceResult, |
| 36 | docdb.RebootDBInstanceError |
| 37 | > |
| 38 | > |
| 39 | > {} |
| 40 | export const RebootDBInstance = Binding.Service<RebootDBInstance>( |
| 41 | "AWS.DocDB.RebootDBInstance", |
| 42 | ); |