RealtimeTrigger

Consume a message in real-time from an SQS queue and create one execution per message.

If you would like to consume multiple messages processed within a given time frame and process them in batch, you can use the io.kestra.plugin.aws.sqs.Trigger instead.

yaml
type: "io.kestra.plugin.aws.sqs.RealtimeTrigger"

Consume a message from an SQS queue in real-time.

yaml
id: sqs
namespace: company.team

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

triggers:
- id: realtime_trigger
  type: io.kestra.plugin.aws.sqs.RealtimeTrigger
  accessKeyId: "access_key"
  secretKeyId: "secret_key"
  region: "eu-central-1"
  queueUrl: https://sqs.eu-central-1.amazonaws.com/000000000000/test-queue

Dynamic YES

The SQS queue URL. The queue must already exist.

Dynamic YES

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.

Dynamic YES

Default 3

SubType

Dynamic NO

List of conditions in order to limit the flow trigger.

Dynamic YES

The endpoint with which the SDK should communicate.

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

Dynamic YES

Default 5

Dynamic YES

AWS region with which the SDK should communicate.

Dynamic YES

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.

Dynamic YES

Default STRING

Possible Values

STRINGJSON

The serializer/deserializer to use.

Dynamic YES

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.

SubType string

Dynamic NO

Possible Values

CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPED

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

Dynamic YES

The AWS STS endpoint with which the SDKClient should communicate.

Dynamic YES

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.

Dynamic YES

AWS STS External Id.

A unique identifier that might be required when you assume a role in another account. This property is only used when an stsRoleArn is defined.

Dynamic YES

Default PT15M

Format duration

AWS STS Session duration.

The duration of the role session (default: 15 minutes, i.e., PT15M). This property is only used when an stsRoleArn is defined.

Dynamic YES

AWS STS Session name.

This property is only used when an stsRoleArn is defined.

Dynamic YES

Default PT20S

Format duration

The duration for which the SQS client waits for a message.

The message data.

The message deduplication ID.

The message delay in seconds.

The message group ID.

​Realtime​Trigger

RealtimeTrigger