AWSEvents plug-in structure

Configuring a AWSEvents SQS event source
An event source that receives SQSEvent type events can be configured in the following way:
AccessKeyID
The Access Key ID is a specific security credential provided by Amazon Web Services.
Secret
You need to specify a secret cryptographic key.
roleArn
  • Type: string
  • Multiple filters
  • Required*
  • Single predicate
You can specify the role assumed to receive a message and delete it from a queue.
roleSessionName
  • Type: string
  • Multiple filters
  • Required*
  • Single predicate
You can specify the role session name assumed to receive a message and delete it from a queue.
Note: You do not need to specify the accessKeyID, secret, roleArn and roleSessionName values if the event manager container or pod is configured with an AWS command line interface, or if HCL Universal Orchestrator is running on an Amazon EKS cluster.
Region
  • Type: string
  • Multiple filters
  • Single predicate
  • Default: if the region is not specified, the default value is taken from what is configured in the local environment. If no region is configured in the local environment, the default region is us-east-1
Specify the region where the resources you are interacting with are located to optimize performances.
QueueURL
  • Type: string
  • Multiple filters
  • Required
  • Single predicate
Specify the URL of an existing AWS SQS queue.
maxMessages
  • Type: nonnegativeinteger
  • Single predicate
  • Default: if no value is specified, the maximum amount of messages that can be received is 10
Specify the maximun amount of messages that can be received from an AWS SQS queue.
pollInterval
  • Type: nonnegativeinteger
  • Multiple filters
  • Single predicate
  • Default: if no value is specified, the interval between message polling instances is 1 second
You can define the interval between message polling instances.
The following is an example of a generic type event source configured to receive AWSEvents type events:
$eventsource

EVENT_SOURCE /AWSEvents1
DESCRIPTION "AWSEvents testing"
PLUGIN AWSEvents
TYPE SQS
CONFIGURATION {

      "accessKeyID": "accessKeyIDvalue",
      "secret": "secretvalue",
      "queueURL": "queueURLvalue",
      "maxMessages": "1000",
      "pollinMS": "30"

         }
END
AWSEvents event condition
SQSEvent type event conditions can be configured in job streams specifying the following required properties:
  • Name
  • Type
  • Event source
You can also specify any number of porperties that filter the events received from the event source:
Message
  • Type: string
  • Operator: EQ("=") or NE("!=")
  • Wildcard allowed
  • Single predicate
Specify the SQS message body to enable filtering of events that either match or do not match the specified input.
Attributes
  • Type: string
  • Operator: EQ("=") or NE("!=")
  • Wildcard allowed
  • Single predicate
Specify the attributes contained in the SQS message to enable filtering of events that either match or do not match the specified input.
Message attributes
  • Type: string
  • Operator: EQ("=") or NE("!=")
  • Wildcard allowed
  • Single predicate
Specify the SQS message metadata attributes to enable filtering of events that either match or do not match the specified input.
Message ID
  • Type: string
  • Operator: EQ("=") or NE("!=")
  • Wildcard allowed
  • Single predicate
Specify the SQS message ID to enable filtering of events that either match or do not match the specified input.
The following is an example of a job stream with two AWSEvents event conditions:
TRIGGER MY_TRIGGER DESCRIPTION "my event trigger" TIMEOUT 1000 TRIGGER_ON_TIMEOUT CORRELATIONS A, A1,
    CONDITIONS IN ORDER
    NAME messagebody  TYPE plugin/AWSEVENTS    SOURCE MY_EVENT_SOURCE FILTERS MESSAGE = test message
    NAME ID           TYPE plugin/AWSEVENTS    SOURCE MY_EVENT_SOURCE FILTERS MESSAGEID = 123456789012