Class SnsPublisher

SNS publisher for fan-out messaging.

Publishes messages to a single SNS topic, which fans them out to all subscribed endpoints (SQS queues, HTTP endpoints, Lambda functions, etc.).

Since

0.1.0

Index

Constructors

Methods

connect disconnect isReady publish

Constructors

constructor

new SnsPublisher(options: SnsPublisherOptions): SnsPublisher
Parameters
- options: SnsPublisherOptions
Returns SnsPublisher
- Defined in packages/queue-plugin/src/sns/sns-publisher.ts:118

Methods

connect

connect(): Promise<void>
Returns Promise<void>
- Defined in packages/queue-plugin/src/sns/sns-publisher.ts:126

disconnect

disconnect(): Promise<void>
Returns Promise<void>
- Defined in packages/queue-plugin/src/sns/sns-publisher.ts:143

isReady

isReady(): boolean
Returns boolean
- Defined in packages/queue-plugin/src/sns/sns-publisher.ts:151

publish

publish(message: unknown): Promise<string | undefined>
Publish a message to the configured SNS topic.
Parameters
- message: unknown
  The message payload (serialized to JSON)
Returns Promise<string | undefined>
The SNS message ID, or undefined if not available
- Defined in packages/queue-plugin/src/sns/sns-publisher.ts:161