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 that use Redshift SLL Redshift SSL accounts. 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

...

None.

Known Issues

...

and Known Issues

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

Account Settings

...

Parameter

Field Name

Data

Field Type

Description

Label*


Default Value

Example LabelStringRequired. Unique user-provided

: None
Example:Redshift SSL Account

String

Specify a unique label for the account.

N/A

JDBC Driver Class


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

String/Expression

Name

The name of the JBDC driver class to use.

org.postgresql.DriverJDBC jars

String

The list of JDBC jar

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

JDBC JARs

Default Value: N/A

String/Expression

Specify a list of JDBC JAR files to be loaded.

The user

You can upload the Redshift driver(s) that can override the

defaultorg.postgresql

default com.amazon.redshift.jdbc42.Driver

driver

.

noteN/AJDBC Url

String

Enter the Url of the JDBC database.NA

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

JDBC URL

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

String/Expression

Enter the URL of the JDBC database.

Account properties

Required. 

Enter

in

the information to create a connection to the database.

Endpoint*

Default Value: N/A
Exampleexamplefield.us-test-1.redshift.yourendpoint.com

String

Required. Enter the

/Expression

Enter the server's address

to connect to

.

NA

Port

number

Numeric

Required. Enter th

Number*

Default Value5439
Example5439

Integer/Expression

Enter the database server's port

to connect

.

5439String

Database name*

Default Value: N/A
Examplesnaplogic

String/Expression

Required. Enter the database name to connect.NAUsername

Enter the name of the database.

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.

NAPasswordString

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.

NA

S3 Bucket

Default Value: N/A
Examplesl-bucket-ca

String/Expression

Enter the external S3 Bucket

name residing

name residing in an external AWS

account, to

account to use for staging data

onto

in Redshift.

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

NA

S3 Folder

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

in Redshift.

NA

S3 Access-key ID

Default Value: N/A
ExampleNAVRGGRV7EDCFVLKJH

String/Expression

Enter the S3

Access key ID

Access key ID part of the AWS authentication.

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. 

NA

S3 Secret key

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

the IAM role

 checkbox KeyStore

 checkbox is not selected. 

S3 Security Token

Default Value: N/A
Example: FwoGYXdzEGUaDFInugbfGX8xlGA4ZwNWCi

NA

V3uSQBjIre4G7AXvfuGO2Fq41wDp7cLCuGAZvKGc4T
cSknLVYpI2amWKf9z21+7oszQ==

String

Enter the location of the key store file. It can be located in SLDB or any other unauthenticated endpoint such as 'https://'. You can also browse for the location.NATrustStoreString

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

TrustStore

Default Value: N/A
Example:redshiftstore4

String/Expression

Enter the location of the trust store file. It can be located in SLDB or any other unauthenticated endpoint

such as 'https://'Key/Trust Store PasswordString

. You can also browse for the location.

NA

TrustStore Password

Default Value: N/A
Example:

String/Expression

Enter the password for the

keystore/IAM properties

truststore file. 

NAKey AliasStringEnter the alias of the private key to be used from the key store.NA

IAM properties (Redshift Cluster)

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

ID of the Amazon Web

Services account to

Services account to be used for performing the bulk load operation.

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. 

NA 

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

the Redshift cluster to access the S3 bucket provided above.

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. 

NA

Region name

Default Value: N/A
Exampleus-east-1

String/Expression

Enter the name of the region of the Redshift cluster.

NA

Advanced properties

Specify advanced properties to support this account.

Auto commit

Default ValueSelected

Checkbox

Select this

check box

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

Selected

Batch size

NumericRequired. Enter the number

*

Default Value50
Example50

Integer/Expression

Enter the number of statements to execute at a time

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

50

Fetch size

NumericRequired. Enter the number

*

Default Value:100
Example:100

Integer/Expression

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

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.

100

Max pool size

NumericRequired. Enter the maximum

*

Default Value50
Example30

Integer/Expression

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

Note

Redshift Bulk Load/Bulk Upsert/S3 Upsert Snap requires 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.

50

Max life time

Numeric

Required.

*

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.

30

Idle Timeout

Numeric

Required.

*

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.

5

Checkout timeout

Numeric
Required.

*

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.1000URL PropertiesSpecify

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

Use this field set to define the URL properties associated with this account. This field set contains the following fields:

  • URL property name

Numeric
  • URL property value

URL property name

Default Value: N/A
Example:

Integer/Expression

Enter the URL property name.

NA

URL property value

Numeric

Default Value: N/A
Example:

Integer/Expression

Enter the URL property value.

NA

Troubleshooting

None.

See Also

...

Related Content