Interface ProducerOptions

interface ProducerOptions {
    queueUrl: string;
    batchSize?: number;
    region?: string;
    sqs?: SQSClient;
    useQueueUrlAsEndpoint?: boolean;
}

Properties

queueUrl batchSize? region? sqs? useQueueUrlAsEndpoint?

Properties

queueUrl

queueUrl: string

The URL of the queue to send messages to.

Optional batchSize

batchSize?: number

The number of messages to send in a single batch.

Optional region

region?: string

The AWS region to use. If not provided, the region will be determined from the AWS_REGION environment variable or will default to `eu-west-1.

Optional sqs

sqs?: SQSClient

The SQS client to use. If not provided, a new client will be created.

Optional useQueueUrlAsEndpoint

useQueueUrlAsEndpoint?: boolean

In cases where a QueueUrl is given as input, that will be preferred as the request endpoint.

Set this value to false to ignore the QueueUrl and use the client's resolved endpoint, which may be a custom endpoint.

Settings

Member Visibility

Theme

On This Page

queueUrlbatchSizeregionsqsuseQueueUrlAsEndpoint