> For the complete documentation index, see [llms.txt](https://v2.dataos.info/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://v2.dataos.info/concepts/resources/depot/supported-sources/redshift.md).

# Amazon Redshift

## Pre-requisites specific to the Redshift Depot

To create a Redshift Depot, you must have the following details:

### Pre-requisites specific to DataOS

To create a Depot, you need the Data Admin role. Contact the DataOS Operator or Tenant Admin to get it.

Run this command to see your assigned roles.

```bash
dataos-ctl user get
#Expected Output: 
time="2026-03-30T17:49:18+05:30" level=info msg="😃 user get..."
time="2026-03-30T17:49:19+05:30" level=info msg="😃 user get...complete"

     NAME     │        ID         │  TYPE  │        EMAIL         │                  TAGS
──────────────┼───────────────────┼────────┼──────────────────────┼────────────────────────────────────────
 I Am Groot   │ iamgroottmdcio    │ person │ iam.groot@tmdc.io    │ roles:id:ct-onboarding-data-developer,
              │                   │        │                      │ roles:id:data-dev,
              │                   │        │                      │ roles:id:system-dev,
              │                   │        │                      │ roles:id:user,
              │                   │        │                      │ users:id:iamgroottmdcio

```

### Pre-requisites specific to the source system

* **Hostname**: The hostname or endpoint of the Redshift cluster, which specifies the server address to connect to. You can obtain this from the AWS Management Console under the Redshift cluster details or ask the administrator managing the cluster.
* **Port**: The port number on which the Redshift cluster is listening. The default port for Redshift is `5439`, but it may differ based on your setup. Check the cluster details in the AWS Management Console or consult your database administrator.
* **Database name**: The name of the specific database within the Redshift cluster you want to connect to. This can be found in the AWS Management Console or provided by the database administrator.
* **Username and password**: The credentials used to authenticate and access the Redshift database. These are set up when the user account is created and must be securely obtained from the Redshift administrator.

Accessing the Redshift database in Workflows or other DataOS Resources requires additional details:

* **Bucket name**: The name of the S3 bucket where the data resides. You can find this in the AWS S3 Console or consult the administrator managing the data storage.
* **Relative path**: The path within the S3 bucket pointing to the data you want to access. This path is typically structured based on your data organization and can be obtained from the team managing the data or the S3 Console.
* **AWS access key**: The Access Key ID used to authenticate and authorize API requests to AWS. You can obtain this from the AWS IAM (Identity and Access Management) Console under your user’s security credentials or request it from your AWS administrator.
* **AWS Secret Key**: The Secret Access Key associated with your AWS Access Key ID. This key is also available in the AWS IAM Console under security credentials and must be securely stored. If you do not have access, request it from your AWS administrator.

## Create a Redshift Depot

A Depot of type `redshift` connects to an Amazon Redshift database. A manifest template is provided below. To create a Depot of type `redshift`, follow these steps:

### **Step 1: Create a Secret for securing Redshift credentials**

Create a Secret Resource using the [Redshift](/concepts/resources/secret/data-sources/redshift.md) guide.

### **Step 2: Create a Redshift Depot manifest file**

Create a manifest file for the Redshift Depot.

{% tabs %}
{% tab title="Manifest file" %}

```yaml
name: ${{redshift-name}}
version: v2alpha
type: depot
tags:
  - Redshift
  - depot
  - warehouse
description: "Amazon Redshift cloud data warehouse depot for data storage and analytics"
spec:
  type: redshift
  spec:
    host: ${{redshift-host}}
    subprotocol: redshift
    port: 5439
    database: ${{redshift-database}}
    bucket: ${{redshift-bucket}}
    relativePath: ${{redshift-relative-path}}
    scheme: ${{redshift-scheme}}
  secrets:
    - id: "${{tenant-id}}:${{redshift-secret-name}}"
      purpose: scan
```

{% endtab %}

{% tab title="Example" %}

```yaml
name: ${{redshift-name}}
version: v2alpha
type: depot
tags:
  - Redshift
  - depot
  - warehouse
description: "Amazon Redshift cloud data warehouse depot for data storage and analytics"
spec:
  type: redshift
  spec:
    host: ${{redshift-host}}
    subprotocol: redshift
    port: 5439
    database: ${{redshift-database}}
    bucket: ${{redshift-bucket}}
    relativePath: ${{redshift-relative-path}}
    scheme: ${{redshift-scheme}}
  secrets:
    - id: "${{tenant-id}}:${{redshift-secret-name}}"
      purpose: scan
```

{% endtab %}
{% endtabs %}

For more information about each attribute, refer to the [configurations section.](/concepts/resources/secret/manifest-configuration.md)

### **Step 3: Apply the Depot manifest file**

Apply the manifest with the DataOS CLI:

```bash
dataos-ctl resource apply -f ${{manifest-file-path}}
```

## Verify the Depot creation

Verify the Depot in two ways:

* List Depots where you are the owner:

  ```bash
  dataos-ctl resource get -t depot
  ```
* List all Depots in the current Tenant:

  ```bash
  dataos-ctl resource get -t depot -a
  ```

## Delete a Depot

{% hint style="warning" %}
Best practice: Delete Resources that are no longer in use to save time and reduce costs.
{% endhint %}

To delete a Depot, use the DataOS CLI:

{% tabs %}
{% tab title="Command 1" %}

```bash
dataos-ctl resource delete -t depot -n ${{name}}
```

{% endtab %}

{% tab title="Command 2 " %}

```bash
dataos-ctl resource delete -i "${{resource-name}}|v2alpha|depot"
```

{% endtab %}

{% tab title="Command 3" %}

```bash
dataos-ctl resource delete -f ${{manifest-file-path}}
```

{% endtab %}
{% endtabs %}

Specify the Resource type and Depot name in the `delete` command.

**Example:**

{% tabs %}
{% tab title="Command 1" %}

```bash
dataos-ctl resource delete -t depot -n testdepot
#output
time="2026-03-25T15:53:55+05:30" level=info msg="🗑 delete..."
time="2026-03-25T15:53:55+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot..."
time="2026-03-25T15:53:56+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot...deleted"
time="2026-03-25T15:53:56+05:30" level=info msg="🗑 delete...complete"
time="2026-03-25T15:53:56+05:30" level=info msg="🗑 delete...complete"
```

{% endtab %}

{% tab title="Command 2" %}

```bash
dataos-ctl resource delete -i "testdepot|v2alpha|depot"
#output
time="2026-03-25T15:55:37+05:30" level=info msg="🗑 delete..."
time="2026-03-25T15:55:37+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot..."
time="2026-03-25T15:55:37+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot...deleted"
time="2026-03-25T15:55:37+05:30" level=info msg="🗑 delete...complete"
```

{% endtab %}

{% tab title="Command 3" %}

```bash
dataos-ctl resource delete -f /path/to/depot.yaml
#output
time="2026-03-25T15:53:55+05:30" level=info msg="🗑 delete..."
time="2026-03-25T15:53:55+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot..."
time="2026-03-25T15:53:56+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot...deleted"
time="2026-03-25T15:53:56+05:30" level=info msg="🗑 delete...complete"
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://v2.dataos.info/concepts/resources/depot/supported-sources/redshift.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.