SQS Tasks
Properties Configuration Settings
The SQS Component provides access to Amazon's Simple Queue Service (SQS).
Remarks
The SQS Task 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 Task
The SQS Receive Task 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 task will check if the message has previously been downloaded, and will skip it if so.
SQS Send Task
The SQS Send Task uploads messages to the specified Queue. The SQS Send Task is designed to be simple to use and requires only minimal configuration. Simply set Message to the SQS message content to be uploaded.
Receiver Property List
The following is the full list of the properties of the receiver task with short descriptions. Click on the links for further details.
AccessKey | The Access Key for the Amazon Web Services account. |
Delete | Controls if the message is deleted from the queue after download. |
DownloadCacheFile | The file location where downloaded message information is cached. |
Firewall | A set of properties related to firewall access. |
HTTPProxy | A set of properties related to proxy access. |
LocalDirectory | The directory on the local machine to which messages are downloaded. |
LogFile | The file to write logging information to at runtime. |
LogMode | What information gets logged during component execution. |
MaxMessages | The maximum number of messages retrieved from the queue. |
MessageId | The ID(s) of the message to delete when the operation is set to DeleteMessage. |
MessageList | String denoting the name of the variable which contains the last object listing entries. |
Operation | The operation which will be executed by the SQS component. |
Other | Defines a set of configuration settings to be used by the component. |
Queue | The name of the queue to access. |
QueueList | String denoting the name of the variable which contains the last queue listing entries. |
QueuePrefix | QueuePrefix can be used to filter the queues listed. |
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. |
SSLAcceptServerCertAcceptAny | Tells the component to accept any server certificate. |
SSLCert | The certificate to use for client authentication during the SSL handshake. |
Timeout | A timeout for the component. |
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 task 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. |
LocalFile | The path to a local file for upload. |
LogFile | The file to write logging information to at runtime. |
LogMode | What information gets logged during component execution. |
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. |
SSLAcceptServerCertAcceptAny | Tells the component to accept any server certificate. |
SSLCert | The certificate to use for client authentication during the SSL handshake. |
Timeout | A timeout for the component. |
UseFIFOQueue | Whether the component should use FIFO queues instead of standard queues. |
Configuration Settings
The following is a list of configuration settings for the task with short descriptions. Click on the links for further details.
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. |