AWS SNS Connector

reshuffle-aws-connectors

npm install reshuffle-aws-connectors

Reshuffle AWS SNS Connector

This Reshuffle connector can be used to send messages using AWS SNS.

The following example sends a message via AWS SNS when Reshuffle receives an HTTP request on /send

const { HttpConnector, Reshuffle } = require('reshuffle')
const { AWSSNSConnector } = require('reshuffle-aws-connectors')

const app = new Reshuffle()

const snsConnector = new AWSSNSConnector(app, {
  accessKeyId: process.env.AWS_ACCESS_KEY_ID,
  secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
  region: process.env.AWS_REGION,
})

const httpConnector = new HttpConnector(app)

httpConnector.on({ method: 'GET', path: '/send' }, async (event, app) => {
  const params = {
    Message: 'Message from Reshuffle!',
    TopicArn: 'arn:aws:sns:<region>:<id>:<topic_name>',
  }

  const response = await snsConnector.publish(params)

  return event.res.json({ ok: !!response.MessageId })
})

app.start()

Configuration Configuration options

Connector actions:

Publish Publish messages SDK:

sdk Get direct SNS SDK access

Configuration options

const app = new Reshuffle()
const awsSNSConnector = new AWSSNSConnector(app, {
  accessKeyId: process.env.AWS_ACCESS_KEY_ID,
  secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
  region: process.env.AWS_DEFAULT_REGION,
})

Connector events

N/A

Connector actions

Publish message

Definition:

(params: AWS.SNS.Types.PublishInput) => Promise<PromiseResult<AWS.SNS.PublishResponse, AWS.AWSError>>

// At least one of these parameters must be provided
export interface PublishInput {
    /**
     * The topic to publish to.
     */
    TopicArn?: topicARN;
    /**
     *The TargetArn to publish to
     */
    TargetArn?: String;
    /**
     * The phone number to deliver an SMS message to. Use E.164 format.
     */
    PhoneNumber?: String;
    /**
     * The message you to send. If you are publishing to a topic and you want to send the same message to
     all transport protocols, include the text of the message as a String value. If you want to send
     different messages for each transport protocol, set the value of the MessageStructure parameter to json 
     and use a JSON object for the Message parameter.   
     Constraints:   With the exception of SMS, messages must be UTF-8 encoded strings 
     and at most 256 KB in size (262,144 bytes, not 262,144 characters).   For SMS, each message can 
     contain up to 140 characters. This character limit depends on the encoding schema. For example, 
     an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters. If 
     you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple 
     messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off 
     at whole-word boundaries. The total size limit for a single SMS Publish action is 1,600 
     characters.   JSON-specific constraints:   Keys in the JSON object that correspond to supported 
     transport protocols must have simple JSON string values.   The values will be parsed (unescaped) 
     before they are used in outgoing messages.   Outbound notifications are JSON encoded (meaning 
     that the characters will be reescaped for sending).   Values have a minimum length of 0 (the 
     empty string, "", is allowed).   Values have a maximum length bounded by the overall message 
     size (so, including multiple protocols may limit message sizes).   Non-string values will cause 
     the key to be ignored.   Keys that do not correspond to supported transport protocols are 
     ignored.   Duplicate keys are not allowed.   Failure to parse or validate any key or value in 
     the message will cause the Publish call to return an error (no partial delivery).  
     */
    Message: message;
    /**
     * Optional parameter to be used as the "Subject" line when the message is delivered to email 
     endpoints. This field will also be included, if present, in the standard JSON messages delivered 
     to other endpoints. Constraints: Subjects must be ASCII text that begins with a letter, number, 
     or punctuation mark; must not include line breaks or control characters; and must be less than 
     100 characters long.
     */
    Subject?: subject;
    /**
     * Set MessageStructure to json if you want to send a different message for each protocol. For 
     example, using one publish action, you can send a short message to your SMS subscribers and a 
     longer message to your email subscribers. If you set MessageStructure to json, the value of the 
     Message parameter must:    be a syntactically valid JSON object; and   contain at least a 
     top-level JSON key of "default" with a value that is a string.   You can define other top-level 
     keys that define the message you want to send to a specific transport protocol (e.g., "http"). 
     Valid value: json 
     */
    MessageStructure?: messageStructure;
    /**
     * Message attributes for Publish action.
     */
    MessageAttributes?: MessageAttributeMap;
    /**
     * This parameter applies only to FIFO (first-in-first-out) topics. The MessageDeduplicationId 
     can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation 
     (!"#$%&amp;'()*+,-./:;&lt;=&gt;?@[\]^_`{|}~). 
     Every message must have a unique MessageDeduplicationId, which is a token used for deduplication 
     of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, 
     any message sent with the same MessageDeduplicationId during the 5-minute deduplication interval 
     is treated as a duplicate.  If the topic has ContentBasedDeduplication set, the system generates
     a MessageDeduplicationId based on the contents of the message. Your MessageDeduplicationId 
     overrides the generated one.
     */
    MessageDeduplicationId?: String;
    /**
     * This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId can 
     contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation 
     (!"#$%&amp;'()*+,-./:;&lt;=&gt;?@[\]^_`{|}~). 
     The MessageGroupId is a tag that specifies that a message belongs to a specific message group. 
     Messages that belong to the same message group are processed in a FIFO manner (however, messages 
     in different message groups might be processed out of order). Every message must include a 
     MessageGroupId.
     */
    MessageGroupId?: String;
  }

Usage:

const params = {
  Message: 'Message from Reshuffle!',
  TopicArn: 'arn:aws:sns:<region>:<id>:<topic_name>',
}
const response = await snsConnector.publish(params)
console.log(response.MessageId)

SDK

SDK action

Returns a AWS SNS client instance

Definition:

() => AWS.SNS

Usage:

const sns = await snsConnector.sdk()

Documentation

Introduction

Classes

Connectors

Deployment