Trigger

yaml

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

Consume messages periodically from an SQS queue and create one execution per batch.

Requires maxDuration or maxRecords. Note that you don't need an extra task to consume the message from the event trigger. The trigger will automatically consume messages and you can retrieve their content in your flow using the {{ trigger.uri }} variable. If you would like to consume each message from an SQS queue in real-time and create one execution per message, you can use the io.kestra.plugin.aws.sqs.RealtimeTrigger instead.

Examples

yaml

id: sqs
namespace: company.team

tasks:
  - id: log
    type: io.kestra.plugin.core.log.Log
    message: "{{ trigger.data }}"

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

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 credentials are defined, we will use the default credentials provider chain to fetch credentials.

`conditions`

Type: array
SubType: Condition
Dynamic: ❌
Required: ❌

List of conditions in order to limit the flow trigger.

`endpointOverride`

Type: string
Dynamic: ✔️
Required: ❌

The endpoint with which the SDK should communicate.

This property allows you to use a different S3 compatible storage backend.

`interval`

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

Interval between polling.

The interval between 2 different polls of schedule, this can avoid to overload the remote system with too many calls. For most of the triggers that depend on external systems, a minimal interval must be at least PT30S. See ISO_8601 Durations for more information of available interval values.

`maxDuration`

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

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

`maxRecords`

Type: integer
Dynamic: ❌
Required: ❌

Max 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 credentials are defined, we will use the default credentials provider chain to fetch credentials.

`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 credentials are defined, we will use the default credentials provider chain to fetch credentials.

`stopAfter`

Type: array
SubType: string
Dynamic: ❌
Required: ❌

List of execution states after which a trigger should be stopped (a.k.a. disabled).

`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. If no credentials are defined, we will use the default credentials provider chain to fetch credentials.