Skip to main content

SnsSmsSenderParameters

@webda/aws

Class: SnsSmsSenderParameters

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

SnsSmsSender parameters

Extends​

  • ServiceParameters

Implements​

Constructors​

Constructor​

new SnsSmsSenderParameters(): SnsSmsSenderParameters

Returns​

SnsSmsSenderParameters

Inherited from​

ServiceParameters.constructor

Properties​

credentials?​

optional credentials?: object

Defined in: aws/src/services/snssmssender.service.ts:18

Static credentials, default to the AWS environment variables

Can be encrypted with webda config encrypt

accessKeyId​

accessKeyId: string | SecretString

secretAccessKey​

secretAccessKey: string | SecretString

sessionToken?​

optional sessionToken?: string | SecretString

Implementation of​

AWSServiceParameters.credentials

endpoint?​

optional endpoint?: string

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

Custom endpoint (localstack, ...)

Implementation of​

AWSServiceParameters.endpoint

originationNumber?​

optional originationNumber?: string

Defined in: aws/src/services/snssmssender.service.ts:35

Origination number (E.164) registered in AWS End User Messaging

region?​

optional region?: string

Defined in: aws/src/services/snssmssender.service.ts:27

AWS region

Default​

"us-east-1"

Implementation of​

AWSServiceParameters.region

senderId?​

optional senderId?: string

Defined in: aws/src/services/snssmssender.service.ts:31

Alphanumeric sender ID shown to recipients, in the countries supporting it

type​

type: string

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

Type of the service

Inherited from​

ServiceParameters.type

Methods​

load()​

load(params?): this

Defined in: aws/src/services/snssmssender.service.ts:42

Parameters​

params?​

any = {}

raw parameters

Returns​

this

this

Overrides​

ServiceParameters.load

update()​

update(params, delta): this

Defined in: core/lib/application/parameters.d.ts:21

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/application/parameters.d.ts:27

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