August 16, 2023

tS3Connection – Docs for ESB 6.x

tS3Connection

Establishes a connection to Amazon S3 to store and retrieve data.

tS3Connection Standard properties

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

The Standard
tS3Connection component belongs to the Cloud family.

The component in this framework is generally available.

Basic settings

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

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 (e.g. “us-east-1”) in the
list. For more information about the AWS Region, see Regions and Endpoints.

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.

Advanced settings

Use a custom region endpoint

Select this check box to use a custom endpoint and in the field
displayed, specify the URL of the custom endpoint to be used.

Config client

Select this check box to configure client parameters.

Client parameter: select client
parameters from the list.

Value: enter the parameter value.

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 collect log data at the component
level.

Global Variables

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
cleared, if the component has this check box.

A Flow variable functions during the execution of a component while an After variable
functions after the execution of the component.

To fill up a field or expression with a variable, press Ctrl +
Space
to access the variable list and choose the variable to use from it.

For further information about variables, see
Talend Studio

User Guide.

Usage

Usage rule

As a start component, this component is to be used along with other S3
components.

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 Scenario: Reading data from databases through context-based dynamic connections and Scenario: 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
.

Limitation

Due to license incompatibility, one or more JARs required to use this component are not
provided. You can install the missing JARs for this particular component by clicking the
Install button on the Component tab view. You can also find out and add all missing JARs easily on the
Modules tab in the
Integration
perspective of your
studio. You can find more details about how to install external modules in Talend Help Center (https://help.talend.com).

Related scenario

For tS3Connection related scenarios, see Scenario: File exchanges with Amazon S3.


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