Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

Table of Contents
maxLevel2
absoluteUrltrue

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 following folders:

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

Limitations

The default JDBC URL jdbc:postgre:://<hostname>:<port>/<db> does not work as it is not compatible with JDBC 2.x drivers. If you are using 2.x version of Amazon Redshift drivers, you must explicitly provide the JDBC URL as jdbc:redshift://<hostname>:<port>/<db> to configure the account successfully.

Known Issues

None.

Account Settings

Image Removed

...

folders in which you are creating an account.

Limitations and Known Issues

Multiexcerpt include macro
nameIAM Role
templateDataeJyLjgUAARUAuQ==
pageRedshift Snap Pack
addpanelfalse

Multiexcerpt include macro
nameRedshift limitation with PostgreSQL driver
templateData[]
pageRedshift - Execute
addpanelfalse

Account Settings

...

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: 

org.postgresql

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

String

Specify a name of the JBDC driver class to use

/Expression

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

JDBC

jars

JARs

Default Value: N/A
Exampleorg.postgresql.Driver

String/Expression

Specify a list of JDBC

jar

JAR files to be loaded.

Info

You can manually upload the

Redshift

PostgreSQL driver

(s)

that

can override the default org.postgresqlJDBC Url

overrides the default com.amazon.redshift.jdbc42.Driver driver.

Set the Batch size property to 1 with the JDBC driver version RedshiftJDBC41-1.1.10.1010.jar.

dbc

JDBC URL

Default ValueN/A
Example

j

jdbc:redshift://hostname:port/database

String/Expression

Enter the

Url

URL of the JDBC database.

info

If you are using 2.x version of Amazon Redshift drivers, you must explicitly provide the JDBC URL as jdbc:redshift://<hostname>:<port>/<db> to configure the account successfully. The default JDBC URL, jdbc:postgre://<hostname>:<port>/<db> does not work as it is not compatible with JDBC 2.x drivers.

Account properties*

Enter in

Configure the

information

account properties to

create

establish a connection to the database.

Endpoint*

Default Value: N/A
Example

fieldcluster

examplefield.

c8dwbwr9

c8dwr9.us-

east

test-1.redshift.

amazonaws

yourendpoint.com

String/Expression

Enter the server's address to connect to.

Port Number*

Default Value5439
Example5439

Numeric/Expression


Enter the database server's port to connect.

Database name*

Default Value: N/A
Examplesnaplogic

String/Expression

Enter the database name to connect.

Username

Default Value: N/A
Exampleredshiftadmin

String/Expression

Enter the username to connect to the database.

 Username will

 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
Examplep@$$20d*

String/Expression

Enter the password used to connect to the data source.

 Password will be

 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 ValueN/A
Examplesl-bucket-ca

String/Expression

Enter the external S3 Bucket name residing in an external AWS

account, 

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. 

S3 Folder

Default Value: N/A
Examples3://

sl-

bucket-

ca

name/

san

folder-

francisco

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
ExampleNAVRGGRV7EDCFVLKJH

String/Expression

Enter the S3 Access key ID part of AWS authentication.

Note

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

the 

the IAM role

 checkbox

 checkbox is not selected. 

S3 Secret key

Default Value: N/A
Example2RGiLmL/6bCujkKLaRuUJHY9uSDEjNYr+ozHRtg

String/Expression

Enter the S3 Secret key part of AWS Authentication.

note

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
ExampleFwoGYXdzEGUaDFInugbZwNWCi
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.

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. 


IAM properties

Specify the IAM properties information for Redshift to communicate with IAM

.

AWS account ID

Default Value: N/A
ExampleAWS-1

String/Expression

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

note

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

the 

the IAM role

 checkbox

 checkbox is selected. 

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.

Note

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

the 

the IAM role

 checkbox

 checkbox is selected. 

Region name

Default Value: N/A
Exampleus-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 ValueSelected


Example
Deselected

Checkbox

Select this

check box

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

Batch size*

Default Value50
Example50

Integer/Expression

Enter the number of statements to execute at a time.

Note
  • Set the Batch size property to 1 with the JDBC driver version RedshiftJDBC41-1.1.10.1010.jar, in the JDBC jars.
  • Select queries are

    not batched

    not batched.

    User-defined types

    won't be

    are not supported if a JDBC driver with a version other than 11.2.0.4.0 is set.

    Fetch size*

    Default Value:100
    Example:100

    Integer/Expression

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

    note

    User-defined types

    won't be

    are not supported if a JDBC driver with a version other than 11.2.0.4.0 is set.

    Max pool size*

    Default Value50
    Example30

    Integer/Expression

    Enter the maximum number of connections a pool will maintain at

    a

    the same time.

    note

    Redshift Bulk Load/Bulk Upsert/S3 Upsert

    Snap requires

    Snaps require a minimum of 2 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 4 for successful execution.

    Max life time*

    Default Value30
    Example10

    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*

    Default Value5
    Example6

    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*

    Default Value:1000
    Example800

    Integer/Expression

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

    Zero waits forever. An exception will be thrown after the wait time has expired

    If you enter 0 for this value, the Snap waits infinitely until the connection is available. Therefore, we recommend you not enter 0 for Checkout Timeout.

    URL Properties

    Specify the URL properties associated with this account.

    URL property name

    Default Value: N/A
    Examplessl

    String/Expression


    Enter the URL property name.

    URL property value

    Default Value: N/A
    Exampletrue

    String/Expression


    Enter the URL property value.

    Insert excerpt
    Redshift Snap Pack
    Redshift Snap Pack
    nopaneltrue

    ...