Page History

The AWS Injector module provides the ability to push Tag data to an Kinesis Streams and DynamoDB Database endpoints.  The settings configuration for this module are located under the Configure tab of the Ignition Gateway web UI.

Once in the AWS Injector Settings configuration section there are five tabs: General, Kinesis, DynamoDB, Sets, and Tag Agents.  Each

Each of these tabs is described in detail in the following sections.

Anchor
general general

General

The first tab contains the general settings for the AWS Injector module.

...

• Enabled
  • Sets whether the module is enabled or disabled.  If disabled, the Tag Agents will not run and now data will be pushed to any configured endpoints.

Anchor
kinesis kinesis

Kinesis Streams

The next tab is the list of AWS Kinesis Stream endpoints that the module should connect to to push Tag data.

...

• Store & Forward Enabled
  • Whether to enable Store & Forward capbilities capabilities for this stream
• Store & Forward Type
  • The type of the Store & Forward mechanism
• Message Capacity
  • The Maximum number of messages to store before dropping the oldest historical messages
• Flush Period
  • The period of time to wait (in milliseconds) between sending when flushing messages

...

Clicking on the "Create new Kinesis Stream Setting..." link will bring up the following form for adding a new AWS Kinesis Stream endpoint.

Anchor
dynamodb dynamodb

DynamoDB Databases

The third tab is the list of AWS DynamoDB Database endpoints that the module should connect to to push Tag data.

...

• Store & Forward Enabled
  • Whether to enable Store & Forward capbilities capabilities for this stream
• Store & Forward Type
  • The type of the Store & Forward mechanism with Disk_Backed and In_Memory options
  • Data stored with an In-Memory Store & Forward will not be persisted across a module disable/enable, module restart or power loss. 
  • Data stored with a Disk-Backed Store & Forward will persist across a module disable/enable, module restart or power loss.
• Message Capacity
  • The Maximum number of messages to store before dropping the oldest historical messages
• Flush Period
  • The period of time to wait (in milliseconds) between sending when flushing messages

...

Clicking on the "Create new DynamoDB Setting..." link will bring up the following form for adding a new AWS DynamoDB Database endpoint.

Anchor
sets sets

Sets

The Sets tab contains a list of AWS Sets.  Each set represents a grouping of AWS endpoints.  When a set is referenced by a Tag Agent the Agent will push Tag data to all AWS endpoints contained within that Set. The Sets are disjoint, meaning that a single AWS Kinesis Stream or DynamoDB Database endpoint cannot be in more than one set.  Out of the box the AWS Injector module will have one "Default" set defined.

...

Clicking on the 'Create new AWS Set...' link will bring up the following form to add a new Set.

Anchor
tagagents tagagents

Tag Agents

Tag Agents are the workers within AWS Injector that monitor tag events, convert them to a JSON representation, and push them to one or more AWS endpoints. Out of the box the AWS Injector module will have one "default" Tag Agent defined.

...