Table of Contents

Search

  1. Preface
  2. Part 1: Hadoop Integration
  3. Part 2: Databricks Integration
  4. Appendix A: Managing Distribution Packages
  5. Appendix B: Connections Reference

Amazon Redshift Connection Properties

Amazon Redshift Connection Properties

When you set up an Amazon Redshift connection, you must configure the connection properties.
The following table describes the Amazon Redshift connection properties:
Property
Description
Name
The name of the connection. The name is not case sensitive and must be unique within the domain. You can change this property after you create the connection. The name cannot exceed 128 characters, contain spaces, or contain the following special characters:~ ` ! $ % ^ & * ( ) - + = { [ } ] | \ : ; " ' < , > . ? /
ID
String that the Data Integration Service uses to identify the connection. The ID is not case sensitive. It must be 255 characters or less and must be unique in the domain. You cannot change this property after you create the connection. Default value is the connection name.
Description
The description of the connection. The description cannot exceed 4,000 characters.
Location
The domain where you want to create the connection.
Type
The connection type. Select Amazon Redshift in the Database.
The
Details
tab contains the connection attributes of the Amazon Redshift connection. The following table describes the connection attributes:
Property
Description
Authentication Type
The authentication method to log in to Amazon Redshift. You can select one of the following authentication methods:
  • Default. Uses the username and password to connect to Amazon Redshift.
  • Redshift IAM Authentication via AssumeRole. Uses AssumeRole for IAM authentication to connect to Amazon Redshift.
Username
User name of the Amazon Redshift account.
Password
Password for the Amazon Redshift account.
Access Key ID
Amazon S3 bucket access key ID to stage data in the S3 bucket using unload and copy commands.
Secret Access Key
Amazon S3 bucket secret access key ID to stage the data in the S3 bucket.
Master Symmetric Key
Optional. Provide a 256-bit AES encryption key in the Base64 format when you enable client-side encryption. You can generate a key using a third-party tool.
If you specify a value, ensure that you specify the encryption type as client-side encryption in the advanced target properties.
JDBC URL
Amazon Redshift connection URL.
Cluster Region
Optional. The AWS cluster region in which the bucket you want to access resides.
Select a cluster region if you choose to provide a custom JDBC URL that does not contain a cluster region name in the
JDBC URL
connection property.
If you specify a cluster region in both
Cluster Region
and
JDBC URL
connection properties, the Data Integration Service ignores the cluster region that you specify in the
JDBC URL
connection property.
To use the cluster region name that you specify in the
JDBC URL
connection property, select
None
as the cluster region in this property.
Select one of the following cluster regions:
  • Asia Pacific (Mumbai)
  • Asia Pacific (Seoul)
  • Asia Pacific (Singapore)
  • Asia Pacific (Sydney)
  • Asia Pacific (Tokyo)
  • AWS GovCloud (US)
  • Canada (Central)
  • China (Beijing)
  • China (Ningxia)
  • EU (Ireland)
  • EU (Frankfurt)
  • EU (London)
  • EU (Paris)
  • South America (Sao Paulo)
  • US East (Ohio)
  • US East (N. Virginia)
  • US West (N. California)
  • US West (Oregon)
Default is None.
You can only read data from or write data to the cluster regions supported by AWS SDK used by PowerExchange for Amazon Redshift.
Customer Master Key ID
Optional. Specify the customer master key ID generated by AWS Key Management Service (AWS KMS) or the Amazon Resource Name (ARN) of your custom key for cross-account access. You must generate the customer master key corresponding to the region where Amazon S3 bucket resides. You can specify any of the following values:
Customer generated customer master key
Enables client-side or server-side encryption.
Default customer master key
Enables client-side or server-side encryption. Only the administrator user of the account can use the default customer master key ID to enable client-side encryption.
IAM Assume Role ARN
The Amazon Resource Number (ARN) of the IAM role assumed by the user to use the dynamically generated temporary security credentials.
Set the value of this property if you want to use the temporary security credentials to access Amazon Redshift.
For more information about how to get the ARN of the IAM role, see the AWS documentation.
Cluster Identifier
The unique identifier of the cluster that hosts Amazon Redshift for which you are requesting the security credentials.
Specify the cluster name.
Database Name
Name of the Amazon Redshift database.
Auto Create DBUser
Select to create a new Amazon Redshift database user at run time.
Default is disabled.
Use this option to create a new Amazon Redshift database user. If you create a new user directly using the AWS command line, the user is not created in Amazon Redshift.
Database Group
Name of the database group.
Specify the database user and group details after you log in to the Amazon Redshift database.
If you do not specify a group, the user is added to a public group.
Expiration Time
The time duration that the password for the Amazon Redshift database user expires.
Specify a value between 900 seconds and 3600 seconds.
Default is 900.
Use EC2 Role to Assume Role
Select to enable the EC2 role to assume another IAM role specified in the IAM AssumeRole ARN option.
IAM User Access Key
The access key of the IAM user that has permissions to assume the IAM AssumeRole ARN.
IAM User Secret Access Key
The secret access key of the IAM user that has permissions to assume the IAM Assume Role ARN.

0 COMMENTS

We’d like to hear from you!