# RedShift Service

Kubemq aws-redshift target connector allows services using kubemq server to access aws redshift service.

## Prerequisites

The following required to run the aws-redshift service target connector:

* kubemq cluster
* aws account with redshift active service(Not rds, see rds/redshift)
* kubemq-source deployment

## Configuration

redshift target connector configuration properties:

| Properties Key   | Required | Description                       | Example                        |
| ---------------- | -------- | --------------------------------- | ------------------------------ |
| aws\_key         | yes      | aws key                           | aws key supplied by aws        |
| aws\_secret\_key | yes      | aws secret key                    | aws secret key supplied by aws |
| region           | yes      | region                            | aws region                     |
| token            | no       | aws token ("default" empty string | aws token                      |

Example:

```yaml
bindings:
  - name: kubemq-query-aws-redshift-service
    source:
      kind: kubemq.query
      name: kubemq-query
      properties:
        address: "kubemq-cluster:50000"
        client_id: "kubemq-query-aws-redshift-connector-svc"
        auth_token: ""
        channel: "query.aws.redshift.service"
        group:   ""
        auto_reconnect: "true"
        reconnect_interval_seconds: "1"
        max_reconnects: "0"
    target:
      kind: aws.redshift.service
      name: aws-redshift-service
      properties:
        aws_key: "id"
        aws_secret_key: 'json'
        region:  "region"
        token: ""
```

## Usage

### Create Tags

create a tag for a resource ,must be accessible to redshift cluster.

Create Tags:

| Metadata Key  | Required | Description                           | Possible values                                             |
| ------------- | -------- | ------------------------------------- | ----------------------------------------------------------- |
| method        | yes      | type of method                        | "create\_tags"                                              |
| resource\_arn | yes      | aws resource ARN                      | "arn:aws:redshift:region:account\_id:cluster:cluster\_name" |
| data          | yes      | key value of string string(tag-value) | "eyJ0ZXN0MS1rZXkiOiJ0ZXN0MS12YWx1ZSJ9"                      |

Example:

```javascript
{
  "metadata": {
    "method": "create_tags",
    "resource_arn": "arn:aws:redshift:region:account_id:cluster:cluster_name"
  },
  "data": "eyJ0ZXN0MS1rZXkiOiJ0ZXN0MS12YWx1ZSJ9"
}
```

### Delete Tags

delete tag from resource,must be accessible to redshift cluster.

Delete Tags:

| Metadata Key  | Required | Description                          | Possible values                                             |
| ------------- | -------- | ------------------------------------ | ----------------------------------------------------------- |
| method        | yes      | type of method                       | "delete\_tags"                                              |
| resource\_arn | yes      | aws resource ARN                     | "arn:aws:redshift:region:account\_id:cluster:cluster\_name" |
| data          | yes      | key slice of tags to remove(by keys) | "WyJ0ZXN0MS1rZXkiXQ=="                                      |

Example:

```javascript
{
  "metadata": {
    "method": "delete_tags",
    "resource_arn": "arn:aws:redshift:region:account_id:cluster:cluster_name"
  },
  "data": "WyJ0ZXN0MS1rZXkiXQ=="
}
```

### List Tags

list all tags on the redshift cluster

List Tags:

| Metadata Key | Required | Description    | Possible values |   |
| ------------ | -------- | -------------- | --------------- | - |
| method       | yes      | type of method | "list\_tags"    |   |

Example:

```javascript
{
  "metadata": {
    "method": "list_tags"
  },
  "data": null
}
```

### List Snapshots

list all redshift snapshots.

List Snapshots:

| Metadata Key | Required | Description    | Possible values   |   |
| ------------ | -------- | -------------- | ----------------- | - |
| method       | yes      | type of method | "list\_snapshots" |   |

Example:

```javascript
{
  "metadata": {
    "method": "list_snapshots"
  },
  "data": null
}
```

### List Snapshots By Tag Keys

list all redshift snapshots with the matching tag keys.

List Snapshots By Tag Keys:

| Metadata Key | Required | Description                             | Possible values                   |   |
| ------------ | -------- | --------------------------------------- | --------------------------------- | - |
| method       | yes      | type of method                          | "list\_snapshots\_by\_tags\_keys" |   |
| data         | yes      | key slice of tags to search by(by keys) | "WyJ0ZXN0MS1rZXkiXQ=="            |   |

Example:

```javascript
{
  "metadata": {
    "method": "list_snapshots_by_tags_keys"
  },
  "data": "WyJ0ZXN0MS1rZXkiXQ=="
}
```

### List Snapshots By Tag Values

list all redshift snapshots with the matching tag Values.

List Snapshots By Tag Values:

| Metadata Key | Required | Description                               | Possible values                     |   |
| ------------ | -------- | ----------------------------------------- | ----------------------------------- | - |
| method       | yes      | type of method                            | "list\_snapshots\_by\_tags\_values" |   |
| data         | yes      | key slice of tags to search by(by values) | "WyJ0ZXN0MS1rZXkiXQ=="              |   |

Example:

```javascript
{
  "metadata": {
    "method": "list_snapshots_by_tags_keys"
  },
  "data": "WyJ0ZXN0MS1rZXkiXQ=="
}
```

### Describe Clusters

Describe Clusters:

| Metadata Key   | Required | Description       | Possible values     |   |
| -------------- | -------- | ----------------- | ------------------- | - |
| method         | yes      | type of method    | "describe\_cluster" |   |
| resource\_name | yes      | aws resource name | "my\_cluster\_name" |   |

Example:

```javascript
{
  "metadata": {
    "method": "list_snapshots_by_tags_keys",
    "resource_name": "my_cluster_name",
  },
  "data": null
}
```

### List Clusters

list clusters under redshift service

List Clusters:

| Metadata Key | Required | Description    | Possible values  |   |
| ------------ | -------- | -------------- | ---------------- | - |
| method       | yes      | type of method | "list\_clusters" |   |

Example:

```javascript
{
  "metadata": {
    "method": "list_clusters"
  },
  "data": null
}
```

### List Clusters By Tag Keys

list clusters under redshift service by tag keys

List Clusters By Tag Keys:

| Metadata Key | Required | Description                             | Possible values                  |   |
| ------------ | -------- | --------------------------------------- | -------------------------------- | - |
| method       | yes      | type of method                          | "list\_clusters\_by\_tags\_keys" |   |
| data         | yes      | key slice of tags to search by(by keys) | "WyJ0ZXN0MS1rZXkiXQ=="           |   |

Example:

```javascript
{
  "metadata": {
    "method": "list_clusters_by_tags_keys"
  },
  "data": "WyJ0ZXN0MS1rZXkiXQ=="
}
```

### List Clusters By Tag Values

list clusters under redshift service by tag values

List Clusters By Tag Values:

| Metadata Key | Required | Description                               | Possible values                    |   |
| ------------ | -------- | ----------------------------------------- | ---------------------------------- | - |
| method       | yes      | type of method                            | "list\_clusters\_by\_tags\_values" |   |
| data         | yes      | key slice of tags to search by(by values) | "WyJ0ZXN0MS1rZXkiXQ=="             |   |

Example:

```javascript
{
  "metadata": {
    "method": "list_clusters_by_tags_values"
  },
  "data": "WyJ0ZXN0MS1rZXkiXQ=="
}
```


---

# Agent Instructions: 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:

```
GET https://docs.kubemq.io/configuration/connectors/kubemq-targets/aws/redshift.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.