@jackdbd/secret-manager-utils

Index

Interfaces

Functions

Functions

accessSecretVersion

accessSecretVersion(__namedParameters: AccessSecretVersionConfig): Promise<string>

- Defined in access-secret-version.ts:13
Parameters
- __namedParameters: AccessSecretVersionConfig
Returns Promise<string>

addSecretVersion

addSecretVersion(__namedParameters: AddSecretVersionConfig): Promise<ISecretVersion>

- Defined in add-secret-version.ts:16
Add a new version of an existing secret.

Parameters
- __namedParameters: AddSecretVersionConfig
Returns Promise<ISecretVersion>

createSecretAndFirstVersion

createSecretAndFirstVersion(__namedParameters: CreateSecretAndFirstVersionConfig): Promise<{ secret: ISecret; version: ISecretVersion }>

- Defined in create-secret.ts:14
Parameters
- __namedParameters: CreateSecretAndFirstVersionConfig
Returns Promise<{ secret: ISecret; version: ISecretVersion }>

destroySecretVersionsMatchingFilter

destroySecretVersionsMatchingFilter(__namedParameters: DestroySecretVersionsMatchingFilterConfig): Promise<{ destroyed: { etag?: string; name?: string }[]; message: string }>

- Defined in destroy-secret-versions.ts:18
Destroy all versions of a secret that match the given string filter.

See here: https://cloud.google.com/secret-manager/docs/filtering

Parameters
- __namedParameters: DestroySecretVersionsMatchingFilterConfig
Returns Promise<{ destroyed: { etag?: string; name?: string }[]; message: string }>

disableSecretVersionsMatchingFilter

disableSecretVersionsMatchingFilter(__namedParameters: DisableSecretVersionsMatchingFilterConfig): Promise<{ disabled: { etag?: string; name?: string }[]; message: string }>

- Defined in disable-secret-versions.ts:18
Disable all versions of a secret that match the given string filter.

See here: https://cloud.google.com/secret-manager/docs/filtering

Parameters
- __namedParameters: DisableSecretVersionsMatchingFilterConfig
Returns Promise<{ disabled: { etag?: string; name?: string }[]; message: string }>

secretManagerStore

secretManagerStore<T>(__namedParameters: Config): Store<T>

- Defined in store.ts:23
Store that retrieves data from, and persists data to, Secret Manager.

Type Parameters
- T
Parameters
- __namedParameters: Config
Returns Store<T>

Generated using TypeDoc