Amazon Redshift Connector Setup Guide

Configuration

Go to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see About Connectors.

After adding the connector, configure the following settings:

• Authentication Type
  • Select the authentication type:
    • STS: Requires the following fields Assume Role: ARN, Assume Role: Session Name. For more information, see STS credentials.
    • Access Key: Requires the following fields AWS Access Key and AWS Secret Access Key. For more information, see Access Key and Secret credentials.
• STS - Assume Role: ARN
  • Required for STS authentication. Provide the Amazon Resource Name (ARN) of the role to assume.
  • For example, arn:aws:iam:222222222222:role/myrole.
  • For more information, see AWS: Switching to an IAM Role.
• STS - Assume Role: Session Name
  • Required for STS authentication. Provide the session name of the role to assume.
  • Minimum length of 2, maximum length of 64.
• STS - Assume Role: External ID
  • Provide a third-party external identifier.
  • For more information, see AWS: Access to AWS accounts owned by third parties.
• Access Key - AWS Access Key
  • Required for Access Key authentication. Provide the AWS access key.
• Access Key - AWS Secret Access Key
  • Required for Access Key authentication. Provide the AWS secret access key.
• Region
  • (Required) Select a region.
• Secret Name
  • (Optional) If you are using the AWS Secrets Manager method to access Redshift, provide your Secret Name so Tealium can dynamically pull the Secret ARN to use on the Redshift connection.
• Workgroup Name
  • Required if Cluster Identifier isn’t provided. If you are accessing a Redshift SERVERLESS instance, provide your workgroup name.
• Cluster Identifier
  • Required if Workgroup Name isn’t provided. If you are using a Redshift Cluster, provide the cluster identifier.
• Database Name
  • (Optional) Provide your database name. Default value: dev.

Create a connection to AWS Redshift

Tealium requires a connection to an AWS Redshift instance to display a list of clusters, workspaces, databases, and upload event and audience data into your Redshift tables. You have two options for authentication:

• Provide an Access Key and Access Secret.
• Provide STS credentials.

Access Key and Secret credentials

To find your AWS Access Key and Secret:

1. Log in to the AWS Management Console and go to the IAM (Identity and Access Management) service.
2. Click Users and then click Add user.
3. Enter a username. For example, TealiumRedshiftUser.
4. Attach policies to the role. For more information, see Attach policies.
5. Create the keys.
   • Go to the Security credentials tab and click Create Access Key.
   • Copy the Access Key ID and Secret Access Key, and save them securely.

STS credentials

To find your STS credentials:

1. Log in to the AWS Management Console and go to the IAM (Identity and Access Management) service.
2. Click Roles, and then click Create role.
3. Under Trusted entity type, select the AWS account.
4. Select Another AWS account and enter the Tealium account ID: 757913464184.
5. (Optional) Select the Require external ID checkbox and specify the external ID that you want to use. External IDs can be up to 256 characters long and can include alphanumeric characters (A-Z, a-z, 0-9) and symbols, such as hyphens (-), underscores (_), and periods (.).
6. Enter a name for the role. The role name must start with TealiumRedshift. For example: TealiumRedshift-test.
7. Attach policies to the role. For more information, see Attach policies.
8. Create a trust policy.
   • Go to the Trust relationships tab and click Edit trust relationship.
   • Ensure that the trust policy allows the specific external ID to use the role you created and that the Tealium production account ID is 757913464184.
   • Set the EXTERNAL_ID value for the connection to Tealium. The ID can be up to 256 characters long and can include alphanumeric characters (A-Z, a-z, 0-9) and symbols, such as hyphens (-), underscores (_), and periods (.).

   {
     "Version": "2012-10-17",
     "Statement": [
       {
         "Effect": "Allow",
         "Principal": {
           "AWS": "arn:aws:iam::757913464184:root"
         },
         "Action": "sts:AssumeRole",
         "Condition": {
           "StringEquals": {
             "sts:ExternalId": "EXTERNAL_ID"
           }
         }
       }
     ]
   }
   

Attach policies

To attach the policies:

1. In the Permissions tab, click Attach existing policies directly.

   1. Full access

      • Search for and attach the SecretsManagerReadWrite, AmazonRedshiftAllCommandsFullAccess and AmazonRedshiftDataFullAccess policies for full access.

   2. Restricted access

      • To restrict access to a specific cluster, create a policy similar to the following example. In the example, YOUR_CLUSTER_ARN is the cluster that Tealium would use to insert event and audience data into your YOUR_DATABASE_ARN Redshift tables:

      {
        "Version": "2012-10-17",
        "Statement": [
          {
            "Sid": "RedshiftClusterManagement",
            "Effect": "Allow",
            "Action": [
              "redshift:DescribeClusters",
              "redshift:GetClusterCredentials",
              "redshift:GetClusterCredentialsWithIAM"
            ],
            "Resource": "arn:aws:redshift:YOUR_REGION:YOUR_ACCOUNT_ID:cluster/YOUR_CLUSTER_ARN"
          },
          {
            "Sid": "RedshiftDataAPI",
            "Effect": "Allow",
            "Action": [
              "redshift-data:ExecuteStatement",
              "redshift-data:BatchExecuteStatement",
              "redshift-data:DescribeStatement",
              "redshift-data:GetStatementResult",
              "redshift-data:ListStatements"
            ],
            "Resource": "arn:aws:redshift:YOUR_REGION:YOUR_ACCOUNT_ID:database/YOUR_DATABASE_ARN"
          },
          {
            "Sid": "SecretsManagerAccess",
            "Effect": "Allow",
            "Action": [
              "secretsmanager:GetSecretValue",
              "secretsmanager:DescribeSecret",
              "secretsmanager:ListSecrets"
            ],
            "Resource": "arn:aws:secretsmanager:YOUR_REGION:YOUR_ACCOUNT_ID:secret/YOUR_SECRET_ARN"
          }
        ]
      }
      

      • To restrict access to a specific workgroup, create a policy similar to the following example. In the example, YOUR_WORKGROUP_ARN is the cluster that Tealium would use to insert event and audience data into YOUR_DATABASE_ARN Redshift tables:

      {
        "Version": "2012-10-17",
        "Statement": [
          {
            "Sid": "RedshiftServerlessAccess",
            "Effect": "Allow",
            "Action": [
              "redshift-serverless:GetWorkgroup",
              "redshift-serverless:GetCredentials",
              "redshift-serverless:ListWorkgroups"
            ],
            "Resource": "arn:aws:redshift-serverless:YOUR_REGION:YOUR_ACCOUNT_ID:workgroup/YOUR_WORKGROUP_ARN"
          },
          {
            "Sid": "RedshiftDataAPI",
            "Effect": "Allow",
            "Action": [
              "redshift-data:ExecuteStatement",
              "redshift-data:BatchExecuteStatement",
              "redshift-data:DescribeStatement",
              "redshift-data:GetStatementResult",
              "redshift-data:ListStatements"
            ],
            "Resource": "arn:aws:redshift:YOUR_REGION:YOUR_ACCOUNT_ID:database/YOUR_DATABASE_ARN"
          },
          {
            "Sid": "SecretsManagerAccess",
            "Effect": "Allow",
            "Action": [
              "secretsmanager:GetSecretValue",
              "secretsmanager:DescribeSecret",
              "secretsmanager:ListSecrets"
            ],
            "Resource": "arn:aws:secretsmanager:YOUR_REGION:YOUR_ACCOUNT_ID:secret/YOUR_SECRET_ARN"
          }
        ]
      }
      

Actions

Enter a name for the action and select the action type from the drop-down menu.

The following section describes how to set up parameters and options for each action.

Send Entire Event Data (Micro-batch)

Batch Limits

This action uses batched requests to support high-volume data transfers to the vendor. For more information, see Batched Actions. Requests are queued until one of the following thresholds is met or the profile is published:

• Max number of requests: 50
• Max time since oldest request: 16 minutes

Parameters

Send Entire Event Data (Batch)

Batch Limits

This action uses batched requests to support high-volume data transfers to the vendor. For more information, see Batched Actions. Requests are queued until one of the following thresholds is met or the profile is published:

• Max number of requests: 2,000
• Max time since oldest request: 60 minutes

Parameters

Send Custom Event Data (Micro-batch)

Batch Limits

This action uses batched requests to support high-volume data transfers to the vendor. For more information, see Batched Actions. Requests are queued until one of the following thresholds is met or the profile is published:

• Max number of requests: 50
• Max time since oldest request: 16 minutes

Parameters

Custom Parameters

Send Custom Event Data (Batch)

Batch Limits

This action uses batched requests to support high-volume data transfers to the vendor. For more information, see Batched Actions. Requests are queued until one of the following thresholds is met or the profile is published:

• Max number of requests: 2,000
• Max time since oldest request: 60 minutes

Parameters

Custom Parameters

Send Entire Visitor Data (Micro-batch)

Batch Limits

This action uses batched requests to support high-volume data transfers to the vendor. For more information, see Batched Actions. Requests are queued until one of the following thresholds is met or the profile is published:

• Max number of requests: 50
• Max time since oldest request: 16 minutes

Parameters

Send Entire Visitor Data (Batch)

Batch Limits

This action uses batched requests to support high-volume data transfers to the vendor. For more information, see Batched Actions. Requests are queued until one of the following thresholds is met or the profile is published:

• Max number of requests: 2,000
• Max time since oldest request: 60 minutes

Parameters

Send Entire Event Data (Micro-batch)

Batch Limits

This action uses batched requests to support high-volume data transfers to the vendor. For more information, see Batched Actions. Requests are queued until one of the following thresholds is met or the profile is published:

• Max number of requests: 50
• Max time since oldest request: 16 minutes

Parameters

Custom Parameters

Send Entire Event Data (Micro-batch)

Batch Limits

This action uses batched requests to support high-volume data transfers to the vendor. For more information, see Batched Actions. Requests are queued until one of the following thresholds is met or the profile is published:

• Max number of requests: 2,000
• Max time since oldest request: 60 minutes

Parameters

Custom Parameters

Execute custom statement (Batch)

Batch Limits

This action uses batched requests to support high-volume data transfers to the vendor. For more information, see Batched Actions. Requests are queued until one of the following thresholds is met or the profile is published:

• Max number of requests: 40
• Max time since oldest request: 60 minutes

Parameters

Query example

If you added a mapping in the Query Parameters section such as my_boolean_tealium_attribute = MY_BOOLEAN_PARAM, then you reference that parameter using {{MY_BOOLEAN_PARAM}} in the query.

Example query where the following query parameters have been mapped: MY_STRING_PARAM, MY_BOOLEAN_PARAM, ANOTHER_PARAM, MY_PARAM.

INSERT INTO redshift_table (key1,key2) VALUES ('{{MY_STRING_PARAM}}', {{MY_BOOLEAN_PARAM}});
UPDATE redshift_table SET key1 = '{{MY_STRING_PARAM}}', key2 = {{MY_BOOLEAN_PARAM}} WHERE key3 = '{{ANOTHER_PARAM}}';
UPDATE redshift_table SET key2 = (SELECT new_key2 FROM source_table WHERE source_table.key1 = redshift_table.key1)
  WHERE EXISTS (SELECT 1 FROM source_table WHERE source_table.key1 LIKE %{{MY_PARAM}}%);