@webda/aws • Readme | API

---

Class: AWSSecretsManager<T>

Webda Modda

Extends

• Service<T>

Type parameters

• T extends AWSSecretsManagerParameters = AWSSecretsManagerParameters

Implements

• ConfigurationProvider

Constructors

new AWSSecretsManager(webda, name, params)

new AWSSecretsManager<T>(webda, name, params?): AWSSecretsManager<T>

Parameters

• webda: Core<CoreEvents>

The main instance of Webda

• name: string

The name of the service

• params?: DeepPartial<T>

The parameters block define in the configuration file

Returns

AWSSecretsManager<T>

Inherited from

Service<T>.constructor

Source

packages/core/lib/services/service.d.ts:168

Properties

_client

_client: SecretsManager

Source

packages/aws/src/services/secretsmanager.ts:14

---

_createException

_createException: string

Inherited from

Service._createException

Source

packages/core/lib/services/service.d.ts:149

---

_initException

_initException: any

Inherited from

Service._initException

Source

packages/core/lib/services/service.d.ts:151

---

_initTime

_initTime: number

Inherited from

Service._initTime

Source

packages/core/lib/services/service.d.ts:150

---

_name

protected _name: string

Service name

Inherited from

Service._name

Source

packages/core/lib/services/service.d.ts:142

---

_webda

protected _webda: Core<CoreEvents>

Webda Core object

Inherited from

Service._webda

Source

packages/core/lib/services/service.d.ts:138

---

logger

protected logger: Logger

Logger with class context

Inherited from

Service.logger

Source

packages/core/lib/services/service.d.ts:155

---

metrics?

protected metrics?: any

Get metrics

Inherited from

Service.metrics

Source

packages/core/lib/services/service.d.ts:159

---

parameters

protected parameters: T

Hold the parameters for your service

It will be bring from the webda.config.json

Inherited from

Service.parameters

Source

packages/core/lib/services/service.d.ts:148

---

captureRejectionSymbol

static readonly captureRejectionSymbol: typeof captureRejectionSymbol

Inherited from

Service.captureRejectionSymbol

Source

node_modules/@types/node/events.d.ts:38

---

captureRejections

static captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Inherited from

Service.captureRejections

Source

node_modules/@types/node/events.d.ts:44

---

defaultMaxListeners

static defaultMaxListeners: number

Inherited from

Service.defaultMaxListeners

Source

node_modules/@types/node/events.d.ts:45

---

errorMonitor

static readonly errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Inherited from

Service.errorMonitor

Source

node_modules/@types/node/events.d.ts:37

Methods

__clean()

__clean(): Promise<void>

Clean the service data, can only be used in test mode

Returns

Promise<void>

Inherited from

Service.__clean

Abstract

Source

packages/core/lib/services/service.d.ts:319

---

addListener()

addListener(event, listener): this

Parameters

• event: string | symbol

• listener: (...args) => void

Returns

this

Inherited from

Service.addListener

Source

node_modules/@types/node/events.d.ts:57

---

addRoute()

protected addRoute(url, methods, executer, openapi?, override?): void

Add a route dynamicaly

Parameters

• url: string

of the route can contains dynamic part like {uuid}

• methods: HttpMethodType[]

• executer: Function

Method to execute for this route

• openapi?: OpenAPIWebdaDefinition

• override?: boolean

Returns

void

Inherited from

Service.addRoute

Source

packages/core/lib/services/service.d.ts:242

---

authorizeClientEvent()

authorizeClientEvent(_event, _context): boolean

Authorize a public event subscription

Parameters

• _event: string

• _context: OperationContext<any, any>

Returns

boolean

Inherited from

Service.authorizeClientEvent

Source

packages/core/lib/services/service.d.ts:220

---

canTriggerConfiguration()

canTriggerConfiguration(_id, _callback): boolean

Parameters

• _id: string

• _callback: () => void

Returns

boolean

Implementation of

ConfigurationProvider.canTriggerConfiguration

Inherit Doc

Source

packages/aws/src/services/secretsmanager.ts:33

---

computeParameters()

computeParameters(): void

Returns

void

Overrides

Service.computeParameters

Inherit Doc

Source

packages/aws/src/services/secretsmanager.ts:26

---

create()

create(id, values, params): Promise<void>

Create a new secret on AWS SecretsManager

Parameters

• id: string

• values: any= {}

• params: any= {}

Returns

Promise<void>

Source

packages/aws/src/services/secretsmanager.ts:51

---

delete()

delete(SecretId, RecoveryWindowInDays, ForceDeleteWithoutRecovery): Promise<void>

Delete a secret

Parameters

• SecretId: string

to delete

• RecoveryWindowInDays: number= 7

• ForceDeleteWithoutRecovery: boolean= false

Returns

Promise<void>

Source

packages/aws/src/services/secretsmanager.ts:64

---

emit()

emit<Key>(event, data): boolean

Override to allow capturing long listeners

Type parameters

• Key extends string | number

Parameters

• event: symbol | Key

• data: Events[Key]

Returns

boolean

Inherited from

Service.emit

Source

packages/core/lib/services/service.d.ts:289

---

emitSync()

emitSync<Key>(event, data): Promise<any[]>

Emit the event with data and wait for Promise to finish if listener returned a Promise

Type parameters

• Key extends string | number

Parameters

• event: Key

• data: Events[Key]

Returns

Promise<any[]>

Inherited from

Service.emitSync

Source

packages/core/lib/services/service.d.ts:284

---

eventNames()

eventNames(): (string | symbol)[]

Returns

(string | symbol)[]

Inherited from

Service.eventNames

Source

node_modules/@types/node/events.d.ts:72

---

get()

get(SecretId): Promise<any>

Return SecretValue

Parameters

• SecretId: string

Returns

Promise<any>

JSON.parse of SecretString

Source

packages/aws/src/services/secretsmanager.ts:97

---

getARNPolicy()

getARNPolicy(accountId): Object

Parameters

• accountId: any

Returns

Object

Action

Action: string[]

Effect

Effect: string = "Allow"

Resource

Resource: string[]

Sid

Sid: string

Inherit Doc

Source

packages/aws/src/services/secretsmanager.ts:107

---

getClientEvents()

getClientEvents(): string[]

Return the events that an external system can subscribe to

Returns

string[]

Inherited from

Service.getClientEvents

Source

packages/core/lib/services/service.d.ts:214

---

getConfiguration()

getConfiguration(id): Promise<Map<string, any>>

Parameters

• id: string

Returns

Promise<Map<string, any>>

Implementation of

ConfigurationProvider.getConfiguration

Inherit Doc

Source

packages/aws/src/services/secretsmanager.ts:40

---

getMaxListeners()

getMaxListeners(): number

Returns

number

Inherited from

Service.getMaxListeners

Source

node_modules/@types/node/events.d.ts:64

---

getMetric()

getMetric<T>(type, configuration): T

Add service name label

Type parameters

• T = Counter<string> | Histogram<string> | Gauge<string>

Parameters

• type: Constructor<T, [MetricConfiguration<T>]>

• configuration: MetricConfiguration<T>

Returns

T

Inherited from

Service.getMetric

Source

packages/core/lib/services/service.d.ts:208

---

getName()

getName(): string

Get service name

Returns

string

Inherited from

Service.getName

Source

packages/core/lib/services/service.d.ts:313

---

getOpenApiReplacements()

getOpenApiReplacements(): any

Return variables for replacement in openapi

Returns

any

Inherited from

Service.getOpenApiReplacements

Source

packages/core/lib/services/service.d.ts:247

---

getOperationId()

getOperationId(id): string

If undefined is returned it cancel the operation registration

Parameters

• id: string

Returns

string

Inherited from

Service.getOperationId

Source

packages/core/lib/services/service.d.ts:234

---

getParameters()

getParameters(): T

Get the service parameters

Returns

T

Inherited from

Service.getParameters

Source

packages/core/lib/services/service.d.ts:180

---

getService()

getService<K>(service): K

Return a webda service

Type parameters

• K extends Service<ServiceParameters, Events>

Parameters

• service: string

name to retrieve

Returns

K

Inherited from

Service.getService

Source

packages/core/lib/services/service.d.ts:309

---

getUrl()

getUrl(url, _methods): string

Return the full path url based on parameters

Parameters

• url: string

relative url to service

• _methods: HttpMethodType[]

in case we need filtering (like Store)

Returns

string

absolute url or undefined if need to skip the Route

Inherited from

Service.getUrl

Source

packages/core/lib/services/service.d.ts:228

---

getWebda()

getWebda(): Core<CoreEvents>

Return WebdaCore

Returns

Core<CoreEvents>

Inherited from

Service.getWebda

Source

packages/core/lib/services/service.d.ts:184

---

init()

init(): Promise<AWSSecretsManager<T>>

Will be called after all the Services are created

Returns

Promise<AWSSecretsManager<T>>

Inherited from

Service.init

Abstract

Source

packages/core/lib/services/service.d.ts:275

---

initMetrics()

initMetrics(): void

Init the metrics

Returns

void

Inherited from

Service.initMetrics

Source

packages/core/lib/services/service.d.ts:201

---

initOperations()

initOperations(): void

Init the operations

Returns

void

Inherited from

Service.initOperations

Source

packages/core/lib/services/service.d.ts:255

---

initRoutes()

initRoutes(): void

Init the routes

Returns

void

Inherited from

Service.initRoutes

Source

packages/core/lib/services/service.d.ts:251

---

listenerCount()

listenerCount(event): number

Parameters

• event: string | symbol

Returns

number

Inherited from

Service.listenerCount

Source

node_modules/@types/node/events.d.ts:68

---

listeners()

listeners(event): Function[]

Parameters

• event: string | symbol

Returns

Function[]

Inherited from

Service.listeners

Source

node_modules/@types/node/events.d.ts:65

---

loadParameters()

loadParameters(params): AWSSecretsManagerParameters

Parameters

• params: any

Returns

AWSSecretsManagerParameters

Overrides

Service.loadParameters

Inherit Doc

Source

packages/aws/src/services/secretsmanager.ts:19

---

log()

log(level, ...args): void

Parameters

• level: WorkerLogLevel

to log

• ...args: any[]

Returns

void

Inherited from

Service.log

Source

packages/core/lib/services/service.d.ts:329

---

off()

off(event, listener): this

Parameters

• event: string | symbol

• listener: (...args) => void

Returns

this

Inherited from

Service.off

Source

node_modules/@types/node/events.d.ts:61

---

on()

on<Key>(event, listener): this

Type the listener part

Type parameters

• Key extends string | number

Parameters

• event: symbol | Key

• listener: (evt) => void

Returns

this

Inherited from

Service.on

Source

packages/core/lib/services/service.d.ts:297

---

onAsync()

onAsync<Key>(event, listener, queue?): void

Listen to an event as on(...) would do except that it will be asynchronous

Type parameters

• Key extends string | number

Parameters

• event: Key

• listener: (evt) => void

• queue?: string

Name of queue to use, can be undefined, queue name are used to define differents priorities

Returns

void

Inherited from

Service.onAsync

Source

packages/core/lib/services/service.d.ts:304

---

once()

once(event, listener): this

Parameters

• event: string | symbol

• listener: (...args) => void

Returns

this

Inherited from

Service.once

Source

node_modules/@types/node/events.d.ts:59

---

prependListener()

prependListener(event, listener): this

Parameters

• event: string | symbol

• listener: (...args) => void

Returns

this

Inherited from

Service.prependListener

Source

node_modules/@types/node/events.d.ts:70

---

prependOnceListener()

prependOnceListener(event, listener): this

Parameters

• event: string | symbol

• listener: (...args) => void

Returns

this

Inherited from

Service.prependOnceListener

Source

node_modules/@types/node/events.d.ts:71

---

put()

put(SecretId, value): Promise<void>

Store data in a AWS secret

Parameters

• SecretId: string

• value: any

Returns

Promise<void>

Source

packages/aws/src/services/secretsmanager.ts:84

---

rawListeners()

rawListeners(event): Function[]

Parameters

• event: string | symbol

Returns

Function[]

Inherited from

Service.rawListeners

Source

node_modules/@types/node/events.d.ts:66

---

reinit()

reinit(config): Promise<AWSSecretsManager<T>>

Parameters

• config: DeepPartial<T>

new parameters for the service

Returns

Promise<AWSSecretsManager<T>>

Inherited from

Service.reinit

Source

packages/core/lib/services/service.d.ts:280

---

removeAllListeners()

removeAllListeners(event?): this

Parameters

• event?: string | symbol

Returns

this

Inherited from

Service.removeAllListeners

Source

node_modules/@types/node/events.d.ts:62

---

removeListener()

removeListener(event, listener): this

Parameters

• event: string | symbol

• listener: (...args) => void

Returns

this

Inherited from

Service.removeListener

Source

node_modules/@types/node/events.d.ts:60

---

resolve()

resolve(): this

Resolve parameters Call initRoutes and initBeanRoutes

Returns

this

Inherited from

Service.resolve

Source

packages/core/lib/services/service.d.ts:197

---

setMaxListeners()

setMaxListeners(n): this

Parameters

• n: number

Returns

this

Inherited from

Service.setMaxListeners

Source

node_modules/@types/node/events.d.ts:63

---

stop()

stop(): Promise<void>

Shutdown the current service if action need to be taken

Returns

Promise<void>

Inherited from

Service.stop

Source

packages/core/lib/services/service.d.ts:188

---

toJSON()

toJSON(): string

Prevent service to be serialized

Returns

string

Inherited from

Service.toJSON

Source

packages/core/lib/services/service.d.ts:268

---

toPublicJSON()

toPublicJSON(object): string

Convert an object to JSON using the Webda json filter

Parameters

• object: unknown

The object to export

Returns

string

The export of the strip object ( removed all attribute with _ )

Inherited from

Service.toPublicJSON

Source

packages/core/lib/services/service.d.ts:263

---

toString()

toString(): string

Return service representation

Returns

string

Inherited from

Service.toString

Source

packages/core/lib/services/service.d.ts:192

---

listenerCount()

static listenerCount(emitter, event): number

Parameters

• emitter: EventEmitter

• event: string | symbol

Returns

number

Inherited from

Service.listenerCount

Deprecated

since v4.0.0

Source

node_modules/@types/node/events.d.ts:26

---

on()

static on(emitter, event): AsyncIterableIterator<any>

Parameters

• emitter: EventEmitter

• event: string

Returns

AsyncIterableIterator<any>

Inherited from

Service.on

Source

node_modules/@types/node/events.d.ts:23

---

once()

once(emitter, event)

static once(emitter, event): Promise<any[]>

Parameters

• emitter: NodeEventTarget

• event: string | symbol

Returns

Promise<any[]>

Inherited from

Service.once

Source

node_modules/@types/node/events.d.ts:21

once(emitter, event)

static once(emitter, event): Promise<any[]>

Parameters

• emitter: DOMEventTarget

• event: string

Returns

Promise<any[]>

Inherited from

Service.once

Source

node_modules/@types/node/events.d.ts:22