Skip to main content

AWSSecretsManagerParameters

@webda/aws

Class: AWSSecretsManagerParameters

Defined in: aws/src/services/secretsmanager.service.ts:8

AWS SecretsManager parameters

Extends​

  • ServiceParameters

Implements​

Constructors​

Constructor​

new AWSSecretsManagerParameters(): AWSSecretsManagerParameters

Returns​

AWSSecretsManagerParameters

Inherited from​

ServiceParameters.constructor

Properties​

credentials?​

optional credentials?: object

Defined in: aws/src/services/secretsmanager.service.ts:16

Static credentials, default to the AWS environment variables

accessKeyId​

accessKeyId: string

secretAccessKey​

secretAccessKey: string

sessionToken?​

optional sessionToken?: string

Implementation of​

AWSServiceParameters.credentials

endpoint?​

optional endpoint?: string

Defined in: aws/src/services/secretsmanager.service.ts:12

Custom endpoint (localstack, minio, ...)

Implementation of​

AWSServiceParameters.endpoint

region?​

optional region?: string

Defined in: aws/src/services/secretsmanager.service.ts:21

AWS region

Default​

"us-east-1"

Implementation of​

AWSServiceParameters.region

type​

type: string

Defined in: core/lib/services/serviceparameters.d.ts:8

Type of the service

Inherited from​

ServiceParameters.type

Methods​

load()​

load(params?): this

Defined in: aws/src/services/secretsmanager.service.ts:28

Parameters​

params?​

any = {}

raw parameters

Returns​

this

this

Overrides​

ServiceParameters.load

update()​

update(params, delta): this

Defined in: core/lib/services/serviceparameters.d.ts:25

Update parameters and call watchers if a parameter was changed

Parameters​

params​

any

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

ServiceParameters.update

with()​

with(callback): this

Defined in: core/lib/services/serviceparameters.d.ts:31

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

ServiceParameters.with