In this article

Table of Contents

maxLevel	2
absoluteUrl	true

Overview

Use this account type to connect Redshift Snaps with data sources that use Redshift Cross-Account IAM Role Account.

Prerequisites

Access to the following folders:

Private project folder
Project Space’s shared folder
Global shared folder

Limitations

None.

Known Issues

None.

Account Settings

Insert excerpt

	Redshift Snap Pack
	Redshift Snap Pack
nopanel	true

Parameter

Data Type

Description

Default Value

Example

Label*

String

Unique user-provided label for the account.

N/A

Redshift_Cross_IAM_Account

JDBC Driver Class

String

Enter the JDBC driver class to use in your application.

org.postgresql.Driver

org.postgresql.Driver

JDBC JARs

Specify or upload the JDBC JAR files that you want to use. You can upload the Redshift driver(s) that can override the default org.postgresql.Driver driver. Set the Batch size value to 1 with the JDBC driver version RedshiftJDBC41-1.1.10.1010.jar. Specify each JDBC Driver as a separate row. Click to add a new row. We recommend, RedshiftJDBC42-1.2.10.1009.jar version when using Redshift Bulk Upsert Snap in your Pipeline.

JDBC Driver

String

Select the JDBC driver to use.

Note
Default JDBC driver will be used on leaving this field blank.

N/A

NA

JDBC Url

String

Enter the URL of the JDBC database.

N/A

jdbc:redshift://hostname:port/database

Account properties

Required.

Configure the information required to establish a database connection with the account.

Endpoint*

String

Required. Enter Enter the server's address to establish a connection.

N/A

fieldcluster.cvnsysusue7w2.us-east-1.redshift.amazonaws.com

Port number*

Numeric

Required. Enter the database server's port to connect to the host.

5439

5476

Database name*

String

Required. Enter the database name to connect.

N/A

weqter

Username

String

Enter the username to connect to the database. Username is used as the default username when retrieving connections. The username must be valid in order to set up the data source.

N/A

admin

Password

String

Enter the password to connect to the data source. Password is used as the default password when retrieving connections. The password must be valid in order to set up the data source.

N/A

S3 Bucket

String

Enter the external S3 Bucket name residing in an external AWS account, to use for staging data onto Redshift.

Note
This field is required when using Redshift Bulk Load, Redshift Bulk Upsert, Redshift S3 Upsert, and Redshift Unload Snaps.

N/A

sl-bucket-ca

S3 Folder

String

Enter the relative path to a folder in S3 Bucket. This is used as a root folder for staging data onto Redshift.

N/A

s3://sl-bucket-ca/san-francisco

S3 Bucket Region

String

Enter the name of the region where the S3 bucket belongs.

Note
This field is required if the Redshift cluster and the S3 bucket are in the different regions.

N/A

us-east-2

S3 Bucket Write IAM Role ARN

String

Enter the IAM role to write to the S3 bucket which resides in either the same or different AWS account.

Note
You need to have write and delete permissions in this role. This field is required when using Bulk load Snap (with input view data source), Bulk Upsert Snap, and Unload Snap.

N/A

arn:aws:iam::133198801419:role/IamRoleWithAllAccessForCanary

External ID

String

Enter an optional external ID which is required by the role. This field is applicable only for streaming bulk load.

N/A

7609567

IAM properties (Redshift Cluster)

Specify the information for Redshift to communicate with IAM.

AWS account ID

String

Enter the ID of the Amazon Web Services account to be used for performing bulk load operation.

Note
This field is required when using Redshift Bulk Load, Redshift Bulk Upsert, Redshift S3 Upsert, and Redshift Unload Snaps.

N/A

AWS1233961

IAM role name

String

Enter the name of the IAM role associated with the target Redshift cluster to access the S3 bucket. redshift cluster to access the S3 bucket provided above.

Note
This field is required when using Redshift Bulk Load, Redshift Bulk Upsert, Redshift S3 Upsert, and Redshift Unload Snaps.

N/A

das-crossaccount-sp6776

S3 Bucket Read IAM Role

Specify the information required to make Redshift work with IAM instead of Access-key ID and Secret.

IAM Role ARN

String

Enter the ARN of the IAM role set on the above S3 bucket.

Note
This field is required only if the S3 bucket is in another AWS account. If S3 bucket is in another AWS account, specify the Cross-Account IAM role to read the S3 bucket. Else, leave this field blank and ensure the IAM role assigned to the Redshift Cluster has permission to read from the S3 bucket. For more information, see Setup of Redshift Cross Account IAM Role Setup.

N/A

arn:aws:iam::133198801419:role/cross-account-access-snap6776-das

Advanced properties

Specify advanced properties to support this account.

Auto commit

Checkbox

Select this check box to enable the Snap to commit offsets automatically as messages are consumed and sent to the output view. If the Snap fails, only the batch being executed at that moment is rolled back.

Selected

Deselected

Batch size*

NumericInteger

Required. Enter Enter the number of statements to execute at a time.

Note
This field is required when using Redshift Bulk Load, Redshift Bulk Upsert, Redshift S3 Upsert, and Redshift Unload Snaps. User-defined types are not if a JDBC driver with a version other than 11.2.0.4.0 is set.

50

70

Fetch size*

NumericInteger

Required. Enter Enter the number of rows to fetch at a time when executing a query.

Note
User-defined types are not supported if a JDBC driver with a version other than 11.2.0.4.0 is set.

100

56

Max pool size*

NumericInteger

Required. Enter Enter the maximum number of connections that a pool maintains at a time.

Note
Redshift Bulk Load/Bulk Upsert/S3 Upsert Snap requires a minimum of two connections per Snap in a pipeline. For example, if a pipeline has a Redshift Bulk Load Snap and an S3 Upsert Snap, then the pool size must be greater than or equal to four for successful execution.

50

10

Max life time*

NumericInteger

Required. Enter the maximum lifetime of a connection in the pool.

Note
Ensure that the value you enter is a few seconds lesser than any database or infrastructure-imposed connection time limit. A value of 0 indicates an infinite lifetime, subject to the Idle Timeout value. An in-use connection is never retired. Connections are removed only after they are closed.

30

15

Idle Timeout*

NumericInteger

Required. Enter the maximum amount of time a connection that should remain idle in the pool. A value of 0 indicates that idle connections are never removed from the pool.

5

1

Checkout timeout*

NumericInteger

Required. Enter the number of milliseconds to wait for a connection to be available when the pool is exhausted. A value of 0 indicates that the wait time to checkout is infinite. An exception is thrown after the wait time expires.

1000

2000

URL Properties

Specify the URL properties associated to this account.

URL property name

Numeric

Enter the URL property name.

N/A

ssl

URL property value

Numeric

Enter the URL property value.

N/A

true

...

Versions Compared

Old Version 11

New Version 12

Key

Overview

Prerequisites

Limitations

Known Issues

Account Settings

Page Comparison

Versions Compared

Old Version 11

New Version 12

Key

Overview

Prerequisites

Limitations

Known Issues

Account Settings