Skip to content

Latest commit

 

History

History
106 lines (54 loc) · 4.08 KB

API.md

File metadata and controls

106 lines (54 loc) · 4.08 KB
Raw

API Reference

Classes

Name Description
FanOutToLambdasViaQueue No description

Structs

Name Description
FanOutToLambdasViaQueueProps No description
TaskPipeDeadLetterQueueConfig No description

class FanOutToLambdasViaQueue

Implements: IConstruct, IConstruct, IConstruct, IDependable Extends: Construct

Initializer

new FanOutToLambdasViaQueue(scope: Construct, id: string, props: FanOutToLambdasViaQueueProps)
  • scope (Construct) No description
  • id (string) No description
  • props (FanOutToLambdasViaQueueProps) No description
    • workerFunctionProps (FunctionProps) No description
    • batchSize (number) A knob to tweak how many messages a work can take at a time. Default: 1.
    • taskPipeDeadLetterQueueConfig (TaskPipeDeadLetterQueueConfig) No description Default: SQS queue with 14 day retention period, allowing 2 unsuccessful dequeues before being moved to this dead-letter queue.
    • taskPipeVisibilityTimeout (Duration) Note that this number should not be less than Worker Function timeout. Default: same as Worker Function timeout.

Properties

Name Type Description
taskPipe Queue
taskPipeUrl string
worker Function
taskPipeDLQ? DeadLetterQueue Optional

Methods

grantSendMessages(grantee)

Helper method to grant access to send messages to a queue to the given identity.

Under the hood, it simply calls the corresponding SQS api.

If you need more control, feel free to operate directly against the queue object.

grantSendMessages(grantee: IGrantable): Grant
  • grantee (IGrantable) Principal to grant send rights to.

Returns:

struct FanOutToLambdasViaQueueProps

Name Type Description
workerFunctionProps FunctionProps
batchSize? number A knob to tweak how many messages a work can take at a time.
Default: 1.
taskPipeDeadLetterQueueConfig? TaskPipeDeadLetterQueueConfig Default: SQS queue with 14 day retention period, allowing 2 unsuccessful dequeues before being moved to this dead-letter queue.
taskPipeVisibilityTimeout? Duration Note that this number should not be less than Worker Function timeout.
Default: same as Worker Function timeout.

struct TaskPipeDeadLetterQueueConfig

Name Type Description
deadLetterQueue? DeadLetterQueue Default: SQS queue with 14 day retention period, allowing 2 unsuccessful dequeues before being moved to this dead-letter queue.
enabled? boolean Default: true.