Kamelet Catalog

aws sqs sink AWS SQS Sink

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Sends each message as an SQS message to an Amazon SQS (Simple Queue Service) queue.

Use it to hand work to other systems that read the queue, such as orders to process or jobs to run, and to buffer it when they are slow or down. For a FIFO queue use aws-sqs-fifo-sink, to send many parts in one call use aws-sqs-batch-sink, and to notify many receivers at once use aws-sns-sink.

Input: the body becomes the body of the SQS message, as text; bytes and streams are read as text. Turn structured data such as a Map into JSON text first, for example with json-serialize-action. The other headers of the message, except the Camel ones, are sent as SQS message attributes.

Output: the message is unchanged. The CamelAwsSqsMessageId header gives the ID of the SQS message.

Good to know: unless queueURL, queueOwnerAWSAccountId or an ARN in queueNameOrArn gives the address of the queue, the queue is looked up by listing the queues, which needs the sqs:ListQueues permission besides sqs:SendMessage. delaySeconds keeps each message hidden for a while after it is sent. serverSideEncryptionEnabled with kmsMasterKeyId changes the queue itself when the integration starts, so that SQS encrypts its messages with that KMS key. To reach a local stand-in of AWS, use overrideEndpoint and uriEndpointOverride. To reach AWS through an HTTP proxy, set proxyHost and proxyPort, and set proxyProtocol to HTTP for a proxy that takes plain HTTP, such as Squid. Headers that start with CamelAwsSqs are removed from the message first, so they cannot change what the Kamelet does.

Configuration Options

The following table summarizes the configuration options available for the aws-sqs-sink Kamelet:

Property Name Description Type Default Example

queueNameOrArn

Queue Name

Required The name of the queue, such as orders, or its ARN (Amazon Resource Name), such as arn:aws:sqs:eu-west-1:123456789012:orders.

string

orders

region

AWS Region

Required The AWS region of the queue, as a region code such as eu-west-1 or us-east-1.

Enum values:

* ap-south-1 * eu-south-1 * us-gov-east-1 * me-central-1 * ca-central-1 * eu-central-1 * us-iso-west-1 * us-west-1 * us-west-2 * af-south-1 * eu-north-1 * eu-west-3 * eu-west-2 * eu-west-1 * ap-northeast-3 * ap-northeast-2 * ap-northeast-1 * me-south-1 * sa-east-1 * ap-east-1 * cn-north-1 * us-gov-west-1 * ap-southeast-1 * ap-southeast-2 * us-iso-east-1 * ap-southeast-3 * us-east-1 * us-east-2 * cn-northwest-1 * us-isob-east-1 * aws-global * aws-cn-global * aws-us-gov-global * aws-iso-global * aws-iso-b-global

string

eu-west-1

accessKey

Access Key

The access key ID of an IAM user, which you create in the AWS console under IAM, Users, Security credentials. Use it together with secretKey. Leave both out when useDefaultCredentialsProvider or useProfileCredentialsProvider is true.

string

amazonAWSHost

AWS Host

The host name of AWS. Leave it as amazonaws.com for AWS. Any other value is the address to connect to instead, as host:port, together with protocol; uriEndpointOverride does the same.

string

amazonaws.com

autoCreateQueue

Autocreate Queue

If true, the queue is created when it does not exist. A name that ends in .fifo creates a FIFO queue. The credentials need the permission to create queues.

boolean

false

delaySeconds

Delay Seconds

How long SQS keeps each message hidden after it is sent, before a reader can receive it, in seconds, from 0 to 900 (15 minutes). Use it to process a message later, such as a retry in a minute. When it is not set, the delay of the queue is used, which is 0 for a new queue.

integer

60

kmsMasterKeyId

KMS Key ID

The key of AWS KMS for the queue to encrypt its messages with, as its key ID, such as 1234abcd-12ab-34cd-56ef-1234567890ab, an alias, such as alias/aws/sqs, or its ARN. Only used when serverSideEncryptionEnabled is true.

string

alias/aws/sqs

messageHeaderExceededLimit

Too Many Headers

What to do when a message has more than 10 headers to send as message attributes, the most that SQS takes: WARN sends 10 of them and logs a warning for each other one, WARN_ONCE sends 10 and logs one warning, IGNORE sends 10 without a warning, and FAIL fails the message, which is not sent. The 10 that are sent are the first 10 in the order the headers were set on the message. When it is not set, it is WARN.

Enum values:

* WARN * WARN_ONCE * IGNORE * FAIL

string

FAIL

overrideEndpoint

Endpoint Overwrite

If true, it connects to the address in uriEndpointOverride instead of to AWS. Use it for a local stand-in of AWS such as LocalStack.

boolean

false

profileCredentialsName

Profile Credentials Name

The name of the profile in the AWS credentials file. Only used when useProfileCredentialsProvider is true; when it is not set, the default profile is used.

string

production

protocol

Protocol

https or http. Only used when amazonAWSHost is not amazonaws.com.

string

https

http

proxyHost

Proxy Host

The host name or IP address of an HTTP proxy to send the calls to AWS through, such as the proxy of a company network. Used only together with proxyPort. When it is not set, the calls go straight to AWS.

string

proxy.example.com

proxyPort

Proxy Port

The port of the proxy in proxyHost, such as 3128 for Squid. Used only together with proxyHost.

integer

3128

proxyProtocol

Proxy Protocol

How to talk to the proxy itself: HTTP or HTTPS. It is not the protocol of the calls to AWS, which stay encrypted, as the proxy only passes them on. When it is not set, it is HTTPS, which needs a proxy that takes TLS connections. Most company proxies, such as Squid, take plain HTTP: set HTTP for them. With the wrong one, every call fails, for example with Unsupported or unrecognized SSL message.

Enum values:

* HTTP * HTTPS

string

HTTP

queueOwnerAWSAccountId

Queue Owner AWS Account ID

The 12-digit ID of the AWS account that owns the queue, such as 123456789012. When it is set, the address of the queue is built from the account, region and the queue name, and the queue is not looked up by listing the queues. Use it for a queue of another AWS account, or when the credentials may not list the queues. An ARN in queueNameOrArn gives the account too.

string

123456789012

queueURL

Queue URL

The full address of the queue, as the SQS console shows it. When it is set, the messages are sent to it, and the queue is not looked up by listing the queues, which needs the sqs:ListQueues permission.

string

https://sqs.eu-west-1.amazonaws.com/123456789012/orders

secretKey

Secret Key

The secret access key that belongs to accessKey. The AWS console shows it only once, when the access key is created.

string

serverSideEncryptionEnabled

Server-Side Encryption

If true, the queue is set to encrypt its messages with the key of AWS KMS in kmsMasterKeyId (SSE-KMS). It changes the queue itself: when the integration starts, an existing queue is updated, which needs the sqs:SetQueueAttributes permission, and a queue that autoCreateQueue creates is created with it. Without kmsMasterKeyId, it has no effect.

boolean

sessionToken

Session Token

The session token of temporary credentials, which comes with their access key and secret key, for example from AWS STS when you assume an IAM role. Only used when useSessionCredentials is true.

string

uriEndpointOverride

Overwrite Endpoint URI

The address to connect to instead of AWS, as a URL such as http://localhost:4566 for LocalStack. Only used when overrideEndpoint is true.

string

http://localhost:4566

useDefaultCredentialsProvider

Default Credentials Provider

If true, the credentials are found in the environment instead of in accessKey and secretKey: the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables, the ~/.aws/credentials file, or the IAM role of the EC2 instance, ECS task or Kubernetes pod the integration runs on.

boolean

false

useProfileCredentialsProvider

Profile Credentials Provider

If true, the credentials are read from a named profile in the AWS credentials file (~/.aws/credentials), as the AWS CLI does. Name the profile in profileCredentialsName.

boolean

false

useSessionCredentials

Session Credentials

If true, it logs in with temporary credentials: accessKey, secretKey and sessionToken, such as the ones AWS STS gives when you assume an IAM role.

boolean

false

Dependencies

At runtime, the aws-sqs-sink Kamelet relies upon the presence of the following dependencies:

  • camel:aws2-sqs

  • camel:kamelet

Camel JBang usage

Prerequisites

  • You’ve installed JBang.

  • You have executed the following command:

jbang app install camel@apache/camel

Supposing you have a file named route.yaml with this content:

- route:
    from:
      uri: "kamelet:timer-source"
      parameters:
        period: 10000
        message: 'test'
      steps:
        - to:
            uri: "kamelet:aws-sqs-sink"

You can now run it directly through the following command

camel run route.yaml

AWS SQS Sink Kamelet Description

Authentication methods

In this Kamelet you can avoid using explicit static credentials by specifying the useDefaultCredentialsProvider option and set it to true.

The order of evaluation for Default Credentials Provider is the following:

  • Java system properties - aws.accessKeyId and aws.secretKey.

  • Environment variables - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.

  • Web Identity Token from AWS STS.

  • The shared credentials and config files.

  • Amazon ECS container credentials - loaded from the Amazon ECS if the environment variable AWS_CONTAINER_CREDENTIALS_RELATIVE_URI is set.

  • Amazon EC2 Instance profile credentials.

You can also use the Profile Credentials Provider, by setting the useProfileCredentialsProvider option to true and profileCredentialsName to the profile name.

Only one of access key/secret key or default credentials provider could be used

For more information, see the AWS credentials documentation

Delaying the Messages

delaySeconds keeps each message hidden for that many seconds after it is sent, up to 900 (15 minutes), before a reader can receive it. Use it to process a message later, such as a retry in a minute.

Without Permission to List the Queues

By default the Kamelet finds the address of the queue by listing the queues, which needs the sqs:ListQueues permission. It does not list the queues when it is given the address:

  • Queue URL (queueURL): the full address of the queue, as the SQS console shows it.

  • Queue Owner AWS Account ID (queueOwnerAWSAccountId): the 12-digit ID of the account that owns the queue. The address is then built from the account, the region and the queue name. Use it for a queue of another AWS account too.

  • An ARN in Queue Name (queueNameOrArn), which holds the account.

Too Many Headers

An SQS message takes at most 10 message attributes. When a message has more than 10 headers to send, the first 10 are sent, and messageHeaderExceededLimit sets what happens to the others: WARN (the default) logs a warning for each one, WARN_ONCE logs one warning, IGNORE logs nothing, and FAIL fails the message, which is then not sent.

Encrypting the Queue

serverSideEncryptionEnabled and kmsMasterKeyId set the queue to encrypt its messages with a key of AWS KMS (SSE-KMS). They change the queue itself, not only the messages of this Kamelet: when the integration starts, an existing queue is updated, which needs the sqs:SetQueueAttributes permission, and a queue that autoCreateQueue creates is created with the key. serverSideEncryptionEnabled without kmsMasterKeyId has no effect.

For example, to send to a queue without listing the queues, with each message delayed by one minute, and failing a message with too many headers:

- to:
    uri: "kamelet:aws-sqs-sink"
    parameters:
      queueNameOrArn: "orders"
      region: "eu-west-1"
      queueURL: "https://sqs.eu-west-1.amazonaws.com/123456789012/orders"
      delaySeconds: 60
      messageHeaderExceededLimit: "FAIL"

Through an HTTP Proxy

Where AWS can be reached only through an HTTP proxy, as in many company networks, set proxyHost and proxyPort to the proxy. proxyProtocol is how the Kamelet talks to the proxy itself, not to AWS: it is HTTPS when it is not set, so set it to HTTP for a proxy that takes plain HTTP, such as Squid. The calls to AWS stay encrypted, as the proxy only passes them on. The Kamelet has no option for a proxy user or password.

The step that sends to the Kamelet, in a route:

- to:
    uri: "kamelet:aws-sqs-sink"
    parameters:
      queueNameOrArn: "orders"
      region: "eu-west-1"
      useDefaultCredentialsProvider: true
      proxyHost: "proxy.example.com"
      proxyPort: 3128
      proxyProtocol: "HTTP"