tDynamoDBInput Standard properties - 7.3

Amazon DynamoDB

Version
7.3
Language
English (United States)
Product
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Open Studio for Big Data
Talend Real-Time Big Data Platform
Module
Talend Studio
Content
Data Governance > Third-party systems > Amazon services (Integration) > Amazon DynamoDB components
Data Quality and Preparation > Third-party systems > Amazon services (Integration) > Amazon DynamoDB components
Design and Development > Third-party systems > Amazon services (Integration) > Amazon DynamoDB components

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

The Standard tDynamoDBInput component belongs to the Big Data and the Databases NoSQL families.

The component in this framework is available in all Talend products with Big Data and in Talend Data Fabric.

Basic settings

Access Key

Enter the access key ID that uniquely identifies an AWS Account. For further information about how to get your Access Key and Secret Key, see Getting Your AWS Access Keys.

Secret Key

Enter 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 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

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.

Use End Point

Select this check box and in the Server Url field displayed, specify the Web service URL of the DynamoDB database service.

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.

Action

Select the operation to be performed from the drop-down list, either Query or Scan. For more information, see Query and Scan Operations in DynamoDB.

Schema and Edit schema

A schema is a row description. It defines the number of fields (columns) to be processed and passed on to the next component. When you create a Spark Job, avoid the reserved word line when naming the fields.

  • Built-In: You create and store the schema locally for this component only.

  • Repository: You have already created the schema and stored it in the Repository. You can reuse it in various projects and Job designs.

 

Click Edit schema to make changes to the schema. If the current schema is of the Repository type, three options are available:

  • View schema: choose this option to view the schema only.

  • Change to built-in property: choose this option to change the schema to Built-in for local changes.

  • Update repository connection: choose this option to change the schema stored in the repository and decide whether to propagate the changes to all the Jobs upon completion. If you just want to propagate the changes to the current Job, you can select No upon completion and choose this schema metadata again in the Repository Content window.

If a column stores JSON documents, select JSON from the DB Type drop-down list.

Table Name

Specify the name of the table to be queried or scanned.

Use secondary index Select this check box and in the Index field displayed, specify the Global Secondary Index (GSI) to be used to retrieve data. Using a GSI improves the performance of queries and scans. For more information, see Using Global Secondary Indexes in DynamoDB in the AWS documentation.

Use advanced key condition expression

Select this check box and in the Advanced key condition expression field displayed, specify the key condition expressions used to determine the items to be read from the table or index.

Key condition expression

Specify the key condition expressions used to determine the items to be read. Click the [+] button to add as many rows as needed, each row for a key condition expression, and set the following attributes for each expression:

  • Key Column: Enter the name of the key column.

  • Function: Select the function for the key condition expression.

  • Value1: Specify the value used in the key condition expression.

  • Value2: Specify the second value used in the key condition expression if needed, depending on the function you selected.

Note that only the items that meet all the key conditions defined in this table can be returned.

This table is not available when the Use advanced key condition expression check box is selected.

Use filter expression

Select this check box to use the filter expression for the query or scan operation.

Use advanced filter expression

Select this check box and in the Advanced filter expression field displayed, specify the filter expressions used to refine the data after it is queried or scanned and before it is returned to you.

This check box is available when the Use filter expression check box is selected.

Filter expression

Specify the filter expressions used to refine the results returned to you. Click the [+] button to add as many rows as needed, each row for a filter expression, and set the following attributes for each expression:

  • Column: Enter the name of the column used to refine the results.

  • Function: Select the function for the filter expression.

  • Value1: Specify the value used in the filter expression.

  • Value2: Specify the second value used in the filter expression if needed, depending on the function you selected.

Note that only the items that meet all the filter conditions defined in this table can be returned.

This table is available when the Use filter expression check box is selected and the Use advanced filter expression check box is cleared.

Value mapping

Specify the placeholders for the expression attribute values.

  • value: Enter the expression attribute value.

  • placeholder: Specify the placeholder for the corresponding value.

For more information, see Expression Attribute Values.

Name mapping

Specify the placeholders for the attribute names that conflict with the DynamoDB reserved words.

  • name: Enter the name of the attribute that conflicts with a DynamoDB reserved word.

  • placeholder: Specify the placeholder for the corresponding attribute name.

For more information, see Expression Attribute Names.

Advanced settings

STS Endpoint

Select this check box to specify the AWS Security Token Service (STS) endpoint from which to retrieve the session credentials. For example, enter sts.amazonaws.com.

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

Signing region

Select the AWS region of the STS service. If the region is not in the list, you can enter its name between double quotation marks. The default value is us-east-1.

This drop-down list is available only when the Assume Role check box is selected.

External Id

If the administrator of the account to which the role belongs provided you with an external ID, enter its value here. The External Id is a unique identifier that allows a limited set of users to assume the role.

This field is available only when the Assume Role check box is selected.

Serial number

When you assume a role, the trust policy of this role might require Multi-Factor Authentication (MFA). In this case, you must indicate the identification number of the hardware or virtual MFA device that is associated with the user who assumes the role.

This field is available only when the Assume Role check box is selected.

Token code

When you assume a role, the trust policy of this role might require Multi-Factor Authentication (MFA). In this case, you must indicate a token code. This token code is a time-based one-time password produced by the MFA device.

This field is available only when the Assume Role check box is selected.

Tags

List session tags in the form of key-value pairs. You can then use these session tags in policies to allow or deny access to requests.

Transitive: select this check box to indicate that a tag will persist to the next role in a role chain.

For more information about tags, see Passing Session Tags in AWS STS

This field is available only when the Assume Role check box is selected.

IAM Policy ARNs

Enter the Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. Use managed session policies to limit the permissions of the session. The policies must exist in the same account as the role. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies.

For more information about session policies, see the corresponding section in Policies and Permissions

This field is available only when the Assume Role check box is selected.

Policy

Enter an IAM policy in JSON format that you want to use as a session policy. Use session policies to limit the permissions of the session. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies.

For more information about session policies, see the corresponding section in Policies and Permissions

This field 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

Global Variables

NB_LINE: the number of rows processed. This is an After variable and it returns an integer.

QUERY: the query statement being processed. This is a Flow variable and it returns a string.

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

This component is usually used as a start component of a Job or subJob and it always needs an output link.