Skip to end of metadata
Go to start of metadata

APIs

  • 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) 

            • 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) 

            • FlushPeriod (long) 

            • PartitionKeyCount (int) 

            • PartitionKeyPattern (str) 

            • MaxSize (int) 

          • 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) 

            • FlushPeriod (long) 

          • Agents
            • Id (long) 

            • 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
  • 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) 

          • 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) 

          • FlushPeriod (long) 

          • PartitionKeyCount (int) 

          • PartitionKeyPattern (str) 

          • MaxSize (int) 

        • 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) 

          • FlushPeriod (long) 

        • Agents
          • Id (long) 

          • 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"

  • 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"
      • 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) 

            • 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) 

            • FlushPeriod (long) 

            • PartitionKeyCount (int) 

            • PartitionKeyPattern (str) 

            • MaxSize (int) 

          • 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) 

            • FlushPeriod (long) 

          • Agents
            • Id (long) 

            • 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
  • 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


  • No labels