scheduled-event
Summary
Scheduled events in EventBridge triggered by CloudWatch Events rules.
Context
Scheduled events are used to trigger recurring tasks in the Supervision Finance service. Due to limitations in CloudWatch
Events, the various scheduled events are all defined under one detail type scheduled-event, with the specific task to be performed
specified in the event detail under the trigger parameter.
Scheduled events can be modified further by using the optional override parameter in the event detail.
Trigger
Scheduled CloudWatch Events rule.
Effect
The Finance service processes the scheduled event.
Examples
{
"trigger": "direct-debit-collection",
"override": {
"date": "2024-06-01"
}
}Schema
{
"$id": "https://opg.service.justice.gov.uk/opg.supervision.sirius/scheduled-event.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "opg.supervision.sirius/scheduled-event",
"type": "object",
"properties": {
"trigger": {
"type": "string",
"description": "The scheduled event being triggered"
},
"override": {
"type": "object",
"description": "Any parameters to override the default scheduled event behaviour"
}
},
"required": [
"trigger"
]
}