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

Prerequisites

The following required to run the aws-sns target connector:
  • kubemq cluster
  • aws account with sns active service
  • kubemq-source deployment

Configuration

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

Usage

List Topics

list all topics
List Topics:
Metadata Key
Required
Description
Possible values
method
yes
type of method
"list_topics"
Example:
1
{
2
"metadata": {
3
"method": "list_topics"
4
},
5
"data": null
6
}
Copied!

List Subscriptions

list all subscriptions
List Subscriptions:
Metadata Key
Required
Description
Possible values
method
yes
type of method
"list_subscriptions"
Example:
1
{
2
"metadata": {
3
"method": "list_subscriptions"
4
},
5
"data": null
6
}
Copied!

List Subscriptions By Topic

list all Subscriptions of the selected topic
List Subscriptions By Topic:
Metadata Key
Required
Description
Possible values
method
yes
type of method
"list_subscriptions_by_topic"
topic
yes
topic_name
"arn:aws-my-topic"
Example:
1
{
2
"metadata": {
3
"method": "list_subscriptions_by_topic",
4
"topic": "arn:aws-my-topic"
5
},
6
"data": null
7
}
Copied!

Create Topic

create a new topic , topic name must by unique
Create Topic:
Metadata Key
Required
Description
Possible values
method
yes
type of method
"create_topic"
topic
yes
topic_name
"arn:aws-my-topic"
data
no
create attributes as base64
'{"DisplayName":"my-display-name"}'
Example:
1
{
2
"metadata": {
3
"method": "create_topic",
4
"topic": "arn:aws-my-topic"
5
},
6
"data": "eyJEaXNwbGF5TmFtZSI6Im15LWRpc3BsYXktbmFtZSJ9"
7
}
Copied!

Send Message

send a message to topic.
Send Message:
Metadata Key
Required
Description
Possible values
method
yes
type of method
"send_message"
topic
no(unless target_arn is missing)
topic_name
"arn:aws-my-topic"
target_arn
no(unless topic is missing)
target_arn
"arn:aws-my-topic"
message
yes
message body as string
'some message in string format'
message
yes
message body as string
'some message in string format'
subject
no
sns subject name
"string name of sns subject"
phone_number
no
valid phone number
"valid phone number"
data
no
message attributes as base64
"[{"name":"store","data_type":"String","string_value":"my_store"},{"name":"event","data_type":"String","string_value":"my_event"}]"
Example:
1
{
2
"metadata": {
3
"method": "send_message",
4
"topic": "arn:aws-my-topic"
5
"message": "my message to send"
6
},
7
"data": "W3sibmFtZSI6InN0b3JlIiwiZGF0YV90eXBlIjoiU3RyaW5nIiwic3RyaW5nX3ZhbHVlIjoibXlfc3RvcmUifSx7Im5hbWUiOiJldmVudCIsImRhdGFfdHlwZSI6IlN0cmluZyIsInN0cmluZ192YWx1ZSI6Im15X2V2ZW50In1d"
8
}
Copied!

Subscribe

Subscribe to topic
Subscribe:
Metadata Key
Required
Description
Possible values
method
yes
type of method
"subscribe"
topic
yes
topic_name
"arn:aws-my-topic"
"arn:aws-my-topic"
data
no
Subscribe attributes as base64
'{"store": ["mystore"],"event": [{"anything-but": "my-event"}]}'
Example:
1
{
2
"metadata": {
3
"method": "subscribe",
4
"topic": "arn:aws-my-topic"
5
},
6
"data": "eyJzdG9yZSI6IFsibXlzdG9yZSJdLCJldmVudCI6IFt7ImFueXRoaW5nLWJ1dCI6ICJteS1ldmVudCJ9XX0="
7
}
Copied!

Delete Topic

delete the selected topic
Delete Topic:
Metadata Key
Required
Description
Possible values
method
yes
type of method
"delete_topic"
topic
yes
topic_name
"arn:aws-my-topic"
Example:
1
{
2
"metadata": {
3
"method": "delete_topic",
4
"topic": "arn:aws-my-topic"
5
},
6
"data": null
7
}
Copied!
Last modified 11mo ago