Setu-TS
    Preparing search index...

    Interface SecretsProviderOptions

    Provider-specific options. Fields are consumed only by the matching provider; unrelated fields are ignored.

    0.1.0

    interface SecretsProviderOptions {
        accessKeyId?: string;
        address?: string;
        cacheTtl?: number;
        client?: IAwsSecretsClient | IGcpSecretsClient | IAzureSecretsClient;
        configFallback?: boolean;
        endpoint?: string;
        http?: IVaultHttp;
        mount?: string;
        prefix?: string;
        projectId?: string;
        region?: string;
        requestTimeoutMs?: number;
        secretAccessKey?: string;
        token?: string;
        vaultUrl?: string;
    }
    Index
    accessKeyId? address? cacheTtl? client? configFallback? endpoint? http? mount? prefix? projectId? region? requestTimeoutMs? secretAccessKey? token? vaultUrl?
    accessKeyId?: string

    (aws-kms) AWS access key id for the lazily-loaded client.

    address?: string

    (vault) Vault server address, e.g. https://vault.example.com.

    cacheTtl?: number

    Read-cache TTL in seconds. 0 disables caching. Default 300.

    client?: IAwsSecretsClient | IGcpSecretsClient | IAzureSecretsClient

    (aws-kms | gcp | azure) Injected client facade; bypasses the lazy SDK import. Typed as the union of the three facades — each provider validates the shape it needs.

    configFallback?: boolean

    (env) Fall back to CAPABILITIES.CONFIG for missing environment keys. Default true; false reads only the environment. Only string config values are accepted. Silently reads env only when CONFIG is absent. A non-boolean value is refused at plugin construction; other providers ignore this option.

    0.10.0

    endpoint?: string

    (aws-kms | gcp) Endpoint for the lazily-loaded client, forwarded to the provider's endpoint option; ignored when a client is injected. aws-kms takes a URL (LocalStack, a private endpoint); gcp takes host or host:port with no scheme, over TLS only.

    http?: IVaultHttp

    (vault) Injected fetch-shaped function; defaults to global fetch.

    mount?: string

    (vault) KV v2 mount path. Default secret.

    prefix?: string

    (env) Prefix prepended to the derived environment key.

    projectId?: string

    (gcp) GCP project id used to build secret resource paths.

    region?: string

    (aws-kms) AWS region for the lazily-loaded client.

    requestTimeoutMs?: number

    (vault) Bound on one Vault request, in milliseconds. A request that fails on the network or does not answer in time rejects with SecretProviderUnavailableError (503). 0 disables the bound. Default 5000.

    0.9.0

    secretAccessKey?: string

    (aws-kms) AWS secret access key for the lazily-loaded client.

    token?: string

    (vault) Vault auth token sent as X-Vault-Token.

    vaultUrl?: string

    (azure) Key Vault URL for the lazily-loaded client.

    Settings
    Member Visibility

    On This Page
    Properties