Publish
type: "io.kestra.plugin.aws.sqs.Publish"
Publish a message to an SQS queue.
Examples
id: aws_sqs_publish
namespace: company.team
tasks:
- id: publish
type: io.kestra.plugin.aws.sqs.Publish
accessKeyId: "<access-key>"
secretKeyId: "<secret-key>"
region: "eu-central-1"
queueUrl: "https://sqs.eu-central-1.amazonaws.com/000000000000/test-queue"
from:
- data: Hello World
- data: Hello Kestra
delaySeconds: 5
Properties
from
- Type:
- string
- array
- Message
- Dynamic: ✔️
- Required: ✔️
The source of the published data.
Can be an internal storage URI, a list of SQS messages, or a single SQS message.
queueUrl
- Type: string
- Dynamic: ✔️
- Required: ✔️
The SQS queue URL. The queue must already exist.
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.
compatibilityMode
- Type: boolean
- Dynamic: ✔️
- Required: ❌
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.
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.
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.
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
messagesCount
- Type: integer
- Required: ❌
Number of published messages.
Definitions
io.kestra.plugin.aws.sqs.model.Message
Properties
data
- Type: string
- Dynamic: ✔️
- Required: ✔️
The message data.
deduplicationId
- Type: string
- Dynamic: ✔️
- Required: ❌
The message deduplication ID.
delaySeconds
- Type: integer
- Dynamic: ❌
- Required: ❌
The message delay in seconds.
groupId
- Type: string
- Dynamic: ✔️
- Required: ❌
The message group ID.
Was this page helpful?