Page History

Basic Operations

The following API calls basic operations are available for the AWS Injector Module and can be executed within any of the available Ignition scopes.

Warning

Configuration changes made through scripting do not have the same validation as when made through the UI.

For example, deleting a Sets configuring that is being referenced by a Servers configuration will result in the UI showing an Internal Error. Follow the instructions here to recover the configuration.

`APIs`

...

Parameters
- String type
  - The type of configuration to create with valid options:
    - Kinesis
    - Dynamo
    - Agents
    - Sets
- Map props
  - Dictionary of properties making up the configuration with the following keys and datatypes:
    - Kinesis
      - Id (long)(cannot be null)
      - Name (str)
      - Enabled (bool)
      - UseAwsKeys (bool)(added 4.0.22)
      - AwsAccessKey (str)
      - AwsSecretKey (str)
      - EnableSessionTokens (bool)
      - RoleARN (str)
      - SessionDuration (int)
      - RoleSessionName (str)
      - StreamName (str)
      - FirehoseStream (bool)
      - AwsRegion (str)
      - AwsSetId (long) (must be included)
      - HistoryEnabled (bool)
      - HistoryStoreType (str) "In_Memory" or "Disk_Backed" (added 4.0.17)
      - MessageCapacity (int)(deprecated 4.0.19)
      - HistoryMaxSize (int)(added 4.0.22)
      - HistoryMaxAge (int)(added 4.0.19)
      - FlushPeriod (long)
      - PartitionKeyCount (int)
      - PartitionKeyPattern (str)
      - MaxSize (int)
      - H2dbDirectory (str)(added 4.0.25)
      - H2dbPort (int)(added 4.0.22)
    - Dynamo
      - Id (long)(cannot be null)
      - Name (str)
      - Enabled (bool)
      - AwsAccessKey (str)
      - AwsSecretKey (str)
      - TableName (str)
      - AwsRegion (str)
      - AwsSetId (long) (must be included)
      - HistoryEnabled (bool)
      - HistoryStoreType (str) "In_Memory" or "Disk_Backed" (added 4.0.17)
      - MessageCapacity (int)(deprecated 4.0.19)
      - HistoryMaxSize (int)(added 4.0.22)
      - HistoryMaxAge (int)(added 4.0.19)
      - FlushPeriod (long)
      - H2dbDirectory (str)(added 4.0.25)
      - H2dbPort (int)(added 4.0.22)
    - Agents
      - Id (long)(cannot be null)
      - Name (str) (added 4.0.17)
      - Enabled (bool) (added 4.0.17)
      - TagProvider (str)
      - TagPath (str)
      - PushTrigger (str) "EVENT_DRIVEN", "PERIODIC" or "HYBRID"
      - TagPacingPeriod (long)
      - ConvertUdts (bool)
      - PublishUdtDefinitions (bool)
      - OptimizeUdts (bool)
      - AwsSetId (long)(must be included)
      - GroupId (str)
      - EdgeNodeId (str)
      - DeviceId (str)
      - FilteredProperties (str)
      - SendAllProps (bool)(added 4.0.25)
      - IncludeInfoFolders (bool)(added 4.0.30)
    - Sets
      - Id (long)(cannot be null)
      - Name (str)
      - Description (str)
      - PushPolicy (str) "PUSH_TO_ALL" or "PUSH_TO_ANY"
Return Value
- A map representing the newly created configuration after it has been written to the database. (added 4.0.16)

...

Parameters
- String type
  - The type of configuration to read with valid options:
    - General
    - Kinesis
    - Dynamo
    - Agents
    - Sets
Return Value
- A List of Dictionaries of properties making up the configurations with the following keys and datatypes:
  - General
    - Id (long)
    - Enabled (bool)
  - Kinesis
    - Id (long)
    - Name (str)
    - Enabled (bool)
    - EnableAwsKeys (bool)(added 4.0.22)
    - AwsAccessKey (str)
    - AwsSecretKey (str)
    - EnableSessionTokens (bool)
    - RoleARN (str)
    - SessionDuration (int)
    - RoleSessionName (str)
    - StreamName (str)
    - FirehoseStream (bool)
    - AwsRegion (str)
    - AwsSetId (long)
    - HistoryEnabled (bool)
    - HistoryStoreType (str) "In_Memory" or "Disk_Backed" (added 4.0.17)
    - MessageCapacity (int)(deprecated 4.0.19)
    - HistoryMaxSize (int)(added 4.0.22)
    - HistoryMaxAge (int)(added 4.0.19)
    - FlushPeriod (long)
    - PartitionKeyCount (int)
    - PartitionKeyPattern (str)
    - MaxSize (int)
    - H2dbDirectory (str)(added 4.0.25)
    - H2dbPort (int)(added 4.0.22)
  - Dynamo
    - Id (long)
    - Name (str)
    - Enabled (bool)
    - AwsAccessKey (str)
    - AwsSecretKey (str)
    - TableName (str)
    - AwsRegion (str)
    - AwsSetId (long)
    - HistoryEnabled (bool)
    - HistoryStoreType (str) "In_Memory" or "Disk_Backed" (added 4.0.17)
    - MessageCapacity (int)(deprecated 4.0.19)
    - HistoryMaxSize (int)(added 4.0.22)
    - HistoryMaxAge (int)(added 4.0.19)
    - FlushPeriod (long)
    - H2dbDirectory (str)(added 4.0.25)
    - H2dbPort (int)(added 4.0.22)
  - Agents
    - Id (long)
    - Name (str) (added 4.0.17)
    - Enabled (bool) (added 4.0.17)
    - TagProvider (str)
    - TagPath (str)
    - PushTrigger (str) "EVENT_DRIVEN", "PERIODIC" or "HYBRID"
    - TagPacingPeriod (long)
    - ConvertUdts (bool)
    - PublishUdtDefinitions (bool)
    - OptimizeUdts (bool)
    - AwsSetId (long)
    - GroupId (str)
    - EdgeNodeId (str)
    - DeviceId (str)
    - FilteredProperties (str)
    - SendAllProps (bool)(added 4.0.25)
    - IncludeInfoFolders (bool)(added 4.0.30)
  - Sets
    - Id (long)
    - Name (str)
    - Description (str)
    - PushPolicy (str) "PUSH_TO_ALL" or "PUSH_TO_ANY"

...

scopes using the format system.cirruslink.aws.operation

createConfig(type, name, config, enabled, description)
- enabled (boolean) and description (string) are optional calls
- returns a dictionary that represents the config.json of the specified resource
deleteConfig(type, name)
- returns a boolean
getConfigNames(type, enabled)
- enabled is an optional call
- returns a list strings
isConfigEnabled(type, name)
- returns a boolean
readConfig(type, name)
- returns a dictionary that represents the config.json of the specified resource
setConfigEnabled(type, name, enabled)
- returns a boolean
updateConfig(type, name, collisionPolicy, config)
- returns a dictionary that represents the config.json of the specified resource

where:

type
- string denoting the type of configuration to operate on
name
- string denoting the unique name for the configuration resource to operate on
config
- dictionary of properties making up the configuration resource to operate on
  - general
  - dynamo-db
  - kinesis
  - server-set
  - agent
enabled
- boolean
collisionPolicy
- string with options "MergeOverwrite" or "Overwrite"
  - "MergeOverwrite" will replace the existing properties in the resource name with only those included in the call
  - "Overwrite" will replace all properties in the resource name with those in the call

Warning

Configuration changes made through scripting do have the same validation as when made through the UI.

For example, attempting to delete a Sets configuring that is being referenced by a Servers configuration will result in no action being performed.

AWS Injector 'type' keys

general
dynamo-db
kinesis
server-set
agent

AWS Injector 'general' keys

enabled

boolean

Whether or not the configuration resource is enabled

AWS Injector 'dynamo-db' keys

enabled	boolean	Whether or not the configuration resource is enabled
name	string	The unique name for the configuration resource
awsAccessKey	string	AWS Access Key
awsSecretKey	string	AWS Secret Key
awsRegion	string	AWS Region
serverSet	string	The Set this DynamoDB setting is associated with
tableName	string	DynamoDB Table Name
historyEnabled	boolean	Enable Store and Forward capabilities for this stream
historyStoreType	string	The Type of this Store & Forward mechanism
partionPeriod	string	The partitioning scheme to use for the Disk-backed history store (e.g. HOUR, MINUTE, DAY, etc)
historyMaxSize	integer	Maximum number of megabytes history can use before dropping the data
trimmerTaskPeriodMultiplier	integer	A integer multiplier which is applied to the 'storageMonitorPeriod' which results in the period in which to trim potential excess history
historyMaxAge	integer	Maximum number of minutes to store history before dropping the data
queryTimeout	integer	The H2 DB query timeout in seconds for the disk-backed history store
flushPeriod	long	Upon reestablishing communication, the period to wait in milliseconds between sending when flushing messages
h2dbDirectory	string	Directory to store the H2 Database in. Applicable for Disk-backed history store only
h2dbPort	integer	TCP Port to connect to H2 Database. Applicable for Disk-backed history store only
dbMaxMessageSize	integer	The Max Message size allowed in the Store and Forward DB. This only applies to Disk-Backed history stores
republishBirths	boolean	Whether or not to republish BIRTH messages on reestablishing connection to the endpoint

AWS Injector 'kinesis' keys

enabled	boolean	Whether or not the configuration resource is enabled
name	string	The unique name for the configuration resource
useAwsKeys	boolean	Whether to use AWS access and secret keys or use an AWS EC2 instance with an AWS IAM role
awsAccessKey	string	AWS Access Key
awsSecretKey	string	AWS Secret Key
enableSessionTokens	boolean	AWS Session Tokens
roleARN	string	AWS Role ARN
sessionDuration	integer	AWS Session Duration in seconds
roleSessionName	string	AWS Session Name
awsRegion	string	AWS Region
serverSet	string	The Set this Kinesis Stream setting is associated with
streamName	string	Kinesis Stream Name
firehoseStream	boolean	Enables pushing directly into a Kinesis Data Firehose delivery stream
historyEnabled	boolean	Enable Store and Forward capabilities for this stream
historyStoreType	string	The Type of this Store & Forward mechanism
partionPeriod	string	The partitioning scheme to use for the Disk-backed history store (e.g. HOUR, MINUTE, DAY, etc)
historyMaxSize	integer	Maximum number of megabytes history can use before dropping the data
trimmerTaskPeriodMultiplier	integer	A integer multiplier which is applied to the 'storageMonitorPeriod' which results in the period in which to trim potential excess history
historyMaxAge	integer	Maximum number of minutes to store history before dropping the data
queryTimeout	integer	The H2 DB query timeout in seconds for the disk-backed history store
flushPeriod	long	Upon reestablishing communication, the period to wait in milliseconds between sending when flushing messages
partionKeyCount	integer	The number of unique indexed partition keys
partionKeyPattern	string	An optional key pattern that supports token substitution for the following message fields: ${group}, ${edgenode}, and ${device}. This setting overrides the partition key count
maxSize	integer	Maximum message size before dividing into multiple messages
h2dbDirectory	string	Directory to store the H2 Database in. Applicable for Disk-backed history store only
h2dbPort	integer	TCP Port to connect to H2 Database. Applicable for Disk-backed history store only
dbMaxMessageSize	integer	The Max Message size allowed in the Store and Forward DB. This only applies to Disk-Backed history stores
republishBirths	boolean	Whether or not to republish BIRTH messages on reestablishing connection to the endpoint

AWS Injector 'server-set' keys

enabled	boolean	Whether or not the configuration resource is enabled
name	string	The unique name for the configuration resource
description	string	Description of this Set
pushPolicy	string	The Push Policy defines whether all cloud end-points in a set will be pushed to or only one will at a time - PUSH_TO_ALL or PUSH_TO_ANY

AWS Injector 'agent' keys

enabled	boolean	Whether or not the configuration resource is enabled
name	string	The unique name for the configuration resource
tagProvider	string	The Name of the tag provider
tagPath	string	A path to the root folder where the tag tree starts (optional)
pushTrigger	string	The trigger to use when pushing data - EVENT_DRIVEN, PERIODIC or HYBRID
tagPacingPeriod	long	If using an EVENT_DRIVEN Push trigger, the waiting period in milliseconds after an initial tag change event before pushing all changed tags. If using PERIODIC, the number of milliseconds to wait between pushing all data
convertUdts	boolean	Converts UDT members to normal Tags
sendAllProps	boolean	Send all properties, including non-default properties, in Sparkplug BIRTH messages
includeQualityContext	boolean	Include the metric 'quality context' string in addition to the quality codes for metrics
includeInfoFolders	boolean	Push all Node and Device Info and Control folder information (from MQTT Engine) rather than excluding it
publishUdtDefinitions	boolean	Publish UDT Definitions in BIRTH
optimizeUdts	boolean	Optimizes UDT payload sizes in NDATA and DDATA payloads
serverSet	string	The Set this Agent is associated with
groupId	string	An ID representing a logical grouping of Edge Nodes and Devices (optional)
edgeNodeId	string	An ID representing an Edge or Network (EoN) Node (optional)
deviceId	string	An ID representing a Device (optional)
filteredProperties	string	A semicolon delimited list of Tag properties to filter/block from being published
birthSettleDelay	long	The amount of time to wait after setting the BIRTH timestamp before fetching the cached BIRTH payloads

Parameters
- String type
  - The type of configuration to update with valid options:
    - General
    - Kinesis
    - Dynamo
    - Agents
    - Sets
- Long id
  - The ID of the record to update
- String collisionPolicy
  - "MergeOverwrite" or "Overwrite"
    - "MergeOverwrite" will replace the existing properties in the record ID with only those included in the call
    - "Overwrite" will replace all properties in the record ID with those in the call
- Map props
  - Dictionary of properties making up the configuration with the following keys and datatypes:
    - General
      - Id (long)
      - Enabled (bool)
    - Kinesis
      - Id (long)
      - Name (str)
      - Enabled (bool)
      - UseAwsKeys (bool)(added 4.0.22)
      - AwsAccessKey (str)
      - AwsSecretKey (str)
      - EnableSessionTokens (bool)
      - RoleARN (str)
      - SessionDuration (int)
      - RoleSessionName (str)
      - StreamName (str)
      - FirehoseStream (bool)
      - AwsRegion (str)
      - AwsSetId (long)
      - HistoryEnabled (bool)
      - HistoryStoreType (str) "In_Memory" or "Disk_Backed" (added 4.0.17)
      - MessageCapacity (int)(deprecated 4.0.19)
      - HistoryMaxSize (int)(added 4.0.22)
      - HistoryMaxAge (int)(added 4.0.19)
      - FlushPeriod (long)
      - PartitionKeyCount (int)
      - PartitionKeyPattern (str)
      - MaxSize (int)
      - H2dbDirectory (str)(added 4.0.25)
      - H2dbPort (int)(added 4.0.22)
    - Dynamo
      - Id (long)
      - Name (str)
      - Enabled (bool)
      - AwsAccessKey (str)
      - AwsSecretKey (str)
      - TableName (str)
      - AwsRegion (str)
      - AwsSetId (long)
      - HistoryEnabled (bool)
      - HistoryStoreType (str) "In_Memory" or "Disk_Backed" (added 4.0.17)
      - MessageCapacity (int)(deprecated 4.0.19)
      - HistoryMaxSize (int)(added 4.0.22)
      - HistoryMaxAge (int)(added 4.0.19)
      - FlushPeriod (long)
      - H2dbDirectory (str)(added 4.0.25)
      - H2dbPort (int)(added 4.0.22)
    - Agents
      - Id (long)
      - Name (str) (added 4.0.17)
      - Enabled (bool) (added 4.0.17)
      - TagProvider (str)
      - TagPath (str)
      - PushTrigger (str) "EVENT_DRIVEN", "PERIODIC" or "HYBRID"
      - TagPacingPeriod (long)
      - ConvertUdts (bool)
      - PublishUdtDefinitions (bool)
      - OptimizeUdts (bool)
      - AwsSetId (long)
      - GroupId (str)
      - EdgeNodeId (str)
      - DeviceId (str)
      - FilteredProperties (str)
      - SendAllProps (bool)(added 4.0.25)
      - IncludeInfoFolders (bool)(added 4.0.30)
    - Sets
      - Id (long)
      - Name (str)
      - Description (str)
      - PushPolicy (str) "PUSH_TO_ALL" or "PUSH_TO_ANY"
Return Value
- A map representing the updated configuration after it has been written to the database. (added 4.0.16)

...

String type
- The type of configuration to delete with valid options:
  - Kinesis
  - Dynamo
  - Agents
  - Sets
Long id
- The ID of the record to delete

...

Contents

Cirrus Link Resources

Inductive Resources

Versions Compared

Old Version 1

New Version Current

Key