Skip to main content

SQSQueueParameters

@webda/aws

Class: SQSQueueParameters

Defined in: aws/src/services/sqsqueue.service.ts:10

SQS Queue parameters

Extends​

  • QueueParameters

Implements​

Constructors​

Constructor​

new SQSQueueParameters(): SQSQueueParameters

Returns​

SQSQueueParameters

Inherited from​

QueueParameters.constructor

Properties​

CloudFormation?​

optional CloudFormation?: any

Defined in: aws/src/services/sqsqueue.service.ts:47

Any additional CloudFormation parameters

CloudFormationSkip?​

optional CloudFormationSkip?: boolean

Defined in: aws/src/services/sqsqueue.service.ts:43

Skip CloudFormation on deploy

Default​

false

credentials?​

optional credentials?: object

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

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/sqsqueue.service.ts:14

Custom endpoint (localstack, minio, ...)

Implementation of​

AWSServiceParameters.endpoint

maxConsumers​

maxConsumers: number

Defined in: core/lib/queues/queueservice.d.ts:37

Max number of queue consumers Queue will auto increase to this max number if queue is loaded and it will decrease to just one consumer if no messages are available

Default​

10

Inherited from​

QueueParameters.maxConsumers

MessageGroupId?​

optional MessageGroupId?: string

Defined in: aws/src/services/sqsqueue.service.ts:38

MessageGroupId to pass to send and receive

queue​

queue: string

Defined in: aws/src/services/sqsqueue.service.ts:34

Queue URL

Default​

""

region?​

optional region?: string

Defined in: aws/src/services/sqsqueue.service.ts:23

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​

QueueParameters.type

WaitTimeSeconds?​

optional WaitTimeSeconds?: number

Defined in: aws/src/services/sqsqueue.service.ts:29

Time to wait pending for an item

Default​

20

workerDelayer?​

optional workerDelayer?: WaitDelayerDefinition

Defined in: core/lib/queues/queueservice.d.ts:24

Delayer between two failed attempts to process messages

Inherited from​

QueueParameters.workerDelayer

workerParallelism​

workerParallelism: boolean

Defined in: core/lib/queues/queueservice.d.ts:29

Define if worker should process multi message received in //

Default​

true

Inherited from​

QueueParameters.workerParallelism

Methods​

load()​

load(params?): this

Defined in: aws/src/services/sqsqueue.service.ts:54

Parameters​

params?​

any = {}

raw parameters

Returns​

this

this

Overrides​

QueueParameters.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​

QueueParameters.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​

QueueParameters.with