Trigger
type: "io.kestra.plugin.aws.sqs.Trigger"
Wait for messages in a SQS queue.
Requires maxDuration
or maxRecords
.
Examples
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 connection is defined, we will use the
DefaultCredentialsProvider
to fetch the value.
conditions
- Type: array
- SubType: io.kestra.core.models.conditions.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 should normally not be used except for local development.
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 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.
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
. Otherwise, theStaticCredentialsProvider
will be used with the provided Access Key Id and Secret Key.
stsRoleExternalId
- Type: string
- Dynamic: ✔️
- Required: ❌
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.
stsRoleSessionDuration
- Type: string
- Dynamic: ❌
- Required: ❌
- Default:
900.000000000
- 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.
stsRoleSessionName
- Type: string
- Dynamic: ✔️
- Required: ❌
AWS STS Session name. This property is only used when an
stsRoleArn
is defined.
Outputs
count
- Type: integer
- Dynamic: ❓
- Required: ❌
Number of consumed rows.
uri
- Type: string
- Dynamic: ❓
- Required: ❌
- Format:
uri
File URI containing consumed messages.