# AWS Redshift

## Prerequisites

- The [hostname][aws-redshift-docs-connection-string] for the [AWS
  Redshift][aws-redshift] cluster
- The [username/password][aws-redshift-docs-users] for the [AWS
  Redshift][aws-redshift] cluster **or** IAM credentials with
  `redshift:GetClusterCredentialsWithIAM` and `redshift:DescribeClusters`
  permissions
- The name of the database to use within the [AWS Redshift][aws-redshift]
  cluster

<InfoBox>

If the cluster is configured within a [VPC][aws-vpc], then Cube **must** have a
network route to the cluster.

</InfoBox>

## Setup

### Manual

Add the following to a `.env` file in your Cube project:

#### Password Authentication

```dotenv
CUBEJS_DB_TYPE=redshift
CUBEJS_DB_HOST=my-redshift-cluster.cfbs3dkw1io8.eu-west-1.redshift.amazonaws.com
CUBEJS_DB_NAME=my_redshift_database
CUBEJS_DB_USER=<REDSHIFT_USER>
CUBEJS_DB_PASS=<REDSHIFT_PASSWORD>
```

#### IAM Authentication

For enhanced security, you can configure Cube to use IAM authentication
instead of username and password. When running in AWS (EC2, ECS, EKS with
IRSA), the driver can use the instance's IAM role to obtain temporary
database credentials automatically.

Omit <EnvVar>CUBEJS_DB_USER</EnvVar> and <EnvVar>CUBEJS_DB_PASS</EnvVar> to enable IAM authentication:

```dotenv
CUBEJS_DB_TYPE=redshift
CUBEJS_DB_HOST=my-redshift-cluster.xxx.eu-west-1.redshift.amazonaws.com
CUBEJS_DB_NAME=my_redshift_database
CUBEJS_DB_SSL=true
CUBEJS_DB_REDSHIFT_AWS_REGION=eu-west-1
CUBEJS_DB_REDSHIFT_CLUSTER_IDENTIFIER=my-redshift-cluster
```

The driver uses the AWS SDK's default credential chain (IAM instance profile,
EKS IRSA, etc.) to obtain temporary database credentials via the
`redshift:GetClusterCredentialsWithIAM` API.

#### IAM Role Assumption

For cross-account access or enhanced security, you can configure Cube to assume
an IAM role:

```dotenv
CUBEJS_DB_REDSHIFT_AWS_REGION=eu-west-1
CUBEJS_DB_REDSHIFT_CLUSTER_IDENTIFIER=my-redshift-cluster
CUBEJS_DB_REDSHIFT_ASSUME_ROLE_ARN=arn:aws:iam::123456789012:role/RedshiftAccessRole
CUBEJS_DB_REDSHIFT_ASSUME_ROLE_EXTERNAL_ID=unique-external-id
```

### Cube Cloud

<InfoBox heading="Allowing connections from Cube Cloud IP">

In some cases you'll need to allow connections from your Cube Cloud deployment
IP address to your database. You can copy the IP address from either the
Database Setup step in deployment creation, or from <Btn>Settings →
Configuration</Btn> in your deployment.

</InfoBox>

The following fields are required when creating an AWS Redshift connection:

<Screenshot
  alt="Cube Cloud AWS Redshift Configuration Screen"
  src="https://ucarecdn.com/4ccd3485-36fe-4740-9a11-0e8fb23fe8c3/"
/>

Cube Cloud also supports connecting to data sources within private VPCs
if [dedicated infrastructure][ref-dedicated-infra] is used. Check out the
[VPC connectivity guide][ref-cloud-conf-vpc] for details.

[ref-dedicated-infra]: /product/deployment/cloud/infrastructure#dedicated-infrastructure
[ref-cloud-conf-vpc]: /product/deployment/cloud/vpc

## Environment Variables

| Environment Variable                        | Description                                                                         | Possible Values           | Required |
| ------------------------------------------- | ----------------------------------------------------------------------------------- | ------------------------- | :------: |
| <EnvVar>CUBEJS_DB_HOST</EnvVar>                            | The host URL for a database                                                         | A valid database host URL |    ✅    |
| <EnvVar>CUBEJS_DB_PORT</EnvVar>                            | The port for the database connection                                                | A valid port number       |    ❌    |
| <EnvVar>CUBEJS_DB_NAME</EnvVar>                            | The name of the database to connect to                                              | A valid database name     |    ✅    |
| <EnvVar>CUBEJS_DB_USER</EnvVar>                            | The username used to connect to the database                                        | A valid database username | ✅<sup>1</sup> |
| <EnvVar>CUBEJS_DB_PASS</EnvVar>                            | The password used to connect to the database                                        | A valid database password | ✅<sup>1</sup> |
| <EnvVar>CUBEJS_DB_SSL</EnvVar>                             | If `true`, enables SSL encryption for database connections from Cube                | `true`, `false`           |    ❌    |
| <EnvVar>CUBEJS_DB_MAX_POOL</EnvVar>                        | The maximum number of concurrent database connections to pool. Default is `16`      | A valid number            |    ❌    |
| <EnvVar>CUBEJS_DB_REDSHIFT_CLUSTER_IDENTIFIER</EnvVar>     | The Redshift cluster identifier. Required for IAM authentication                    | A valid cluster identifier |    ❌    |
| <EnvVar>CUBEJS_DB_REDSHIFT_AWS_REGION</EnvVar>             | The AWS region of the Redshift cluster. Required for IAM authentication             | [A valid AWS region][aws-docs-regions] |    ❌    |
| <EnvVar>CUBEJS_DB_REDSHIFT_ASSUME_ROLE_ARN</EnvVar>        | The ARN of the IAM role to assume for cross-account access                          | A valid IAM role ARN      |    ❌    |
| <EnvVar>CUBEJS_DB_REDSHIFT_ASSUME_ROLE_EXTERNAL_ID</EnvVar>| The external ID for the assumed role's trust policy                                 | A string                  |    ❌    |
| <EnvVar>CUBEJS_DB_EXPORT_BUCKET_REDSHIFT_ARN</EnvVar>      |                                                                                     |                           |    ❌    |
| <EnvVar>CUBEJS_CONCURRENCY</EnvVar>                        | The number of [concurrent queries][ref-data-source-concurrency] to the data source  | A valid number            |    ❌    |

<sup>1</sup> Required when using password-based authentication. When using IAM authentication, omit these and set <EnvVar>CUBEJS_DB_REDSHIFT_CLUSTER_IDENTIFIER</EnvVar> and <EnvVar>CUBEJS_DB_REDSHIFT_AWS_REGION</EnvVar> instead. The driver uses the AWS SDK's default credential chain (IAM instance profile, EKS IRSA, etc.) to obtain temporary database credentials.

[ref-data-source-concurrency]: /product/configuration/concurrency#data-source-concurrency

## Pre-Aggregation Feature Support

### count_distinct_approx

Measures of type
[`count_distinct_approx`][ref-schema-ref-types-formats-countdistinctapprox] can
not be used in pre-aggregations when using AWS Redshift as a source database.

## Pre-Aggregation Build Strategies

<InfoBox>

To learn more about pre-aggregation build strategies, [head
here][ref-caching-using-preaggs-build-strats].

</InfoBox>

| Feature       | Works with read-only mode? | Is default? |
| ------------- | :------------------------: | :---------: |
| Batching      |             ❌             |     ✅      |
| Export Bucket |             ❌             |     ❌      |

By default, AWS Redshift uses [batching][self-preaggs-batching] to build
pre-aggregations.

### Batching

Cube requires the Redshift user to have ownership of a schema in Redshift to
support pre-aggregations. By default, the schema name is `prod_pre_aggregations`.
It can be set using the [`pre_aggregations_schema` configration
option][ref-conf-preaggs-schema].

No extra configuration is required to configure batching for AWS Redshift.

### Export bucket

<WarningBox>

AWS Redshift **only** supports using AWS S3 for export buckets.

</WarningBox>

#### AWS S3

For [improved pre-aggregation performance with large
datasets][ref-caching-large-preaggs], enable export bucket functionality by
configuring Cube with the following environment variables:

<InfoBox>

Ensure the AWS credentials are correctly configured in IAM to allow reads and
writes to the export bucket in S3.

</InfoBox>

```dotenv
CUBEJS_DB_EXPORT_BUCKET_TYPE=s3
CUBEJS_DB_EXPORT_BUCKET=my.bucket.on.s3
CUBEJS_DB_EXPORT_BUCKET_AWS_KEY=<AWS_KEY>
CUBEJS_DB_EXPORT_BUCKET_AWS_SECRET=<AWS_SECRET>
CUBEJS_DB_EXPORT_BUCKET_AWS_REGION=<AWS_REGION>
```

## SSL

To enable SSL-encrypted connections between Cube and AWS Redshift, set the
<EnvVar>CUBEJS_DB_SSL</EnvVar> environment variable to `true`. For more information on how to
configure custom certificates, please check out [Enable SSL Connections to the
Database][ref-recipe-enable-ssl].

[aws-redshift-docs-connection-string]:
  https://docs.aws.amazon.com/redshift/latest/mgmt/configuring-connections.html#connecting-drivers
[aws-redshift-docs-users]:
  https://docs.aws.amazon.com/redshift/latest/dg/r_Users.html
[aws-redshift]: https://aws.amazon.com/redshift/
[aws-vpc]: https://aws.amazon.com/vpc/
[aws-docs-regions]:
  https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions
[ref-caching-large-preaggs]:
  /product/caching/using-pre-aggregations#export-bucket
[ref-caching-using-preaggs-build-strats]:
  /product/caching/using-pre-aggregations#pre-aggregation-build-strategies
[ref-recipe-enable-ssl]:
  /product/configuration/recipes/using-ssl-connections-to-data-source
[ref-schema-ref-types-formats-countdistinctapprox]: /product/data-modeling/reference/types-and-formats#count_distinct_approx
[self-preaggs-batching]: #batching
[ref-conf-preaggs-schema]: /product/configuration/reference/config#pre_aggregations_schema
