Create a signed WebSocket URL for a MQTT AWS device gateway endpoint, so browsers can connect to AWS IOT MQTT message queues easily
APACHE-2.0 License
Utility function that produces a signed websocket URL for AWS IOT Device Gateway, allowing browsers to connect directly to AWS IOT data pipelines.
The code is mostly extracted from the AWS IOT websocket MQTT Sample, and packaged as a NPM library for convenient use.
Here is a list of changes from the original code:
The original code copyright is by Amazon.com, Inc. or its affiliates.
See the IOT Protocols Guide and Signature V4 Signing Process for more information on the structure of the signed URL.
var signUrl = require('aws-device-gateway-signed-url');
signedUrl = signUrl (params);
params
is a key-value hash containing the following keys:
regionName
: AWS region, for example, us-east-1
endpoint
: AWS device gateway endpoint URL. (see Retrieving your endpoint URL below)secretKey
: AWS access Secret keyaccessKey
: AWS access key IDsessionToken
: optional an AWS Session Token (from STS, Cognito, or assumed role)expires
: optional seconds until the signed url expires. default is 86400
, 1 dayEach AWS account has an associated IOT device gateway endpoint. Use the following AWS CLI command to discover your endpoint URL
aws iot describe-endpoint --query endpointAddress --output text