Consume

yaml

type: "io.kestra.plugin.aws.sqs.Consume"

Consume messages from a SQS queue.

Requires maxDuration or maxRecords.

Examples

yaml

id: "consume"
type: "io.kestra.plugin.aws.sqs.Consume"
accessKeyId: "<access-key>"
secretKeyId: "<secret-key>"
region: "eu-central-1"
queueUrl: "https://sqs.eu-central-1.amazonaws.com/000000000000/test-queue"

Properties

`queueUrl`

Type: string
Dynamic: ✔️
Required: ✔️

The SQS queue URL. The queue must already exist.

`serdeType`

Type: string
Dynamic: ❌
Required: ✔️
Default: STRING
Possible Values:
- STRING
- JSON

The serializer/deserializer to use.

`accessKeyId`

Type: string
Dynamic: ✔️
Required: ❌

Access Key Id in order to connect to AWS.

If no connection is defined, we will use the DefaultCredentialsProvider to fetch the value.

`compatibilityMode`

Type: boolean
Dynamic: ✔️
Required: ❌

`endpointOverride`

Type: string
Dynamic: ✔️
Required: ❌

The endpoint with which the SDK should communicate.

This property should normally not be used except for local development.

`maxDuration`

Type: string
Dynamic: ❌
Required: ❌
Format: duration

Maximum duration in the Duration ISO format, after that the task will end.

`maxRecords`

Type: integer
Dynamic: ❌
Required: ❌

Maximum number of records; when reached, the task will end.

`region`

Type: string
Dynamic: ✔️
Required: ❌

AWS region with which the SDK should communicate.

`secretKeyId`

Type: string
Dynamic: ✔️
Required: ❌

Secret Key Id in order to connect to AWS.

If no connection is defined, we will use the DefaultCredentialsProvider to fetch the value.

`sessionToken`

Type: string
Dynamic: ✔️
Required: ❌

AWS session token, retrieved from an AWS token service, used for authenticating that this user has received temporary permissions to access a given resource.

If no connection is defined, we will use the DefaultCredentialsProvider to fetch the value.

`stsEndpointOverride`

Type: string
Dynamic: ✔️
Required: ❌

The AWS STS endpoint with which the SDKClient should communicate.

`stsRoleArn`

Type: string
Dynamic: ✔️
Required: ❌

AWS STS Role.

The Amazon Resource Name (ARN) of the role to assume. If set the task will use the StsAssumeRoleCredentialsProvider. Otherwise, the StaticCredentialsProvider will be used with the provided Access Key Id and Secret Key.