Versions Compared

Old Version 16

changes.mady.by.user Amritesh Singh

Saved on

compared with

New Version Current

changes.mady.by.user Lakshmi Manda

Saved on

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 Cross-Account IAM Role SSL Account. The Redshift Snaps support both Redshift Cluster and Redshift Serverless accounts.

...

Access to the following folders:

  • Private project folder

  • Project Space’s shared folder

  • Global shared folder

Limitations

...

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

Known Issues

None.

Account Settings

...

Parameter

Field Name

Data

Field Type

Description

Label*

Default Value

Example Label*JDBC Driver Class

: None
Example:Redshift Cross-Account IAM Role SSL Account

String

Specify a unique label for the account.

N/ARedshift_SSLCross_IAM_Account

JDBC Driver Class

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

String/Expression

Enter the JDBC Driver Class

Name of the JBDC driver class to use

in your application.org.postgresql.Driverorg.postgresql.DriverJDBC 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 Image Removed to add a new row. We recommend, RedshiftJDBC42-1.2.10.1009.jar version when using Redshift Bulk Upsert Snap in your Pipeline.

JDBC DriverString/Expression

Select the JDBC driver to use.

Note

If you leave this field blank, the Default JDBC driver is used.

N/AN/AJDBC URL

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

N/Ajdbc:redshift://hostname:port/database

Account properties

*

Configure

Enter in the information

required

to

establish

create a

database

connection

with

to the

account

database.

Endpoint*

String/Expression

Enter the server's address to establish a connection.N/Afieldcluster.cvnsysusue7w2

Default Value: N/A
Example: examplecluster.c8dwbwr9.us-east-1.redshift.

amazonaws

endpoint.com

String/Expression

Enter the server's address to connect to.

Port

number

Number*

Numeric

Default Value: 5439
Example: 5439

Integer/Expression

Enter

th

the database server's port to connect

to the host

.

54395439

Database name*

Default Value: N/A
Example: snaplogic

String/Expression

Enter

the database

the database name to connect.

N

Username

Default Value: N/A

weqterUsername

Example: redshiftadmin

String/Expression

Enter the username to connect to the database.

 Username is

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

N

Password

Default Value: N/A

adminPassword

Example: p@$$20d*

String/Expression

Enter the password used to connect to the data source.

 Password is

 Password will be 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

Default Value: N/A

S3 Bucket

Example: sl-bucket-ca

String/Expression

Enter the external S3 Bucket

name residing

name residing in an external AWS account,

 to

 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.

NS3 Folder

 

S3 Folder

Default Value: N/A

sl-bucket-ca

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.

N

S3 Bucket Region

Default Value: N/A

s3://sl-bucket/sfoS3 Bucket Region

Example: us-east-2

String/Expression

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/Aus-east-2

S3 Bucket Write IAM Role ARN

Default Value: N/A
Example: arn:aws:iam::13355861319:role/IamRoleWithAllAccessforyourinstance

String/Expression

Enter the IAM role to write to the S3 bucket which resides in

an external

either the same or different AWS account.

Note

  • You need to have write and delete permissions in this role.

  • This

field is

  • field is required when

using Bulk

  • using Bulk load Snap (with input view data source), Bulk Upsert Snap, and Unload Snap.

NExternal ID

External ID

Default Value: N/A

arn:aws:iam::133198801419:role/IamRoleForCanary

Example: 7609567

String/Expression

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

NTrustStore

TrustStore

Default Value: N/A

7609567

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://'. You can also browse for the location.

NTrustStore Password

TrustStore Password

Default Value: N/A

redshiftstore4

Example: 12@*^87*

String/Expression

Enter the password for the truststore file. 

N/A

12@*^87*

IAM properties (Redshift Cluster)

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

ID of the Amazon Web

Services account to

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 

763091233961

Snaps if the IAM role checkbox is selected. 

IAM role name

Default Value: N/A
Example: rolex

String/Expression

Enter the name of the IAM

role associated with the target Redshift cluster to access the S3 bucket. redshift cluster

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.N/Adas-crossaccount-role1

Snaps if the IAM role checkbox is selected. 

S3 Bucket Read IAM Role

Specify

the Cross-Account IAM properties information for Redshift to communicate with IAM

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

IAM Role ARN

Default Value: N/A
Example: arn:aws:iam::123456789012:role/S3Access

String/Expression

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

Note

This field is required

when using Redshift Bulk Load with input view data source, Redshift Bulk Upsert, Redshift S3 Upsert, and Redshift Unload Snaps.N/Aarn:aws:iam::133198801419:role/cross-account-access-snap6776-das

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 for Redshift Cross Account IAM Role.

Advanced properties

Specify advanced properties to support this account.

Auto commit

Default Value: Selected

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.

SelectedDeselected

Batch size*

Numericumber

Default Value: 50
Example: 50

Integer/Expression

Required. Enter the n

Enter the number of statements to execute at a time.

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

Select queries are not batched.

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

5070

Fetch size*

Numeric

Default Value:100
Example:100

Integer/Expression

Required. Enter the number

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

Note

User-defined

types are

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

10056

Max pool size*

Numeric

Default Value: 50
Example: 30

Integer/Expression

Required. Enter the maximum

Enter the maximum number of connections

that

a pool

maintains

will maintain at a time.

note

Redshift Bulk Load/Bulk Upsert/S3 Upsert Snap requires a minimum of

two

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

four

4 for successful execution.

50

10

Max life time*

Numeric

Default Value: 30
Example: 10

Integer/Expression

Required.

Enter the maximum lifetime of a connection in the pool.

Note

Ensure that the value you enter is a few seconds

lesser

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.

3015

Idle Timeout*

Numeric

Default Value: 5
Example: 6

Integer/Expression

Required.

Enter the maximum amount of time a connection

that should remain Numeric

is allowed to sit idle in the pool. A value of 0 indicates that idle connections are never removed from the pool.

51Checkout timeout

Checkout timeout*

Default Value:1000
Example: 800

Integer/Expression

Required.

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

 

Info

If you provide 0, the Snap waits infinitely until the connection is available. Therefore, we recommend you not to specify 0 for Checkout Timeout.

10002000

URL Properties

Specify

Use this field set to define the URL properties associated

to

with this account. This field set contains the following fields:

  • URL property name

NumericNumeric

  • URL property value

URL property name

Default Value: N/A
Example:

Integer/Expression

Enter the URL property name.

URL property value

Default Value: N/A

sslURL property value

Example:

Integer/Expression

Enter the URL property value.

N/A

true


Account Encryption

Standard Encryption

If you are using Standard Encryption, the High sensitivity settings under Enhanced Encryption are followed.


Enhanced Encryption

If you have the Enhanced Account Encryption feature, the following describes which fields are encrypted for each sensitivity level selected per each account.

Account:

  • High: Password, S3 Access-key ID, S3 Secret key

  • Medium + High: Username, Password, S3 Access-key ID, S3 Secret key

  • Low + Medium + High: Endpoint, Database name, Username, Password, S3 Bucket, S3 Folder, S3 Access-key ID, S3 Secret key, URL property value

Troubleshooting

None.


...

Related Content

...