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: "{{ secret('AWS_ACCESS_KEY_ID') }}"
  secretKeyId: "{{ secret('AWS_SECRET_ACCESS_KEY') }}"
  region: "{{ secret('AWS_DEFAULT_REGION') }}"
  queueUrl: https://sqs.eu-central-1.amazonaws.com/000000000000/test-queue

Use AWS SQS Realtime Trigger to push events into DynamoDB

yaml
    id: sqs_realtime_trigger
    namespace: company.team

    tasks:
      - id: insert_into_dynamoDB
        type: io.kestra.plugin.aws.dynamodb.PutItem
        accessKeyId: "{{ secret('AWS_ACCESS_KEY_ID') }}"
        secretKeyId: "{{ secret('AWS_SECRET_KEY_ID') }}"
        region: eu-central-1
        tableName: orders
        item:
          order_id: "{{ trigger.data | jq('.order_id') | first }}"
          customer_name: "{{ trigger.data | jq('.customer_name') | first }}"
          customer_email: "{{ trigger.data | jq('.customer_email') | first }}"
          product_id: "{{ trigger.data | jq('.product_id') | first }}"
          price: "{{ trigger.data | jq('.price') | first }}"
          quantity: "{{ trigger.data | jq('.quantity') | first }}"
          total: "{{ trigger.data | jq('.total') | first }}"

    triggers:
      - id: realtime_trigger
        type: io.kestra.plugin.aws.sqs.RealtimeTrigger
        accessKeyId: "{{ secret('AWS_ACCESS_KEY_ID') }}"
        secretKeyId: "{{ secret('AWS_SECRET_KEY_ID') }}"
        region: eu-central-1
        queueUrl: https://sqs.eu-central-1.amazonaws.com/000000000000/orders
        serdeType: JSON

The SQS queue URL. The queue must already exist.

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.

Default 3

The maximum number of attempts used by the SQS client's retry strategy.

SubType

List of conditions in order to limit the flow trigger.

The endpoint with which the SDK should communicate.

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

Default 5

The maximum number of messages returned from request made to SQS.

Increasing this value can reduce the number of requests made to SQS. Amazon SQS never returns more messages than this value (fewer messages might be returned). Valid values: 1 to 10. Setting this value to 1 would increase your AWS cost and latency because it requires more API requests to SQS. Note that Realtime Triggers always create one execution per message, regardless of the value of this property.

AWS region with which the SDK should communicate.

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.

Default STRING

Possible Values

STRINGJSON

The serializer/deserializer to use.

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

Possible Values

CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPED

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

The AWS STS endpoint with which the SDKClient should communicate.

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.

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.

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.

AWS STS Session name.

This property is only used when an stsRoleArn is defined.

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