Connections

Back Next

Amazon Redshift V2 connection properties

When you set up an Amazon Redshift V2 connection, configure the connection properties.

The following table describes the Amazon Redshift V2 connection properties:

Property	Description
Connection Name	Name of the connection. Each connection name must be unique within the organization. Connection names can contain alphanumeric characters, spaces, and the following special characters: _ . + -, Maximum length is 255 characters.
Description	Description of the connection. Maximum length is 4000 characters.
Type	The Amazon Redshift V2 connection type.
Runtime Environment	Name of the runtime environment where you want to run the tasks. Select a Secure Agent, Hosted Agent, or serverless runtime environment. You cannot run an application ingestion task, database ingestion task, file ingestion task, or streaming ingestion task on a Hosted Agent or serverless runtime environment. Hosted Agent is not applicable for mappings that run on an advanced cluster.
Authentication Type	The authentication method that the connector must use to log in to Amazon Redshift. Select one of the following authentication types: 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. Applies only to default authentication.
Use EC2 Role to Assume Role	Optional. Select the check box to enable the EC2 role to assume another IAM role specified in the IAM Role ARN option. The EC2 role must have a policy attached with a permission to assume an IAM role from the same or different account. Does not apply to application ingestion and database ingestion tasks. By default, this check box is not selected.
S3 Access Key ID	Access key to access the Amazon S3 staging bucket. Enter the access key value based on the following authentication methods: Basic authentication. Enter the actual access key value. IAM authentication. Do not enter the access key value. Temporary security credentials using assume role. Enter access key of an IAM user with no permissions to access the Amazon S3 staging bucket. Assume role for EC2. Do not enter the access key value. If you use the connection for application ingestion or database ingestion tasks that use key-based authentication, provide the access key value.
S3 Secret Access Key	Secret access key to access the Amazon S3 staging bucket. The secret key is associated with the access key and uniquely identifies the account. Enter the access key value based on the following authentication methods: Basic authentication. Enter the actual access secret value. IAM authentication. Do not enter the access secret value. Temporary security credentials using assume role. Enter access secret of an IAM user with no permissions to access Amazon S3 staging bucket. Assume role for EC2. Do not enter the access secret value. If you use the connection for application ingestion or database ingestion tasks that use key-based authentication, provide the access key value.
S3 IAM 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 the Amazon S3 staging bucket. For more information about how to get the ARN of the IAM role, see the AWS documentation. If you use the connection for application ingestion or database ingestion tasks that uses role-based authentication, but not the default role for the AWS cluster, specify an IAM role ARN. If you use the default role, leave this field blank.
External Id	The external ID for a more secure access to the Amazon S3 bucket when the Amazon S3 staging bucket is in a different AWS account. Does not apply to application ingestion and database ingestion tasks.
Master Symmetric Key ¹	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. Does not apply to application ingestion and database ingestion tasks.
JDBC URL	The URL of the Amazon Redshift V2 connection. Enter the JDBC URL in the following format: jdbc:redshift://<amazon_redshift_host>:<port_number>/<database_name>
Cluster Region	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 select a cluster region in both Cluster Region and JDBC URL connection properties, the agent 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. You can only read data from or write data to the cluster regions supported by AWS SDK. Select one of the following cluster regions: None Asia Pacific(Mumbai) Asia Pacific(Seoul) Asia Pacific(Singapore) Asia Pacific(Sydney) Asia Pacific(Tokyo) Asia Pacific(Hong Kong) AWS GovCloud (US) AWS GovCloud (US-East) Canada(Central) China(Bejing) China(Ningxia) EU(Ireland) EU(Frankfurt) EU(Paris) EU(Stockholm) South America(Sao Paulo) Middle East(Bahrain) US East(N. Virginia) US East(Ohio) US West(N. California) US West(Oregon) Default is None .
Customer Master Key ID	The customer master key ID generated by AWS Key Management Service (AWS KMS) or the ARN of your custom key for cross-account access. You must generate the customer master key ID for the same region where your Amazon S3 staging bucket resides. You can either enter the customer-generated customer master key ID or the default customer master key ID. You can use a cross account KMS key for the same regions when you run mappings in advanced mode. Doesn't apply to application ingestion and database ingestion tasks.
¹Doesn't apply to mappings in advanced mode.

Amazon Redshift AssumeRole authentication

Configure the following properties when you select the Redshift AssumeRole authentication type:

Property	Description
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.
Database Group	Name of the database group to which an IAM user will be added. You can add multiple database groups separated by a comma. If you do not specify a group, the user is added to the 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.
Auto Create DBUser	Select to create a new Amazon Redshift database user at run time. Default is disabled.
Redshift IAM Role ARN	The Amazon Resource Number (ARN) of the IAM role assumed by the user or EC2 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.
Redshift Access Key ID	The access key of the IAM user that has permissions to assume the Redshift IAM AssumeRole ARN.
Redshift Secret Access Key	The secret access key of the IAM user that has permissions to assume the Redshift IAM Assume Role ARN.