Setu-TS
    Preparing search index...

    Interface IAwsSecretsClient

    Structural shape of an AWS Secrets Manager facade. The plugin never hard-depends on @aws-sdk/client-secrets-manager; inject this shape, or the provider lazily loads the SDK and adapts it to this facade.

    0.1.0

    interface IAwsSecretsClient {
        getSecretValue(secretId: string): Promise<string | null>;
        isHealthy?(): Promise<boolean>;
        putSecretValue(secretId: string, value: string): Promise<void>;
    }
    Index
    getSecretValue isHealthy? putSecretValue

    • Retrieves a secret string by id.

      Parameters

      • secretId: string

        The AWS Secrets Manager secret id

      Returns Promise<string | null>

      The secret string, or null when it does not exist

    • Optional non-mutating reachability probe (M90b). When the injected facade exposes it, the provider's health indicator reports real reachability; when omitted, the indicator reports reachable: 'unknown' rather than reading a secret as a probe — a read is not a health check and would alter the plugin's cache and billing profile.

      Returns Promise<boolean>

      true when the backend answers

      0.5.0

    • Stores a new value for a secret.

      Parameters

      • secretId: string

        The AWS Secrets Manager secret id

      • value: string

        The new secret value

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Methods