Redshift Account

In this article

Overview

Use this account type to connect Redshift Snaps with data sources. The Redshift Snaps support both Redshift Cluster and Redshift Serverless accounts.

Prerequisites

Access to the folders in which you are creating an account.

Limitations and Known Issues

Account Settings

image-20240215-115345.png

 

Field Name

Field Type

Description

Field Name

Field Type

Description

Label*

Default Value: N/A
Example: Redshift Account

String

Specify a unique label for the account.

JDBC driver class

Default Value: com.amazon.redshift.jdbc42.Driver
Example: org.postgresql.Driver

String/Expression

By default, the com.amazon.redshift.jdbc42.Driver class is bundled with the Snap Pack.

JDBC JARs

 

 

Use this field set to add a list of JDBC JAR files to be loaded. By default, the Redshift account is bundled with the JDBC v2.1.0.29 driver. However, you can add a custom JAR file. Click + to add a new row for each JDBC JAR file.

JDBC driver

 

Default value: N/A
Example:

JDBC 42-2.1.0.29.jar

String

The Redshift Snap Pack is bundled with the default Redshift JDBC driver v2.1.0.29. Therefore, even if you do not provide a JDBC Driver, the account does not fail.

JDBC URL

Default Value: N/A
Example: jdbc:redshift://hostname:port/database

String/Expression

Enter the URL of the JDBC database.

Account properties*

Configure the account properties to establish a connection to the database.

Endpoint*

Default Value: N/A
Example: examplefield.c8dwr9.us-test-1.redshift.yourendpoint.com

String/Expression

Enter the server's address to connect to.

Port number*

Default Value: 5439
Example: 5439

Numeric/Expression



Enter the database server's port to connect.

Database name*

Default Value: N/A
Example: snaplogic

String/Expression

Enter the database name to connect.

Username

Default Value: N/A
Example: redshiftadmin

String/Expression

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

Password

Default Value: N/A
Example: p@$$20d*

String/Expression

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

S3 bucket

Default Value: N/A
Example: sl-bucket-ca

String/Expression

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

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

S3 folder

Default Value: N/A
Example: s3://bucket-name/folder-name

String/Expression

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

S3 access-key ID

Default Value: N/A
Example: NAVRGGRV7EDCFVLKJH

String/Expression

Enter the S3 Access key ID part of AWS authentication.

This field is required when using Redshift Bulk Load, Redshift Bulk Upsert, Redshift S3 Upsert, and Redshift Unload Snaps if the IAM role checkbox is not selected. 

S3 secret key

Default Value: N/A
Example: 2RGiLmL/6bCujkKLaRuUJHY9uSDEjNYr+ozHRtg

String/Expression

Enter the S3 Secret key part of AWS Authentication.

This field is required when using Redshift Bulk Load, Redshift Bulk Upsert, Redshift S3 Upsert, and Redshift Unload Snaps if the IAM role checkbox is not selected. 

S3 security token

Default Value: N/A
Example: FwoGYXdzEGUaDFInugbZwNWCi
V3uSQBjIr41ZvKGc4T
cSknLVYpI2amWKf9z21+7oszQ==

String/Expression

Specify the S3 security token part of the AWS Security Token Service (STS) authentication. It is not required unless a specific S3 credential is configured to require it. Note that only global STS regions are supported.



IAM properties

Specify the IAM properties information for Redshift to communicate with IAM

AWS account ID

Default Value: N/A
Example: AWS-1

String/Expression

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

IAM role name

Default Value: N/A
Example: rolex

String/Expression

Enter the name of the IAM role that has been assigned to the Redshift cluster to access the S3 bucket provided above.

Region name

Default Value: N/A
Example: us-east-1

String/Expression



Enter the name of the region the Redshift cluster.

Advanced properties

 

Specify advanced properties to support this account.

Auto commit

Default Value: Selected

Checkbox

 

Select this checkbox to enable the Snap to commit offsets automatically as messages are consumed and sent to the output view.

Batch size*

Default Value: 50
Example: 50

Integer/Expression

Enter the number of statements to execute at a time. Select queries are not batched.

Fetch size*

Default Value:100
Example:100

Integer/Expression

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

Max pool size*

Default Value: 50
Example: 30

Integer/Expression

Enter the maximum number of connections a pool will maintain at the same time.

Max lifetime (minutes)*

Default Value: 30
Example: 10

Integer/Expression

Enter the maximum lifetime of a connection in the pool. Ensure that the value you enter is a few seconds shorter 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.

Idle Timeout (minutes)*

Default Value: 5
Example: 6

Integer/Expression

Enter the maximum amount of time a connection is allowed to sit idle in the pool. A value of 0 indicates that idle connections are never removed from the pool.

Checkout timeout (milliseconds)*

Default Value:1000
Example: 800

Integer/Expression

Enter the number of milliseconds to wait for a connection to be available when the pool is exhausted.

URL properties

 

Specify the URL properties associated with this account.

URL property name

Default Value: N/A
Example: ssl

String/Expression



Enter the URL property name.

URL property value

Default Value: N/A
Example: true

String/Expression



Enter the URL property value.