August 16, 2023

tSQSQueuePurge – Docs for ESB 6.x

tSQSQueuePurge

Purges messages in an Amazon SQS (Simple Queue Service) queue.

tSQSQueuePurge Standard properties

These properties are used to configure tSQSQueuePurge running in the
Standard Job framework.

The Standard tSQSQueuePurge component belongs to the Cloud family.

The component in this framework is generally available.

Basic settings

Use an existing connection

Select this check box and in the Component
List
click the relevant connection component to reuse the connection
details you already defined.

Access Key and Secret Key

Specify the access keys (the access key ID in the Access
Key
field and the secret access key in the Secret
Key
field) required to access the Amazon Web Services. For more information
about AWS access keys, see Access keys (access key ID and secret access
key)
.

To enter the secret key, click the […] button next to
the secret key field, and then in the pop-up dialog box enter the password between double
quotes and click OK to save the settings.

Inherit credentials from AWS
role

Select this check box to leverage the instance profile credentials. These
credentials can be used on Amazon EC2 instances, and are delivered through the Amazon EC2
metadata service. To use this option, your Job must be running within Amazon EC2 or other
services that can leverage IAM Roles for access to resources. For more information, see Using an IAM Role to Grant Permissions to
Applications Running on Amazon EC2 Instances
.

Assume role

Select this check box and specify the values for the following parameters used to
create a new assumed role session.

  • Role ARN: the Amazon Resource Name (ARN) of the
    role to assume.

  • Role session name: an identifier for the
    assumed role session.

  • Session duration (minutes): the duration (in
    minutes) for which we want to have the assumed role session to be active.

For more information about assuming roles, see AssumeRole.

Region

Specify the AWS region by selecting a region name from the list or entering a
region between double quotation marks (for example “us-east-1”) in the
list. For more information about AWS Regions, see AWS Regions and Endpoints.

Queue (Name or URL)

Specify the name or URL of the queue in which the
messages will be purged.

Die on error

Select the check box to stop the execution of the Job when an error
occurs.

Advanced settings

Config client

Select this check box and in the table displayed specify the client configuration
parameters. Click the [+] button below the table to add as many rows as
needed, each row for a client configuration parameter, and set the value of the following
attributes for each parameter:

  • Client Parameter: click the cell and select a
    parameter from the drop-down list.

  • Value: enter the value for the corresponding
    parameter.

STS Endpoint

Select this check box and in the field displayed, specify the AWS Security Token
Service endpoint where session credentials are retrieved from.

This check box is available only when the Assume
role
check box is selected.

tStatCatcher Statistics

Select this check box to gather the Job processing metadata at the Job level
as well as at each component level.

Global variables

ERROR_MESSAGE

The error message generated by the component when an error occurs.
This is an After variable and it returns a string.

Usage

Usage Rule

This component can be used as a standalone component of a Job or Subjob.

Related scenario

No scenario is available for this component yet.


Document get from Talend https://help.talend.com
Thank you for watching.
Subscribe
Notify of
guest
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x