Class: SQSQueueParameters
Extends
AWSServiceParametersMixin<typeofQueueParameters,this> &QueueParameters<this>
Constructors
new SQSQueueParameters(params)
new SQSQueueParameters(
params):SQSQueueParameters
Parameters
• params: any
Returns
Overrides
AWSServiceParameters(QueueParameters).constructor
Source
packages/aws/src/services/sqsqueue.ts:37
Properties
CloudFormation?
CloudFormation?:
any
Any additional CloudFormation parameters
Source
packages/aws/src/services/sqsqueue.ts:35
CloudFormationSkip?
CloudFormationSkip?:
boolean
Skip CloudFormation on deploy
Default
false
Source
packages/aws/src/services/sqsqueue.ts:31
MessageGroupId?
MessageGroupId?:
string
MessageGroupId to pass to send and receive
Source
packages/aws/src/services/sqsqueue.ts:26
WaitTimeSeconds?
WaitTimeSeconds?:
number
Time to wait pending for an item
Default
20
Source
packages/aws/src/services/sqsqueue.ts:12
credentials?
credentials?:
Object
Type declaration
accessKeyId
accessKeyId:
string
secretAccessKey
secretAccessKey:
string
sessionToken?
sessionToken?:
string
Inherited from
AWSServiceParameters(QueueParameters).credentials
Source
packages/aws/src/services/aws-mixin.ts:24
endpoint?
endpoint?:
string
Endpoint to pass to the AWS client Useful for localstack
Overrides
AWSServiceParameters(QueueParameters).endpoint
Source
packages/aws/src/services/sqsqueue.ts:17
maxConsumers
maxConsumers:
number
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
AWSServiceParameters(QueueParameters).maxConsumers
Source
packages/core/lib/queues/queueservice.d.ts:38
openapi?
openapi?:
OpenAPIWebdaDefinition
OpenAPI override
Schema Ignore
Inherited from
AWSServiceParameters(QueueParameters).openapi
Source
packages/core/lib/services/service.d.ts:104
queue
queue:
string
Queue URL
Default
""
Source
packages/aws/src/services/sqsqueue.ts:22
region?
region?:
string
Inherited from
AWSServiceParameters(QueueParameters).region
Source
packages/aws/src/services/aws-mixin.ts:29
type
type:
string
Type of the service
Inherited from
AWSServiceParameters(QueueParameters).type
Source
packages/core/lib/services/service.d.ts:95
url?
url?:
string
URL on which to serve the content
Inherited from
AWSServiceParameters(QueueParameters).url
Source
packages/core/lib/services/service.d.ts:99
workerDelayer?
workerDelayer?:
WaitDelayerDefinition
Delayer between two failed attempts to process messages
Inherited from
AWSServiceParameters(QueueParameters).workerDelayer
Source
packages/core/lib/queues/queueservice.d.ts:25
workerParallelism?
workerParallelism?:
boolean
Define if worker should process multi message received in //
Default
true
Inherited from
AWSServiceParameters(QueueParameters).workerParallelism
Source
packages/core/lib/queues/queueservice.d.ts:30