interface SecretsProviderOptions
Since 0.1.0

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

Properties

optional
cacheTtl: number

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

optional
prefix: string

(env) Prefix prepended to the derived environment key.

optional
region: string

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

optional
accessKeyId: string

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

optional
secretAccessKey: string

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

optional
projectId: string

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

optional
vaultUrl: string

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

optional
address: string

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

optional
token: string

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

optional
mount: string

(vault) KV v2 mount path. Default secret.

(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.

optional
http: IVaultHttp

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

Usage

import { type SecretsProviderOptions } from "secrets-plugin/src/index.ts";