Interface SecretsProviderOptions

Runtime hooks required to implement a Gestalt secrets provider.

interface SecretsProviderOptions {
    name?: string;
    displayName?: string;
    description?: string;
    version?: string;
    configure?: ConfigureHandler;
    healthCheck?: HealthCheckHandler;
    warnings?: string[] | WarningsHandler;
    start?: StartHandler;
    close?: CloseHandler;
    getSecret: (name: string) => MaybePromise<string>;
}

Hierarchy (View Summary)

RuntimeProviderOptions
- SecretsProviderOptions

Index

Properties

name? displayName? description? version? configure? healthCheck? warnings? start? close? getSecret

Properties

`Optional`name

name?: string

`Optional`displayName

displayName?: string

`Optional`description

description?: string

`Optional`version

version?: string

`Optional`configure

configure?: ConfigureHandler

`Optional`healthCheck

healthCheck?: HealthCheckHandler

`Optional`warnings

warnings?: string[] | WarningsHandler

`Optional`start

start?: StartHandler

`Optional`close

close?: CloseHandler

getSecret

getSecret: (name: string) => MaybePromise<string>