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:
1
bindings:
2
- name: kubemq-query-aws-redshift-service
3
source:
4
kind: kubemq.query
5
name: kubemq-query
6
properties:
7
address: "kubemq-cluster:50000"
8
client_id: "kubemq-query-aws-redshift-connector-svc"
9
auth_token: ""
10
channel: "query.aws.redshift.service"
11
group: ""
12
auto_reconnect: "true"
13
reconnect_interval_seconds: "1"
14
max_reconnects: "0"
15
target:
16
kind: aws.redshift.service
17
name: aws-redshift-service
18
properties:
19
aws_key: "id"
20
aws_secret_key: 'json'
21
region: "region"
22
token: ""
Copied!

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:
1
{
2
"metadata": {
3
"method": "create_tags",
4
"resource_arn": "arn:aws:redshift:region:account_id:cluster:cluster_name"
5
},
6
"data": "eyJ0ZXN0MS1rZXkiOiJ0ZXN0MS12YWx1ZSJ9"
7
}
Copied!

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:
1
{
2
"metadata": {
3
"method": "delete_tags",
4
"resource_arn": "arn:aws:redshift:region:account_id:cluster:cluster_name"
5
},
6
"data": "WyJ0ZXN0MS1rZXkiXQ=="
7
}
Copied!

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:
1
{
2
"metadata": {
3
"method": "list_tags"
4
},
5
"data": null
6
}
Copied!

List Snapshots

list all redshift snapshots.
List Snapshots:
Metadata Key
Required
Description
Possible values
method
yes
type of method
"list_snapshots"
Example:
1
{
2
"metadata": {
3
"method": "list_snapshots"
4
},
5
"data": null
6
}
Copied!

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:
1
{
2
"metadata": {
3
"method": "list_snapshots_by_tags_keys"
4
},
5
"data": "WyJ0ZXN0MS1rZXkiXQ=="
6
}
Copied!

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:
1
{
2
"metadata": {
3
"method": "list_snapshots_by_tags_keys"
4
},
5
"data": "WyJ0ZXN0MS1rZXkiXQ=="
6
}
Copied!

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:
1
{
2
"metadata": {
3
"method": "list_snapshots_by_tags_keys",
4
"resource_name": "my_cluster_name",
5
},
6
"data": null
7
}
Copied!

List Clusters

list clusters under redshift service
List Clusters:
Metadata Key
Required
Description
Possible values
method
yes
type of method
"list_clusters"
Example:
1
{
2
"metadata": {
3
"method": "list_clusters"
4
},
5
"data": null
6
}
Copied!

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:
1
{
2
"metadata": {
3
"method": "list_clusters_by_tags_keys"
4
},
5
"data": "WyJ0ZXN0MS1rZXkiXQ=="
6
}
Copied!

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:
1
{
2
"metadata": {
3
"method": "list_clusters_by_tags_values"
4
},
5
"data": "WyJ0ZXN0MS1rZXkiXQ=="
6
}
Copied!
Last modified 11mo ago