13.2. Configuration Options

queueNameOrArn *

Queue Name

The SQS Queue Name or ARN.

string

region *

AWS Region

The AWS region to access.

string

accessKey

Access Key

The access key obtained from AWS.

string

amazonAWSHost

AWS Host

The hostname of the Amazon AWS cloud.

string

amazonaws.com

autoCreateQueue

Autocreate Queue

Setting the autocreation of the SQS queue.

boolean

False

delay

Delay

The number of milliseconds before the next poll of the selected stream.

integer

500

deleteAfterRead

Auto-delete Messages

Delete messages after consuming them.

boolean

True

greedy

Greedy Scheduler

If greedy is enabled, then the polling will happen immediately again, if the previous run polled 1 or more messages.

boolean

False

maxMessagesPerPoll

Max Messages Per Poll

The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values 1 to 10. Default 1.

integer

1

overrideEndpoint

Endpoint Overwrite

Select this option to override the endpoint URI. To use this option, you must also provide a URI for the uriEndpointOverride option.

boolean

False

profileCredentialsName

Profile Credentials Name

If using a profile credentials provider this parameter sets the profile name.

string

protocol

Protocol

The underlying protocol used to communicate with SQS.

string

https

http or https

queueURL

Queue URL

The full SQS Queue URL (required if using KEDA).

string

secretKey

Secret Key

The secret key obtained from AWS.

string

sessionToken

Session Token

Amazon AWS Session Token used when the user needs to assume a IAM role.

string

uriEndpointOverride

Overwrite Endpoint URI

The overriding endpoint URI. To use this option, you must also select the overrideEndpoint option.

string

useDefaultCredentialsProvider

Default Credentials Provider

If true, the SQS client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key).

boolean

False

useProfileCredentialsProvider

Profile Credentials Provider

Set whether the SQS client should expect to load credentials through a profile credentials provider.

boolean

False

useSessionCredentials

Session Credentials

Set whether the SQS client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in SQS.

boolean

False

visibilityTimeout

Visibility Timeout

The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

integer

waitTimeSeconds

Wait Time Seconds

The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call does not return a message list.

integer