schedule

The schedule trigger runs a pipeline on the given schedule.

trigger "schedule" "my_hourly_trigger" {
schedule = "hourly"
pipeline = pipeline.twitter_mentions_to_slack
args = {
query = "(steampipe OR powerpipe OR flowpipe)"
}
}

Arguments

ArgumentTypeOptional?Description
pipelinePipeline ReferenceRequiredA reference to a pipeline resource to start when this trigger runs.
scheduleStringRequiredSchedule to run the query. This may be a named interval (hourly, daily, weekly, 5m, 10m, 15m, 30m, 60m, 1h, 2h, 4h, 6h, 12h, 24h) or a custom schedule in cron syntax.
argsMapOptionalA map of arguments to pass to the pipeline.
descriptionStringOptionalA string containing a short description of the step.
documentationStringOptionalA markdown string containing a long form description, used as documentation for the mod on hub.flowpipe.io.
enabledBooleanOptionalEnable or disable the trigger. A disabled trigger will not fire, but it will retain its history and configuration. Default is true.
tagsMapOptionalA map of key:value metadata for the mod, used to categorize, search, and filter.
titleStringOptionalDisplay title for the step.

More examples

The schedule argument may be a named interval (hourly, daily, weekly, 5m, 10m, 15m, 30m, 60m, 1h, 2h, 4h, 6h, 12h, 24h). When using a named interval, Flowpipe will automatically jitter the time within the interval, which helps avoid resource contention.

trigger "schedule" "my_hourly_trigger" {
schedule = "hourly"
pipeline = pipeline.my_pipe
}

The schedule argument may be a custom schedule in cron syntax. No jitter is added to cron schedules; they will run at the time specified.

trigger "schedule" "my_hourly_trigger" {
schedule = "*/30 * * * *"
pipeline = pipeline.my_pipe
}