Contents
Cirrus Link Resources
Cirrus Link Website
Contact Us (Sales/Support)
Forum
Cirrus Link Modules Docs for Ignition 7.9.x
Inductive Resources
Ignition User Manual
Knowledge Base Articles
Inductive University
Forum
The following API calls are available for the AWS Injector Module and can be executed within any of the available Ignition scopes.
APIs
Anchor createConfig createConfig
system.cirruslink.aws.createConfig(type, props) → void
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)
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)
H2dbPort (int)(added 4.0.22)
Dynamo
Id (long)
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)
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" or "PERIODIC"
TagPacingPeriod (long)
ConvertUdts (bool)
PublishUdtDefinitions (bool)
OptimizeUdts (bool)
AwsSetId (long)
AutoDiscover (bool)
(must be included)
GroupId (str)
EdgeNodeId (str)
DeviceId (str)
FilteredProperties (str)
Sets
Id (long)
Name (str)
Description (str)
PushPolicy (str) "PUSH_TO_ALL" or "PUSH_TO_ANY"
Return Value
None
A map representing the newly created configuration after it has been written to the database. (added 4.0.16)
Anchor readConfig readConfig
system.cirruslink.aws.readConfig(type) → List
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"
MessageCapacity (int)
" 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)
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"
MessageCapacity (int)
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)
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" or "PERIODIC"
TagPacingPeriod (long)
ConvertUdts (bool)
PublishUdtDefinitions (bool)
OptimizeUdts (bool)
AwsSetId (long)
AutoDiscover (bool)
GroupId (str)
EdgeNodeId (str)
DeviceId (str)
FilteredProperties (str)
Sets
Id (long)
Name (str)
Description (str)
PushPolicy (str) "PUSH_TO_ALL" or "PUSH_TO_ANY"
Anchor updateConfig updateConfig
system.cirruslink.aws.updateConfig(type, id, collisionPolicy, props) → void
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
Either "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)
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)MessageCapacity (int)
FlushPeriod (long)
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" or "PERIODIC"
TagPacingPeriod (long)
ConvertUdts (bool)
PublishUdtDefinitions (bool)
OptimizeUdts (bool)
AwsSetId (long)
AutoDiscover (bool)
GroupId (str)
EdgeNodeId (str)
DeviceId (str)
FilteredProperties (str)
Sets
Id (long)
Name (str)
Description (str)
PushPolicy (str) "PUSH_TO_ALL" or "PUSH_TO_ANY"
Return Value
None
A map representing the updated configuration after it has been written to the database. (added 4.0.16)
Anchor deleteConfig deleteConfig
system.cirruslink.aws.deleteConfig(type, id) → void
Parameters
String type
The type of configuration to delete with valid options:
Kinesis
Dynamo
Agents
Sets
Long id
The ID of the record to delete
Return Value
None
True if the record was successfully deleted otherwise False is returned (added 4.0.16)