tAmazonRedshiftManage Standard properties

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

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.

Action

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.

Cluster id

Enter the ID of the cluster.

This field is available when Create cluster, Delete cluster, Resize 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, enter the password in double quotes in the pop-up dialog box, 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 for the cluster.

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

Node count

Enter the number of compute nodes in the cluster.

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

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.

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.

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.

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.

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.

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.

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.

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.

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, Restore from snapshot, or Resume cluster 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.

ENDPOINT: the endpoint address 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 more information about variables, see Using contexts and variables.

Usage rule

tAmazonRedshiftManage is usually used as a standalone component.