tS3Get

Retrieves a file from Amazon S3.

tS3Get Standard properties

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

The Standard
tS3Get component belongs to the Cloud family.

The component in this framework is available in all Talend
products.

Basic settings

Use 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	The Access Key ID that uniquely identifies an AWS Account. For how to get your Access Key and Access Secret, visit Getting Your AWS Access Keys.
Secret Key	The Secret Access Key, constituting the security credentials in combination with the 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 obtain AWS security credentials from Amazon EC2 instance metadata. To use this option, the Amazon EC2 instance must be started and your Job must be running on Amazon EC2. For more information, see Using an IAM Role to Grant Permissions to Applications Running on Amazon EC2 Instances.
Assume role	If you temporarily need some access permissions associated to an AWS IAM role that is not granted to your user account, select this check box to assume that role. Then specify the values for the following parameters to create a new assumed role session.
Region	Specify the AWS region by selecting a region name from the list or entering a region between double quotation marks (e.g. “us-east-1”) in the list. For more information about the AWS Region, see Regions and Endpoints.
Client-side Encrypt	Select this check box and from the Key type drop-down list displayed, select one of the following three options for encrypting the data on the client-side before sending to Amazon S3. For more information, see Protecting Data Using Client-Side Encryption. KMS-managed customer master key: use a KMS-managed customer master key (CMK) for the client-side data encryption. In the Key field, you need to specify the AWS KMS customer master key ID (CMK ID). Symmetric Master Key: use a symmetric master key (256-bit AES secret key) for the client-side data encryption. Algorithm: select the algorithm associated with the key from the list. By default, there is only one algorithm named AES. Encoding: select the encoding type associated with the key from the list, either Base64 or X509. Key or Key file: specify the key or the path to the file that stores the key. Asymmetric Master Key: use an asymmetric master key (a 1024-bit RSA key pair) for the client-side data encryption. Algorithm: select the algorithm associated with the key from the list. By default, there is only one algorithm named RSA. Public key file: specify the path to the public key file. Private key file: specify the path to the private key file.
Bucket	Specify the name of the bucket, namely the top level folder, on the S3 server.
Key	Specifiy the path to the file saved on the S3 server. Warning: This field must not start with a slash (/).
File	Name of the file to be saved locally.
Die on error	This check box is cleared by default, meaning to skip the row on error and to complete the process for error-free rows.

Advanced settings

Config client	Select this check box to configure client parameters. Client parameter: select client parameters from the list. Value: enter the parameter value. Not available when Use existing connection is selected.
Enable Accelerate Mode	Select this check box to enable fast, easy and secure transfers of files over long distances between your client and an S3 bucket. To take it into account, you should enable this acceleration mode on the S3 bucket in advance.
Use Select	Select this check box to customize the way to retrieve a file from Amazon S3. File Type: Type of the file to be retrieved Query: Query to be used for retrieving the file. Compressed Type: Compression type of the file to be compressed Header Type and Field Separator: Header type and field separator to be used for retrieving the file
S3 CSV Input Options	Select this check box to configure the CSV file input settings. This property is available only when you select the Use Select check box.
Configure Output	Select this check box to configure the settings used to output files. This property is available only when you select the Use Select check box.
JSON Record Delimiter	Set the delimiter used to separate JSON records. This property is available only when you select JSON from the Output Type drop-down list.
Add the InputStream in Global variables	Select this check box to add InputStream into global variables so that other components in the Job can use this input data. This property is available only when you select the Use Select check box.
STS Endpoint	Select this check box and in the field displayed, specify the AWS Security Token Service endpoint, for example, `sts.amazonaws.com`, 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 collect log data at the 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. This variable functions only if the Die on error check box is selected.
Records InputStream	The input stream being processed. This is an After variable and it returns a record.

Usage

Usage rule	This component can be used alone or with other S3 components, e.g. tS3Connection.
Dynamic settings	Click the [+] button to add a row in the table and fill the Code field with a context variable to choose your database connection dynamically from multiple connections planned in your Job. This feature is useful when you need to access database tables having the same data structure but in different databases, especially when you are working in an environment where you cannot change your Job settings, for example, when your Job has to be deployed and executed independent of Talend Studio. Once a dynamic parameter is defined, the Component List box in the Basic settings view becomes unusable. For examples on using dynamic parameters, see Reading data from databases through context-based dynamic connections and Reading data from different MySQL databases using dynamically loaded connection parameters. For more information on Dynamic settings and context variables, see Talend Studio User Guide.

Usage rule

This component can be used alone or with other S3 components,
e.g. tS3Connection.

Dynamic settings

Click the [+] button to add a row in the table
and fill the Code field with a context
variable to choose your database connection dynamically from multiple
connections planned in your Job. This feature is useful when you need to
access database tables having the same data structure but in different
databases, especially when you are working in an environment where you
cannot change your Job settings, for example, when your Job has to be
deployed and executed independent of Talend Studio.

Once a dynamic parameter is defined, the Component List box in the Basic
settings view becomes unusable.

For examples on using dynamic parameters, see Reading data from databases through context-based dynamic connections and Reading data from different MySQL databases using dynamically loaded connection parameters. For more information on Dynamic
settings and context variables, see Talend Studio
User Guide.

Related scenario

For tS3Get related scenarios, see Exchange files with Amazon S3.

Document get from Talend https://help.talend.com

Thank you for watching.

Docs 7.x

0 Comments

Inline Feedbacks

View all comments

tS3Get – Docs for ESB 7.x