Managing an event source definition from the Orchestration CLI
In this topic you can find the syntax to manage an event source definition.
Event sources begin with the eventsource keyword, and after it you must add the plug in you want to receive events from and the type of the event source your want to define.
Each event source has the following format and arguments:
Syntax
$eventsource
event_sourceeventsourcename
"[description]"
$eventsource
event_source [folder/]eventsource_name
[“descriptionˮ]
plugin plugin_name
type eventsource_type
CONFIGURATION
{
}
}
END
Arguments
- event_sourceeventsourcename
- Using this command, you can define the name of the event source.
The name must start with a letter, and can contain alphanumeric characters, dashes, and underscores.
- “descriptionˮ
- Using this command, you can specify a description for the event source.
The content must be enclosed within double quotation marks. To use quotation marks ("), place a backslash (\) before.
- plugin plugin_name [...]
- Using this command, you can define the name of the event plug-in you want to receive events from.
- type eventsource_type
- Using this command, you can define the type of the event source. You can choose between the available event source types described in the structure of each event plug-in.
WEBHOOKEXAMPLE
and an AWSEvents SQS event source named
AWSEventsEXAMPLE
:$eventsource
EVENT_SOURCE /WEBHOOKEXAMPLE
DESCRIPTION "Webhook event source testing"
PLUGIN Webhook
TYPE GenericHMAC
CONFIGURATION {
"secret": "123abc123abc",
"algorithm": "SHA-256",
"headerName": "digestheaderName",
"ipNetMask": ["123.123.1.2/31"]
}
END
$eventsource
EVENT_SOURCE /AWSEventsEXAMPLE
DESCRIPTION "AWSEvents event source testing"
PLUGIN AWSEvents
TYPE SQS
CONFIGURATION {
"accessKeyID": "accessKeyIDvalue",
"secret": "secretvalue",
"queueURL": "queueURLvalue",
"maxMessages": "1000",
"pollinMS": "30"
}
END