max-voitcov
73386ba0ff
Six new resources from terraform-provider-dokploy v0.2.0 -- Network, DnsProvider, VaultProvider, Schedule, VolumeBackup and Libsql -- plus the new properties on Domain (`enabled`), Compose (`serviceNetworks`, `createEnvFile`, `icon`) and Application. Verified with `pulumi up` against a live v0.30.2 instance: create, preview-clean, and destroy. The upstream provider also now refuses a volume Mount with no `volumeName`, which Dokploy would otherwise turn into an anonymous Docker volume recreated on every deploy. That surfaces here at preview time, before anything exists. Two things made that fix nearly invisible to Pulumi users, so this commit fixes the second one: the bridge resolves the upstream `docs/` through the Go module cache, where a locally `replace`d dependency never lands, so tfgen was emitting every resource with no description at all. UpstreamRepoPath now points at the checkout and all 445 inputs carry documentation -- with names rendered per language, so Python readers see `volume_name` where TypeScript readers see `volumeName`.
815 lines
35 KiB
Python
Generated
815 lines
35 KiB
Python
Generated
# coding=utf-8
|
|
# *** WARNING: this file was generated by pulumi-language-python. ***
|
|
# *** Do not edit by hand unless you're certain you know what you are doing! ***
|
|
|
|
import builtins as _builtins
|
|
import warnings
|
|
import sys
|
|
import pulumi
|
|
import pulumi.runtime
|
|
from typing import Any, Mapping, Optional, Sequence, Union, overload
|
|
if sys.version_info >= (3, 11):
|
|
from typing import NotRequired, TypedDict, TypeAlias
|
|
else:
|
|
from typing_extensions import NotRequired, TypedDict, TypeAlias
|
|
from . import _utilities
|
|
|
|
__all__ = ['ScheduleArgs', 'Schedule']
|
|
|
|
@pulumi.input_type
|
|
class ScheduleArgs:
|
|
def __init__(__self__, *,
|
|
command: pulumi.Input[_builtins.str],
|
|
cron_expression: pulumi.Input[_builtins.str],
|
|
app_name: pulumi.Input[Optional[_builtins.str]] = None,
|
|
application_id: pulumi.Input[Optional[_builtins.str]] = None,
|
|
compose_id: pulumi.Input[Optional[_builtins.str]] = None,
|
|
description: pulumi.Input[Optional[_builtins.str]] = None,
|
|
enabled: pulumi.Input[Optional[_builtins.bool]] = None,
|
|
name: pulumi.Input[Optional[_builtins.str]] = None,
|
|
schedule_type: pulumi.Input[Optional[_builtins.str]] = None,
|
|
script: pulumi.Input[Optional[_builtins.str]] = None,
|
|
server_id: pulumi.Input[Optional[_builtins.str]] = None,
|
|
service_name: pulumi.Input[Optional[_builtins.str]] = None,
|
|
shell_type: pulumi.Input[Optional[_builtins.str]] = None,
|
|
timezone: pulumi.Input[Optional[_builtins.str]] = None):
|
|
"""
|
|
The set of arguments for constructing a Schedule resource.
|
|
|
|
:param pulumi.Input[_builtins.str] command: Command to run.
|
|
:param pulumi.Input[_builtins.str] cron_expression: Standard five-field cron expression, for example `0 3 * * *`.
|
|
:param pulumi.Input[_builtins.str] app_name: Docker service name the schedule targets. Derived by Dokploy when omitted.
|
|
:param pulumi.Input[_builtins.str] application_id: Application this schedule belongs to.
|
|
:param pulumi.Input[_builtins.str] compose_id: Compose stack this schedule belongs to.
|
|
:param pulumi.Input[_builtins.str] description: Free-form description.
|
|
:param pulumi.Input[_builtins.bool] enabled: Whether the schedule is active.
|
|
:param pulumi.Input[_builtins.str] name: Display name of the schedule.
|
|
:param pulumi.Input[_builtins.str] schedule_type: Where the command runs. Valid values: `application`, `compose`, `server`, `dokploy-server`. Defaults to `application`.
|
|
:param pulumi.Input[_builtins.str] script: Multi-line script to run instead of a single command.
|
|
:param pulumi.Input[_builtins.str] server_id: Server this schedule runs on.
|
|
:param pulumi.Input[_builtins.str] service_name: Service inside a Compose stack to run the command in.
|
|
:param pulumi.Input[_builtins.str] shell_type: Shell used to interpret the command. Valid values: `bash`, `sh`. Defaults to `bash`.
|
|
:param pulumi.Input[_builtins.str] timezone: IANA timezone the cron expression is evaluated in, for example `Europe/Berlin`.
|
|
"""
|
|
pulumi.set(__self__, "command", command)
|
|
pulumi.set(__self__, "cron_expression", cron_expression)
|
|
if app_name is not None:
|
|
pulumi.set(__self__, "app_name", app_name)
|
|
if application_id is not None:
|
|
pulumi.set(__self__, "application_id", application_id)
|
|
if compose_id is not None:
|
|
pulumi.set(__self__, "compose_id", compose_id)
|
|
if description is not None:
|
|
pulumi.set(__self__, "description", description)
|
|
if enabled is not None:
|
|
pulumi.set(__self__, "enabled", enabled)
|
|
if name is not None:
|
|
pulumi.set(__self__, "name", name)
|
|
if schedule_type is not None:
|
|
pulumi.set(__self__, "schedule_type", schedule_type)
|
|
if script is not None:
|
|
pulumi.set(__self__, "script", script)
|
|
if server_id is not None:
|
|
pulumi.set(__self__, "server_id", server_id)
|
|
if service_name is not None:
|
|
pulumi.set(__self__, "service_name", service_name)
|
|
if shell_type is not None:
|
|
pulumi.set(__self__, "shell_type", shell_type)
|
|
if timezone is not None:
|
|
pulumi.set(__self__, "timezone", timezone)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def command(self) -> pulumi.Input[_builtins.str]:
|
|
"""
|
|
Command to run.
|
|
"""
|
|
return pulumi.get(self, "command")
|
|
|
|
@command.setter
|
|
def command(self, value: pulumi.Input[_builtins.str]):
|
|
pulumi.set(self, "command", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="cronExpression")
|
|
def cron_expression(self) -> pulumi.Input[_builtins.str]:
|
|
"""
|
|
Standard five-field cron expression, for example `0 3 * * *`.
|
|
"""
|
|
return pulumi.get(self, "cron_expression")
|
|
|
|
@cron_expression.setter
|
|
def cron_expression(self, value: pulumi.Input[_builtins.str]):
|
|
pulumi.set(self, "cron_expression", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="appName")
|
|
def app_name(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Docker service name the schedule targets. Derived by Dokploy when omitted.
|
|
"""
|
|
return pulumi.get(self, "app_name")
|
|
|
|
@app_name.setter
|
|
def app_name(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "app_name", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="applicationId")
|
|
def application_id(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Application this schedule belongs to.
|
|
"""
|
|
return pulumi.get(self, "application_id")
|
|
|
|
@application_id.setter
|
|
def application_id(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "application_id", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="composeId")
|
|
def compose_id(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Compose stack this schedule belongs to.
|
|
"""
|
|
return pulumi.get(self, "compose_id")
|
|
|
|
@compose_id.setter
|
|
def compose_id(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "compose_id", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def description(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Free-form description.
|
|
"""
|
|
return pulumi.get(self, "description")
|
|
|
|
@description.setter
|
|
def description(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "description", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def enabled(self) -> pulumi.Input[Optional[_builtins.bool]]:
|
|
"""
|
|
Whether the schedule is active.
|
|
"""
|
|
return pulumi.get(self, "enabled")
|
|
|
|
@enabled.setter
|
|
def enabled(self, value: pulumi.Input[Optional[_builtins.bool]]):
|
|
pulumi.set(self, "enabled", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def name(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Display name of the schedule.
|
|
"""
|
|
return pulumi.get(self, "name")
|
|
|
|
@name.setter
|
|
def name(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "name", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="scheduleType")
|
|
def schedule_type(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Where the command runs. Valid values: `application`, `compose`, `server`, `dokploy-server`. Defaults to `application`.
|
|
"""
|
|
return pulumi.get(self, "schedule_type")
|
|
|
|
@schedule_type.setter
|
|
def schedule_type(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "schedule_type", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def script(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Multi-line script to run instead of a single command.
|
|
"""
|
|
return pulumi.get(self, "script")
|
|
|
|
@script.setter
|
|
def script(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "script", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="serverId")
|
|
def server_id(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Server this schedule runs on.
|
|
"""
|
|
return pulumi.get(self, "server_id")
|
|
|
|
@server_id.setter
|
|
def server_id(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "server_id", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="serviceName")
|
|
def service_name(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Service inside a Compose stack to run the command in.
|
|
"""
|
|
return pulumi.get(self, "service_name")
|
|
|
|
@service_name.setter
|
|
def service_name(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "service_name", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="shellType")
|
|
def shell_type(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Shell used to interpret the command. Valid values: `bash`, `sh`. Defaults to `bash`.
|
|
"""
|
|
return pulumi.get(self, "shell_type")
|
|
|
|
@shell_type.setter
|
|
def shell_type(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "shell_type", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def timezone(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
IANA timezone the cron expression is evaluated in, for example `Europe/Berlin`.
|
|
"""
|
|
return pulumi.get(self, "timezone")
|
|
|
|
@timezone.setter
|
|
def timezone(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "timezone", value)
|
|
|
|
|
|
@pulumi.input_type
|
|
class _ScheduleState:
|
|
def __init__(__self__, *,
|
|
app_name: pulumi.Input[Optional[_builtins.str]] = None,
|
|
application_id: pulumi.Input[Optional[_builtins.str]] = None,
|
|
command: pulumi.Input[Optional[_builtins.str]] = None,
|
|
compose_id: pulumi.Input[Optional[_builtins.str]] = None,
|
|
created_at: pulumi.Input[Optional[_builtins.str]] = None,
|
|
cron_expression: pulumi.Input[Optional[_builtins.str]] = None,
|
|
description: pulumi.Input[Optional[_builtins.str]] = None,
|
|
enabled: pulumi.Input[Optional[_builtins.bool]] = None,
|
|
name: pulumi.Input[Optional[_builtins.str]] = None,
|
|
schedule_type: pulumi.Input[Optional[_builtins.str]] = None,
|
|
script: pulumi.Input[Optional[_builtins.str]] = None,
|
|
server_id: pulumi.Input[Optional[_builtins.str]] = None,
|
|
service_name: pulumi.Input[Optional[_builtins.str]] = None,
|
|
shell_type: pulumi.Input[Optional[_builtins.str]] = None,
|
|
timezone: pulumi.Input[Optional[_builtins.str]] = None):
|
|
"""
|
|
Input properties used for looking up and filtering Schedule resources.
|
|
|
|
:param pulumi.Input[_builtins.str] app_name: Docker service name the schedule targets. Derived by Dokploy when omitted.
|
|
:param pulumi.Input[_builtins.str] application_id: Application this schedule belongs to.
|
|
:param pulumi.Input[_builtins.str] command: Command to run.
|
|
:param pulumi.Input[_builtins.str] compose_id: Compose stack this schedule belongs to.
|
|
:param pulumi.Input[_builtins.str] created_at: RFC 3339 timestamp of when the schedule was created.
|
|
:param pulumi.Input[_builtins.str] cron_expression: Standard five-field cron expression, for example `0 3 * * *`.
|
|
:param pulumi.Input[_builtins.str] description: Free-form description.
|
|
:param pulumi.Input[_builtins.bool] enabled: Whether the schedule is active.
|
|
:param pulumi.Input[_builtins.str] name: Display name of the schedule.
|
|
:param pulumi.Input[_builtins.str] schedule_type: Where the command runs. Valid values: `application`, `compose`, `server`, `dokploy-server`. Defaults to `application`.
|
|
:param pulumi.Input[_builtins.str] script: Multi-line script to run instead of a single command.
|
|
:param pulumi.Input[_builtins.str] server_id: Server this schedule runs on.
|
|
:param pulumi.Input[_builtins.str] service_name: Service inside a Compose stack to run the command in.
|
|
:param pulumi.Input[_builtins.str] shell_type: Shell used to interpret the command. Valid values: `bash`, `sh`. Defaults to `bash`.
|
|
:param pulumi.Input[_builtins.str] timezone: IANA timezone the cron expression is evaluated in, for example `Europe/Berlin`.
|
|
"""
|
|
if app_name is not None:
|
|
pulumi.set(__self__, "app_name", app_name)
|
|
if application_id is not None:
|
|
pulumi.set(__self__, "application_id", application_id)
|
|
if command is not None:
|
|
pulumi.set(__self__, "command", command)
|
|
if compose_id is not None:
|
|
pulumi.set(__self__, "compose_id", compose_id)
|
|
if created_at is not None:
|
|
pulumi.set(__self__, "created_at", created_at)
|
|
if cron_expression is not None:
|
|
pulumi.set(__self__, "cron_expression", cron_expression)
|
|
if description is not None:
|
|
pulumi.set(__self__, "description", description)
|
|
if enabled is not None:
|
|
pulumi.set(__self__, "enabled", enabled)
|
|
if name is not None:
|
|
pulumi.set(__self__, "name", name)
|
|
if schedule_type is not None:
|
|
pulumi.set(__self__, "schedule_type", schedule_type)
|
|
if script is not None:
|
|
pulumi.set(__self__, "script", script)
|
|
if server_id is not None:
|
|
pulumi.set(__self__, "server_id", server_id)
|
|
if service_name is not None:
|
|
pulumi.set(__self__, "service_name", service_name)
|
|
if shell_type is not None:
|
|
pulumi.set(__self__, "shell_type", shell_type)
|
|
if timezone is not None:
|
|
pulumi.set(__self__, "timezone", timezone)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="appName")
|
|
def app_name(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Docker service name the schedule targets. Derived by Dokploy when omitted.
|
|
"""
|
|
return pulumi.get(self, "app_name")
|
|
|
|
@app_name.setter
|
|
def app_name(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "app_name", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="applicationId")
|
|
def application_id(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Application this schedule belongs to.
|
|
"""
|
|
return pulumi.get(self, "application_id")
|
|
|
|
@application_id.setter
|
|
def application_id(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "application_id", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def command(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Command to run.
|
|
"""
|
|
return pulumi.get(self, "command")
|
|
|
|
@command.setter
|
|
def command(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "command", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="composeId")
|
|
def compose_id(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Compose stack this schedule belongs to.
|
|
"""
|
|
return pulumi.get(self, "compose_id")
|
|
|
|
@compose_id.setter
|
|
def compose_id(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "compose_id", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="createdAt")
|
|
def created_at(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
RFC 3339 timestamp of when the schedule was created.
|
|
"""
|
|
return pulumi.get(self, "created_at")
|
|
|
|
@created_at.setter
|
|
def created_at(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "created_at", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="cronExpression")
|
|
def cron_expression(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Standard five-field cron expression, for example `0 3 * * *`.
|
|
"""
|
|
return pulumi.get(self, "cron_expression")
|
|
|
|
@cron_expression.setter
|
|
def cron_expression(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "cron_expression", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def description(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Free-form description.
|
|
"""
|
|
return pulumi.get(self, "description")
|
|
|
|
@description.setter
|
|
def description(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "description", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def enabled(self) -> pulumi.Input[Optional[_builtins.bool]]:
|
|
"""
|
|
Whether the schedule is active.
|
|
"""
|
|
return pulumi.get(self, "enabled")
|
|
|
|
@enabled.setter
|
|
def enabled(self, value: pulumi.Input[Optional[_builtins.bool]]):
|
|
pulumi.set(self, "enabled", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def name(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Display name of the schedule.
|
|
"""
|
|
return pulumi.get(self, "name")
|
|
|
|
@name.setter
|
|
def name(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "name", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="scheduleType")
|
|
def schedule_type(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Where the command runs. Valid values: `application`, `compose`, `server`, `dokploy-server`. Defaults to `application`.
|
|
"""
|
|
return pulumi.get(self, "schedule_type")
|
|
|
|
@schedule_type.setter
|
|
def schedule_type(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "schedule_type", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def script(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Multi-line script to run instead of a single command.
|
|
"""
|
|
return pulumi.get(self, "script")
|
|
|
|
@script.setter
|
|
def script(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "script", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="serverId")
|
|
def server_id(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Server this schedule runs on.
|
|
"""
|
|
return pulumi.get(self, "server_id")
|
|
|
|
@server_id.setter
|
|
def server_id(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "server_id", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="serviceName")
|
|
def service_name(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Service inside a Compose stack to run the command in.
|
|
"""
|
|
return pulumi.get(self, "service_name")
|
|
|
|
@service_name.setter
|
|
def service_name(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "service_name", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="shellType")
|
|
def shell_type(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
Shell used to interpret the command. Valid values: `bash`, `sh`. Defaults to `bash`.
|
|
"""
|
|
return pulumi.get(self, "shell_type")
|
|
|
|
@shell_type.setter
|
|
def shell_type(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "shell_type", value)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def timezone(self) -> pulumi.Input[Optional[_builtins.str]]:
|
|
"""
|
|
IANA timezone the cron expression is evaluated in, for example `Europe/Berlin`.
|
|
"""
|
|
return pulumi.get(self, "timezone")
|
|
|
|
@timezone.setter
|
|
def timezone(self, value: pulumi.Input[Optional[_builtins.str]]):
|
|
pulumi.set(self, "timezone", value)
|
|
|
|
|
|
@pulumi.type_token("dokploy:index/schedule:Schedule")
|
|
class Schedule(pulumi.CustomResource):
|
|
@overload
|
|
def __init__(__self__,
|
|
resource_name: str,
|
|
opts: Optional[pulumi.ResourceOptions] = None,
|
|
app_name: pulumi.Input[Optional[_builtins.str]] = None,
|
|
application_id: pulumi.Input[Optional[_builtins.str]] = None,
|
|
command: pulumi.Input[Optional[_builtins.str]] = None,
|
|
compose_id: pulumi.Input[Optional[_builtins.str]] = None,
|
|
cron_expression: pulumi.Input[Optional[_builtins.str]] = None,
|
|
description: pulumi.Input[Optional[_builtins.str]] = None,
|
|
enabled: pulumi.Input[Optional[_builtins.bool]] = None,
|
|
name: pulumi.Input[Optional[_builtins.str]] = None,
|
|
schedule_type: pulumi.Input[Optional[_builtins.str]] = None,
|
|
script: pulumi.Input[Optional[_builtins.str]] = None,
|
|
server_id: pulumi.Input[Optional[_builtins.str]] = None,
|
|
service_name: pulumi.Input[Optional[_builtins.str]] = None,
|
|
shell_type: pulumi.Input[Optional[_builtins.str]] = None,
|
|
timezone: pulumi.Input[Optional[_builtins.str]] = None,
|
|
__props__=None):
|
|
"""
|
|
A cron job Dokploy runs on a schedule.
|
|
|
|
`schedule_type` selects where the command runs:
|
|
|
|
* `application` — inside a running application container; set `application_id`.
|
|
* `compose` — inside one service of a Compose stack; set `compose_id` and `service_name`.
|
|
* `server` — on a remote server; set `server_id`.
|
|
* `dokploy-server` — on the Dokploy host itself.
|
|
|
|
> A schedule targeting an application runs inside its container, so the container has to be running when the cron fires.
|
|
|
|
|
|
:param str resource_name: The name of the resource.
|
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
:param pulumi.Input[_builtins.str] app_name: Docker service name the schedule targets. Derived by Dokploy when omitted.
|
|
:param pulumi.Input[_builtins.str] application_id: Application this schedule belongs to.
|
|
:param pulumi.Input[_builtins.str] command: Command to run.
|
|
:param pulumi.Input[_builtins.str] compose_id: Compose stack this schedule belongs to.
|
|
:param pulumi.Input[_builtins.str] cron_expression: Standard five-field cron expression, for example `0 3 * * *`.
|
|
:param pulumi.Input[_builtins.str] description: Free-form description.
|
|
:param pulumi.Input[_builtins.bool] enabled: Whether the schedule is active.
|
|
:param pulumi.Input[_builtins.str] name: Display name of the schedule.
|
|
:param pulumi.Input[_builtins.str] schedule_type: Where the command runs. Valid values: `application`, `compose`, `server`, `dokploy-server`. Defaults to `application`.
|
|
:param pulumi.Input[_builtins.str] script: Multi-line script to run instead of a single command.
|
|
:param pulumi.Input[_builtins.str] server_id: Server this schedule runs on.
|
|
:param pulumi.Input[_builtins.str] service_name: Service inside a Compose stack to run the command in.
|
|
:param pulumi.Input[_builtins.str] shell_type: Shell used to interpret the command. Valid values: `bash`, `sh`. Defaults to `bash`.
|
|
:param pulumi.Input[_builtins.str] timezone: IANA timezone the cron expression is evaluated in, for example `Europe/Berlin`.
|
|
"""
|
|
...
|
|
@overload
|
|
def __init__(__self__,
|
|
resource_name: str,
|
|
args: ScheduleArgs,
|
|
opts: Optional[pulumi.ResourceOptions] = None):
|
|
"""
|
|
A cron job Dokploy runs on a schedule.
|
|
|
|
`schedule_type` selects where the command runs:
|
|
|
|
* `application` — inside a running application container; set `application_id`.
|
|
* `compose` — inside one service of a Compose stack; set `compose_id` and `service_name`.
|
|
* `server` — on a remote server; set `server_id`.
|
|
* `dokploy-server` — on the Dokploy host itself.
|
|
|
|
> A schedule targeting an application runs inside its container, so the container has to be running when the cron fires.
|
|
|
|
|
|
:param str resource_name: The name of the resource.
|
|
:param ScheduleArgs args: The arguments to use to populate this resource's properties.
|
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
"""
|
|
...
|
|
def __init__(__self__, resource_name: str, *args, **kwargs):
|
|
resource_args, opts = _utilities.get_resource_args_opts(ScheduleArgs, pulumi.ResourceOptions, *args, **kwargs)
|
|
if resource_args is not None:
|
|
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
|
|
else:
|
|
__self__._internal_init(resource_name, *args, **kwargs)
|
|
|
|
def _internal_init(__self__,
|
|
resource_name: str,
|
|
opts: Optional[pulumi.ResourceOptions] = None,
|
|
app_name: pulumi.Input[Optional[_builtins.str]] = None,
|
|
application_id: pulumi.Input[Optional[_builtins.str]] = None,
|
|
command: pulumi.Input[Optional[_builtins.str]] = None,
|
|
compose_id: pulumi.Input[Optional[_builtins.str]] = None,
|
|
cron_expression: pulumi.Input[Optional[_builtins.str]] = None,
|
|
description: pulumi.Input[Optional[_builtins.str]] = None,
|
|
enabled: pulumi.Input[Optional[_builtins.bool]] = None,
|
|
name: pulumi.Input[Optional[_builtins.str]] = None,
|
|
schedule_type: pulumi.Input[Optional[_builtins.str]] = None,
|
|
script: pulumi.Input[Optional[_builtins.str]] = None,
|
|
server_id: pulumi.Input[Optional[_builtins.str]] = None,
|
|
service_name: pulumi.Input[Optional[_builtins.str]] = None,
|
|
shell_type: pulumi.Input[Optional[_builtins.str]] = None,
|
|
timezone: pulumi.Input[Optional[_builtins.str]] = None,
|
|
__props__=None):
|
|
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
|
|
if not isinstance(opts, pulumi.ResourceOptions):
|
|
raise TypeError('Expected resource options to be a ResourceOptions instance')
|
|
if opts.id is None:
|
|
if __props__ is not None:
|
|
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
|
|
__props__ = ScheduleArgs.__new__(ScheduleArgs)
|
|
|
|
__props__.__dict__["app_name"] = app_name
|
|
__props__.__dict__["application_id"] = application_id
|
|
if command is None and not opts.urn:
|
|
raise TypeError("Missing required property 'command'")
|
|
__props__.__dict__["command"] = command
|
|
__props__.__dict__["compose_id"] = compose_id
|
|
if cron_expression is None and not opts.urn:
|
|
raise TypeError("Missing required property 'cron_expression'")
|
|
__props__.__dict__["cron_expression"] = cron_expression
|
|
__props__.__dict__["description"] = description
|
|
__props__.__dict__["enabled"] = enabled
|
|
__props__.__dict__["name"] = name
|
|
__props__.__dict__["schedule_type"] = schedule_type
|
|
__props__.__dict__["script"] = script
|
|
__props__.__dict__["server_id"] = server_id
|
|
__props__.__dict__["service_name"] = service_name
|
|
__props__.__dict__["shell_type"] = shell_type
|
|
__props__.__dict__["timezone"] = timezone
|
|
__props__.__dict__["created_at"] = None
|
|
super(Schedule, __self__).__init__(
|
|
'dokploy:index/schedule:Schedule',
|
|
resource_name,
|
|
__props__,
|
|
opts)
|
|
|
|
@staticmethod
|
|
def get(resource_name: str,
|
|
id: pulumi.Input[str],
|
|
opts: Optional[pulumi.ResourceOptions] = None,
|
|
app_name: pulumi.Input[Optional[_builtins.str]] = None,
|
|
application_id: pulumi.Input[Optional[_builtins.str]] = None,
|
|
command: pulumi.Input[Optional[_builtins.str]] = None,
|
|
compose_id: pulumi.Input[Optional[_builtins.str]] = None,
|
|
created_at: pulumi.Input[Optional[_builtins.str]] = None,
|
|
cron_expression: pulumi.Input[Optional[_builtins.str]] = None,
|
|
description: pulumi.Input[Optional[_builtins.str]] = None,
|
|
enabled: pulumi.Input[Optional[_builtins.bool]] = None,
|
|
name: pulumi.Input[Optional[_builtins.str]] = None,
|
|
schedule_type: pulumi.Input[Optional[_builtins.str]] = None,
|
|
script: pulumi.Input[Optional[_builtins.str]] = None,
|
|
server_id: pulumi.Input[Optional[_builtins.str]] = None,
|
|
service_name: pulumi.Input[Optional[_builtins.str]] = None,
|
|
shell_type: pulumi.Input[Optional[_builtins.str]] = None,
|
|
timezone: pulumi.Input[Optional[_builtins.str]] = None) -> 'Schedule':
|
|
"""
|
|
Get an existing Schedule resource's state with the given name, id, and optional extra
|
|
properties used to qualify the lookup.
|
|
|
|
:param str resource_name: The unique name of the resulting resource.
|
|
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
|
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
:param pulumi.Input[_builtins.str] app_name: Docker service name the schedule targets. Derived by Dokploy when omitted.
|
|
:param pulumi.Input[_builtins.str] application_id: Application this schedule belongs to.
|
|
:param pulumi.Input[_builtins.str] command: Command to run.
|
|
:param pulumi.Input[_builtins.str] compose_id: Compose stack this schedule belongs to.
|
|
:param pulumi.Input[_builtins.str] created_at: RFC 3339 timestamp of when the schedule was created.
|
|
:param pulumi.Input[_builtins.str] cron_expression: Standard five-field cron expression, for example `0 3 * * *`.
|
|
:param pulumi.Input[_builtins.str] description: Free-form description.
|
|
:param pulumi.Input[_builtins.bool] enabled: Whether the schedule is active.
|
|
:param pulumi.Input[_builtins.str] name: Display name of the schedule.
|
|
:param pulumi.Input[_builtins.str] schedule_type: Where the command runs. Valid values: `application`, `compose`, `server`, `dokploy-server`. Defaults to `application`.
|
|
:param pulumi.Input[_builtins.str] script: Multi-line script to run instead of a single command.
|
|
:param pulumi.Input[_builtins.str] server_id: Server this schedule runs on.
|
|
:param pulumi.Input[_builtins.str] service_name: Service inside a Compose stack to run the command in.
|
|
:param pulumi.Input[_builtins.str] shell_type: Shell used to interpret the command. Valid values: `bash`, `sh`. Defaults to `bash`.
|
|
:param pulumi.Input[_builtins.str] timezone: IANA timezone the cron expression is evaluated in, for example `Europe/Berlin`.
|
|
"""
|
|
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
|
|
|
|
__props__ = _ScheduleState.__new__(_ScheduleState)
|
|
|
|
__props__.__dict__["app_name"] = app_name
|
|
__props__.__dict__["application_id"] = application_id
|
|
__props__.__dict__["command"] = command
|
|
__props__.__dict__["compose_id"] = compose_id
|
|
__props__.__dict__["created_at"] = created_at
|
|
__props__.__dict__["cron_expression"] = cron_expression
|
|
__props__.__dict__["description"] = description
|
|
__props__.__dict__["enabled"] = enabled
|
|
__props__.__dict__["name"] = name
|
|
__props__.__dict__["schedule_type"] = schedule_type
|
|
__props__.__dict__["script"] = script
|
|
__props__.__dict__["server_id"] = server_id
|
|
__props__.__dict__["service_name"] = service_name
|
|
__props__.__dict__["shell_type"] = shell_type
|
|
__props__.__dict__["timezone"] = timezone
|
|
return Schedule(resource_name, opts=opts, __props__=__props__)
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="appName")
|
|
def app_name(self) -> pulumi.Output[_builtins.str]:
|
|
"""
|
|
Docker service name the schedule targets. Derived by Dokploy when omitted.
|
|
"""
|
|
return pulumi.get(self, "app_name")
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="applicationId")
|
|
def application_id(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
"""
|
|
Application this schedule belongs to.
|
|
"""
|
|
return pulumi.get(self, "application_id")
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def command(self) -> pulumi.Output[_builtins.str]:
|
|
"""
|
|
Command to run.
|
|
"""
|
|
return pulumi.get(self, "command")
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="composeId")
|
|
def compose_id(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
"""
|
|
Compose stack this schedule belongs to.
|
|
"""
|
|
return pulumi.get(self, "compose_id")
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="createdAt")
|
|
def created_at(self) -> pulumi.Output[_builtins.str]:
|
|
"""
|
|
RFC 3339 timestamp of when the schedule was created.
|
|
"""
|
|
return pulumi.get(self, "created_at")
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="cronExpression")
|
|
def cron_expression(self) -> pulumi.Output[_builtins.str]:
|
|
"""
|
|
Standard five-field cron expression, for example `0 3 * * *`.
|
|
"""
|
|
return pulumi.get(self, "cron_expression")
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def description(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
"""
|
|
Free-form description.
|
|
"""
|
|
return pulumi.get(self, "description")
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def enabled(self) -> pulumi.Output[_builtins.bool]:
|
|
"""
|
|
Whether the schedule is active.
|
|
"""
|
|
return pulumi.get(self, "enabled")
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def name(self) -> pulumi.Output[_builtins.str]:
|
|
"""
|
|
Display name of the schedule.
|
|
"""
|
|
return pulumi.get(self, "name")
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="scheduleType")
|
|
def schedule_type(self) -> pulumi.Output[_builtins.str]:
|
|
"""
|
|
Where the command runs. Valid values: `application`, `compose`, `server`, `dokploy-server`. Defaults to `application`.
|
|
"""
|
|
return pulumi.get(self, "schedule_type")
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def script(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
"""
|
|
Multi-line script to run instead of a single command.
|
|
"""
|
|
return pulumi.get(self, "script")
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="serverId")
|
|
def server_id(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
"""
|
|
Server this schedule runs on.
|
|
"""
|
|
return pulumi.get(self, "server_id")
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="serviceName")
|
|
def service_name(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
"""
|
|
Service inside a Compose stack to run the command in.
|
|
"""
|
|
return pulumi.get(self, "service_name")
|
|
|
|
@_builtins.property
|
|
@pulumi.getter(name="shellType")
|
|
def shell_type(self) -> pulumi.Output[_builtins.str]:
|
|
"""
|
|
Shell used to interpret the command. Valid values: `bash`, `sh`. Defaults to `bash`.
|
|
"""
|
|
return pulumi.get(self, "shell_type")
|
|
|
|
@_builtins.property
|
|
@pulumi.getter
|
|
def timezone(self) -> pulumi.Output[Optional[_builtins.str]]:
|
|
"""
|
|
IANA timezone the cron expression is evaluated in, for example `Europe/Berlin`.
|
|
"""
|
|
return pulumi.get(self, "timezone")
|
|
|