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.

Image Removed

Once in the AWS Injector Settings configuration section there are five tabs: General, Kinesis, DynamoDB, Sets, and Tag Agents.  Each of these tabs is described in detail in the following sections.

General

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

Image RemovedImage Added

The general configurations options available on this tab are listed below:

...

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

Image AddedImage Removed

One or more AWS Kinesis Stream endpoints can be configured on this tab. The configuration options for an AWS Kinesis Stream connection are listed below.

...

• Setting Name
  • This is a friendly name of the AWS Kinesis Stream used to easily identify it.  This must also be unique.
• AWS Access Key
  • The AWS Access Key ID.
  • Example: AKIAIOSFODNN7EXAMPLE
• AWS Secret Key
  • The AWS Secret Access Key.
  • Example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
• AWS Session Tokens
  • Whether to use AWS session tokens
• Role ARN
  • The AWS role ARN
• Session Duration
  • The AWS session duration
• Session Name
  • The AWS session name
• Region
  • The AWS region.
• Set
  • The Set to associate this AWS Kinesis Stream connection with.
• Stream Name
  • The name of the AWS Kinesis Stream.
• Firehose Stream
  
  • Whether this setting is for a Kinesis Data Firehose delivery stream
  Set
  
  • The Set to associate this AWS Kinesis Stream connection with.

Store & Forward

• Store & Forward Enabled
  • Whether to enable Store & Forward capbilities 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.

Image RemovedImage Added

DynamoDB Databases

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

Image RemovedImage Added

One or more AWS DynamoDB Database endpoints can be configured on this tab. The configuration options for an AWS DynamoDB Database connection are listed below.

...

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

Image RemovedImage Added

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.

Image RemovedImage Added

Additional Sets can be configured for situations where multiple Tag Agents will need to push to different AWS endpoints. The configuration options for Sets are listed below.

...

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

Image RemovedImage Added

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.

Image RemovedImage Added

Tag Agents are configured to point to a single folder.  All Tags within that folder will be monitored by the Tag Agent. 

...

As you can see, the Sparkplug settings can be used to either hard-code these IDs, or leave them blank so that the Agent will scan and discover them based on the tag tree layout. 

Advanced

• Filtered Properties
  • A semicolon delimited list of Tag properties to filter/block from being published.  These should typically not be modified unless there is an explicit requirement that a specific property is needed to be added or removed from the default.

Clicking on the 'Create new Tag Agent Settings..' link will bring up the following form to add a new Tag Agent.

Image AddedImage Removed