SQS Adapter
Properties Configuration Settings
The SQS Component provides access to Amazon's Simple Queue Service (SQS).
Remarks
The SQS Adapter connects to Amazon's SQS service to download or upload messages in queues. SQS allows you to create globally accessible queues on Amazon's servers. These queues can be used by developers to transfer data between distributed application components, without losing messages or requiring each component to always be available. Please refer to Amazon SQS documentation for details.
To begin set AccessKey and SecretKey to the corresponding values for the AWS account. Queue specifies the existing queue to work with.
SQS Receive Adapter
The SQS Receive Adapter will download messages from the specified Queue. To delete messages after they are downloaded set DeleteMode to OnSuccess.
By default if messages are not deleted they may be returned in subsequent polling intervals if they are still present in the queue. To prevent duplicate messages from being downloaded even if they are still present in the SQS queue set DownloadCacheFile to a file on disk where information about downloaded message is stored. When DownloadCacheFile is specified the adapter will check if the message has previously been downloaded, and will skip it if so.
SQS Send Adapter
The SQS Send Adapter uploads messages to the specified Queue. The SQS Send Adapter is designed to be simple to use and requires only minimal configuration. By default the adapter will read the SQS message data from the BizTalk message body, however Message may also be set explicitly.
Please refer to the section on adapter configuration for a description of how to configure receive locations and send ports for this adapter.
Receiver Property List
The following is the full list of the properties of the receiver adapter with short descriptions. Click on the links for further details.
| AccessKey | The Access Key for the Amazon Web Services account. |
| DeleteMode | Controls if and when the remote message is deleted after download. |
| DownloadCacheFile | The file location where downloaded message information is cached. |
| ErrorThreshold | The maximum number of errors before the component shuts down. |
| Firewall | A set of properties related to firewall access. |
| HTTPProxy | A set of properties related to proxy access. |
| MaxBatchSize | The maximum size, in MB, of the current batch (0 indicates no limit). |
| MaxFileCount | The maximum number of files in the current batch (0 indicates no limit). |
| MaxFileSize | The maximum size, in MB, of a file in the current batch (0 indicates no limit). |
| MaxMessages | The maximum number of messages retrieved from the queue. |
| MaxThreads | The maximum number of threads that the component may consume. |
| Other | Defines a set of configuration settings to be used by the component. |
| PollingInterval | The amount of time, in seconds, between download attempts. |
| Queue | The name of the queue to access. |
| ReceivedMessageId | The Id of the message received by the SQS component. |
| ReceivedMessageMD5 | The MD5 hash of the remote message received by the SQS component. |
| RequeueEndpoints | Whether to requeue receive endpoints if the polling interval has not been reached. |
| RuntimeLicense | Specifies the component runtime license key. |
| SecretKey | The Secret Key for the Amazon Web Services account. |
| SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to use for client authentication during the SSL handshake. |
| Timeout | A timeout for the component. |
| TransportLog | Tells the component where and how to report information about its operations. |
| URI | The Uniform Resource Identifier (URI) of the send port or receive location. |
| UseFIFOQueue | Whether the component should use FIFO queues instead of standard queues. |
| VisibilityTimeout | The visibility duration for messages in the queue in seconds. |
Sender Property List
The following is the full list of the properties of the sender adapter with short descriptions. Click on the links for further details.
| AccessKey | The Access Key for the Amazon Web Services account. |
| Firewall | A set of properties related to firewall access. |
| HTTPProxy | A set of properties related to proxy access. |
| MaxPersistentConnections | The maximum number of simultaneous persistent connections when sending. |
| MaxThreads | The maximum number of threads that the component may consume. |
| MaxTransmissionBatchSize | The maximum number of messages that can be sent in a single batch. |
| Message | The message to add to the specified queue. |
| MessageGroupId | The ID that groups together messages in a FIFO queue. |
| Other | Defines a set of configuration settings to be used by the component. |
| Queue | The name of the queue to access. |
| RuntimeLicense | Specifies the component runtime license key. |
| SecretKey | The Secret Key for the Amazon Web Services account. |
| SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to use for client authentication during the SSL handshake. |
| Timeout | A timeout for the component. |
| TransmitBatchMode | How the transmitter processes batches. |
| TransportLog | Tells the component where and how to report information about its operations. |
| URI | The Uniform Resource Identifier (URI) of the send port or receive location. |
| UseFIFOQueue | Whether the component should use FIFO queues instead of standard queues. |
Configuration Settings
The following is a list of configuration settings for the adapter with short descriptions. Click on the links for further details.
| DeleteOnSuspend | Specifies whether files may be deleted from server when message is suspended. |
| DownloadCacheFileDuration | The number of minutes that a message will remain in the download cache. |
| URL | If set, the default URL will be overridden by this value. |
| UseEC2RoleCredentials | If set to true, authenticate requests with credentials obtained from the IAM role attached to the EC2 instance. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| SSLSecurityFlags | Flags that control certificate verification. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
| TLS12SupportedGroups | The supported groups for ECC. |
| TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |