tAmazonRedshiftManage - 6.1

Talend Components Reference Guide

EnrichVersion
6.1
EnrichProdName
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for Big Data
Talend Open Studio for Data Integration
Talend Open Studio for Data Quality
Talend Open Studio for ESB
Talend Open Studio for MDM
Talend Real-Time Big Data Platform
task
Data Governance
Data Quality and Preparation
Design and Development
EnrichPlatform
Talend Studio

Function

tAmazonRedshiftManage manages the work of creating a new Amazon Redshift cluster, creating a snapshot of an Amazon Redshift cluster, and deleting an existing cluster or snapshot.

Purpose

tAmazonRedshiftManage allows you to manage Amazon Redshift clusters and snapshots.

tAmazonRedshiftManage properties

Component family

Cloud

Basic settings

Access Key and Secret Key

Enter the access key and the secret key required by Amazon to authenticate your requests to its web services. These access credentials are generated from the Security Credential tab of your Amazon account page.

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.

Configuration

Action

Select an action to be performed from the list:

  • Create cluster: create a new Amazon Redshift cluster.

  • Delete cluster: delete a previously provisioned Amazon Redshift cluster.

  • Restore from snapshot: create a new Amazon Redshift cluster from a snapshot.

  • Delete snapshot: delete the specified manual snapshot.

 

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 supported AWS regions where you can provision an Amazon Redshift cluster, see Regions and Endpoints.

 

Create snapshot

Select this check box to create a final snapshot of the Amazon Redshift cluster before it is deleted.

This check box is available only when Delete cluster is selected from the Action list.

 

Snapshot id

Enter the identifier of the snapshot.

This field is available when:

  • Delete cluster is selected from the Action list and the Create snapshot check box is selected.

  • Restore from snapshot or Delete snapshot is selected from the Action list.

 

Cluster id

Enter the ID of the cluster.

This field is available when Create cluster, Delete cluster, or Restore from snapshot is selected from the Action list.

 

Database

Enter the name of the first database to be created when the cluster is created.

This field is available only when Create cluster is selected from the Action list.

 

Port

Enter the port number on which the cluster accepts connections.

This field is available when Create cluster or Restore from snapshot is selected from the Action list.

 

Master username and Master password

The user name and the password associated with the master user account for the cluster to be created.

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

The two fields are available only when Create cluster is selected from the Action list.

 

Node type

Select the node type to be provisioned for the cluster.

This list is available when Create cluster or Restore from snapshot is selected from the Action list.

 

Node count

Enter the number of compute nodes in the cluster to be created.

This field is available only when Create cluster is selected from the Action list.

Advanced settings

Wait for cluster ready

Select this check box to let your Job wait until the launch of the cluster is completed.

This check box is available when Create cluster or Restore from snapshot is selected from the Action list.

 

Original cluster id of snapshot

Enter the name of the cluster the source snapshot was created from.

This field is available when Restore from snapshot or Delete snapshot is selected from the Action list.

 

Parameter group name

Enter the name of the parameter group to be associated with the cluster.

This field is available when Create cluster or Restore from snapshot is selected from the Action list.

 

Subnet group name

Enter the name of the subnet group where you want the cluster to be restored.

This field is available when Create cluster or Restore from snapshot is selected from the Action list.

 

Publicly accessible

Select this check box so that the cluster can be accessed from a public network.

This check box is available when Create cluster or Restore from snapshot is selected from the Action list.

 

Set public ip address

Select this check box and in the field displayed enter the Elastic IP (EIP) address for the cluster.

This check box is available only when the Publicly accessible check box is selected.

 

Availability zone

Enter the EC2 Availability Zone in which you want Amazon Redshift to provision the cluster.

This field is available when Create cluster or Restore from snapshot is selected from the Action list.

 

VPC security group ids

Enter Virtual Private Cloud (VPC) security groups to be associated with the cluster and separate them with a comma, for example, gname1, gname2, gname3.

This field is available when Create cluster or Restore from snapshot is selected from the Action list.

 

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

CLUSTER_FINAL_ID: the ID of the cluster. This is an After 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

tAmazonRedshiftManage is usually used as a standalone component.

Log4j

If you are using a subscription-based version of the Studio, the activity of this component can be logged using the log4j feature. For more information on this feature, see Talend Studio User Guide.

For more information on the log4j logging levels, see the Apache documentation at http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/Level.html.

Related scenario

No scenario is available for this component yet.