Message Headers

This section lists the headers you can map for the Connector for Amazon SQS.

To map and transform Solace and Amazon SQS message headers and payloads, see Mapping Message Headers and Payloads.

Amazon SQS supports a maximum of 10 headers. Because of this limitation:

For version XXX and later of the Connector for Amazon SQS, only a system-generated ID header is mapped automatically to Amazon SQS. Therefore you must ensure that you map a maximum of only nine additional headers.
For versions of the Connector for Amazon SQS prior to XXX, the target connector automatically maps the following headers individually to Amazon SQS:
- solace_correlationId
- solace_expiration
- solace_applicationMessageId
- solace_replyTo (converted from a Destination object into a string in the format <DESTINATION_TYPE>:<DESTINATION_NAME>, for example, QUEUE:replyTo_queue)
- solace_replicationGroupMessageId (converted to a string)
- sqs_groupId
- sqs_deduplicationId
Custom headers are aggregated and mapped to a solace_user_properties header as JSON, for example:
```
"{"customHeader1":"value1","customHeader2":"value2","customHeader3":"value3"}"
```

Headers for Amazon SQS as a Source

This section lists the headers you can map when Amazon SQS is configured as a source.

Amazon SQS Source Headers

Name	Type	Description
`Sqs_Msa_ApproximateReceiveCount`	`String`	An approximate count of the number of times a message has been received.
`Sqs_Msa_ApproximateFirstReceiveTimestamp`	`String`	An approximate time when the message was first received.
`Sqs_QueueName`	`String`	The name of the queue.
`Sqs_QueueUrl`	`String`	The URL of the queue.
`Sqs_Msa_SenderId`	`String`	The sender ID for the message.
`Sqs_Msa_SentTimestamp`	`String`	The time when the message was sent.
`Sqs_Msa_MessageGroupId`	`String`	Indicates the ID of the message group that the message belongs to. This property applies only to SQS FIFO queues.

Solace Target Headers

Name	Type	Description
`scst_targetDestination`	`String`	A dynamic destination for the message.
`solace_applicationMessageId`	`String`	The message ID (a string for an application-specific message identifier).
`solace_applicationMessageType`	`String`	The application message type.
`solace_correlationId`	`String`	The correlation ID of the message.
`solace_dmqEligible`	`Boolean`	Indicates whether the message is eligible to be moved to a dead message queue (DMQ).
`solace_expiration`	`Long`	The UTC time (in milliseconds, from midnight, January 1, 1970 UTC) when the message is supposed to expire.
`solace_httpContentEncoding`	`String`	The HTTP content encoding header value from interaction with an HTTP client.
`solace_isReply`	`Boolean`	Indicates whether the message is a reply to another message.
`solace_priority`	`Integer`	The message priority value in the range of 0-255, or -1 if it is not set.
`solace_senderId`	`String`	The sender ID for the message.
`solace_senderTimestamp`	`Long`	The send timestamp (in milliseconds, from midnight, January 1, 1970 UTC).
`solace_sequenceNumber`	`Long`	The sequence number.
`solace_timeToLive`	`Long`	The number of milliseconds before the message is discarded or moved to a dead message queue (DMQ).

Headers for Amazon SQS as a Target

This section lists the headers you can map when Amazon SQS is configured as a target.

Solace Source Headers

Name	Type	Description
`solace_applicationMessageId`	`String`	The message ID (a string for an application-specific message identifier).
`solace_applicationMessageType`	`String`	The application message type.
`solace_correlationId`	`String`	The correlation ID of the message.
`solace_deliveryCount`	`Integer`	The number of times the message has been delivered to clients.
`solace_discardIndication`	`Boolean`	Indicates whether one or more messages have been discarded prior to the current message.
`solace_dmqEligible`	`Boolean`	Indicates whether the message is eligible to be moved to a dead message queue (DMQ).
`solace_expiration`	`Long`	The UTC time (in milliseconds, from midnight, January 1, 1970 UTC) when the message is set to expire.
`solace_httpContentEncoding`	`String`	The HTTP content encoding header value from interaction with an HTTP client.
`solace_isReply`	`Boolean`	Indicates whether the message is a reply to another message.
`solace_priority`	`Integer`	The message priority value in the range of 0-255, or -1 if it is not set.
`solace_receiveTimestamp`	`Long`	The receive timestamp (in milliseconds, from midnight, January 1, 1970 UTC).
`solace_redelivered`	`Boolean`	Indicates whether the event broker has delivered the message to the API before.
`solace_senderId`	`String`	The sender ID for the message.
`solace_senderTimestamp`	`Long`	The send timestamp (in milliseconds, from midnight, January 1, 1970 UTC).
`solace_sequenceNumber`	`Long`	The sequence number.
`solace_timeToLive`	`Long`	The number of milliseconds before the message is discarded or moved to a dead message queue (DMQ).

Amazon SQS Target Headers

Name	Type	Description
`scst_targetDestination`	`String`	A dynamic destination for the message.
`sqs_groupId`	`String`	Indicates the ID of the message group that the message belongs to. This property is mandatory for and applies only to SQS FIFO queues.
`sqs_deduplicationId`	`String`	The message deduplication ID is a token used to prevent duplicate message delivery. This property applies only to SQS FIFO queues.

Reserved Message Headers

The following are reserved header spaces:

solace_
scst_
Any headers defined by the core Spring messaging framework. For more information, see Spring Integration: Message Headers.

Any headers with these prefixes (that are not defined by the connector or any technology used by the connector) may not be backwards compatible in future versions of this connector.

Provide feedback