Skip to main content
def AutomationClient.create_cron_automation(
    name: str,
    task: CronTask,
    cron_schedules: str | list[str],
    cluster: ClusterSlugLike | None = None,
    max_retries: int = 0,
) -> AutomationPrototype
Create an automation that submits a task on one or more cron schedules.

​
Parameters

​
name
str
required
Name of the automation to create.
​
task
CronTask
required
Task to run when the automation is triggered.
​
cron_schedules
str | list[str]
required
Cron schedule or schedules that trigger the automation.
​
cluster
ClusterSlugLike | None
Cluster to run the task on. If not provided, the default cluster is used.
​
max_retries
int
Maximum number of retries for the task. Defaults to 0.

​
Returns

The created automation prototype. 
automation = client.automations().create_cron_automation(
    name="daily-index-refresh",
    task=RefreshIndex(),
    cron_schedules="0 2 * * *",
    cluster="default",
)