published on Thursday, Nov 5, 2026 by dimeskigj
published on Thursday, Nov 5, 2026 by dimeskigj
A Dokploy scheduled command.
Create Schedule Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Schedule(name: string, args: ScheduleArgs, opts?: CustomResourceOptions);@overload
def Schedule(resource_name: str,
args: ScheduleArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Schedule(resource_name: str,
opts: Optional[ResourceOptions] = None,
cron_expression: Optional[str] = None,
schedule_type: Optional[str] = None,
command: Optional[str] = None,
name: Optional[str] = None,
compose_id: Optional[str] = None,
description: Optional[str] = None,
enabled: Optional[bool] = None,
app_name: Optional[str] = None,
organization_id: Optional[str] = None,
application_id: Optional[str] = None,
script: Optional[str] = None,
server_id: Optional[str] = None,
service_name: Optional[str] = None,
shell_type: Optional[str] = None,
timezone: Optional[str] = None)func NewSchedule(ctx *Context, name string, args ScheduleArgs, opts ...ResourceOption) (*Schedule, error)public Schedule(string name, ScheduleArgs args, CustomResourceOptions? opts = null)
public Schedule(String name, ScheduleArgs args)
public Schedule(String name, ScheduleArgs args, CustomResourceOptions options)
type: dokploy:Schedule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "dokploy_schedule" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args ScheduleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ScheduleArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ScheduleArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ScheduleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ScheduleArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var scheduleResource = new Dokploy.Schedule("scheduleResource", new()
{
CronExpression = "string",
ScheduleType = "string",
Command = "string",
Name = "string",
ComposeId = "string",
Description = "string",
Enabled = false,
AppName = "string",
OrganizationId = "string",
ApplicationId = "string",
Script = "string",
ServerId = "string",
ServiceName = "string",
ShellType = "string",
Timezone = "string",
});
example, err := dokploy.NewSchedule(ctx, "scheduleResource", &dokploy.ScheduleArgs{
CronExpression: pulumi.String("string"),
ScheduleType: pulumi.String("string"),
Command: pulumi.String("string"),
Name: pulumi.String("string"),
ComposeId: pulumi.String("string"),
Description: pulumi.String("string"),
Enabled: pulumi.Bool(false),
AppName: pulumi.String("string"),
OrganizationId: pulumi.String("string"),
ApplicationId: pulumi.String("string"),
Script: pulumi.String("string"),
ServerId: pulumi.String("string"),
ServiceName: pulumi.String("string"),
ShellType: pulumi.String("string"),
Timezone: pulumi.String("string"),
})
resource "dokploy_schedule" "scheduleResource" {
lifecycle {
create_before_destroy = true
}
cron_expression = "string"
schedule_type = "string"
command = "string"
name = "string"
compose_id = "string"
description = "string"
enabled = false
app_name = "string"
organization_id = "string"
application_id = "string"
script = "string"
server_id = "string"
service_name = "string"
shell_type = "string"
timezone = "string"
}
var scheduleResource = new Schedule("scheduleResource", ScheduleArgs.builder()
.cronExpression("string")
.scheduleType("string")
.command("string")
.name("string")
.composeId("string")
.description("string")
.enabled(false)
.appName("string")
.organizationId("string")
.applicationId("string")
.script("string")
.serverId("string")
.serviceName("string")
.shellType("string")
.timezone("string")
.build());
schedule_resource = dokploy.Schedule("scheduleResource",
cron_expression="string",
schedule_type="string",
command="string",
name="string",
compose_id="string",
description="string",
enabled=False,
app_name="string",
organization_id="string",
application_id="string",
script="string",
server_id="string",
service_name="string",
shell_type="string",
timezone="string")
const scheduleResource = new dokploy.Schedule("scheduleResource", {
cronExpression: "string",
scheduleType: "string",
command: "string",
name: "string",
composeId: "string",
description: "string",
enabled: false,
appName: "string",
organizationId: "string",
applicationId: "string",
script: "string",
serverId: "string",
serviceName: "string",
shellType: "string",
timezone: "string",
});
type: dokploy:Schedule
properties:
appName: string
applicationId: string
command: string
composeId: string
cronExpression: string
description: string
enabled: false
name: string
organizationId: string
scheduleType: string
script: string
serverId: string
serviceName: string
shellType: string
timezone: string
Schedule Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Schedule resource accepts the following input properties:
- Command string
- Command executed by the schedule.
- Cron
Expression string - Cron expression for the schedule.
- Name string
- Schedule name.
- Schedule
Type string - Schedule target type: application, compose, server, or dokploy-server.
- App
Name string - Optional application name.
- Application
Id string - Target application ID.
- Compose
Id string - Target Compose ID.
- Description string
- Optional schedule description.
- Enabled bool
- Whether the schedule is enabled; defaults to false.
- Organization
Id string - Dokploy organization ID.
- Script string
- Optional script executed by the schedule.
- Server
Id string - Target server ID.
- Service
Name string - Optional Compose service name.
- Shell
Type string - Shell used to execute the command (bash or sh).
- Timezone string
- Timezone for the schedule.
- Command string
- Command executed by the schedule.
- Cron
Expression string - Cron expression for the schedule.
- Name string
- Schedule name.
- Schedule
Type string - Schedule target type: application, compose, server, or dokploy-server.
- App
Name string - Optional application name.
- Application
Id string - Target application ID.
- Compose
Id string - Target Compose ID.
- Description string
- Optional schedule description.
- Enabled bool
- Whether the schedule is enabled; defaults to false.
- Organization
Id string - Dokploy organization ID.
- Script string
- Optional script executed by the schedule.
- Server
Id string - Target server ID.
- Service
Name string - Optional Compose service name.
- Shell
Type string - Shell used to execute the command (bash or sh).
- Timezone string
- Timezone for the schedule.
- command string
- Command executed by the schedule.
- cron_
expression string - Cron expression for the schedule.
- name string
- Schedule name.
- schedule_
type string - Schedule target type: application, compose, server, or dokploy-server.
- app_
name string - Optional application name.
- application_
id string - Target application ID.
- compose_
id string - Target Compose ID.
- description string
- Optional schedule description.
- enabled bool
- Whether the schedule is enabled; defaults to false.
- organization_
id string - Dokploy organization ID.
- script string
- Optional script executed by the schedule.
- server_
id string - Target server ID.
- service_
name string - Optional Compose service name.
- shell_
type string - Shell used to execute the command (bash or sh).
- timezone string
- Timezone for the schedule.
- command String
- Command executed by the schedule.
- cron
Expression String - Cron expression for the schedule.
- name String
- Schedule name.
- schedule
Type String - Schedule target type: application, compose, server, or dokploy-server.
- app
Name String - Optional application name.
- application
Id String - Target application ID.
- compose
Id String - Target Compose ID.
- description String
- Optional schedule description.
- enabled Boolean
- Whether the schedule is enabled; defaults to false.
- organization
Id String - Dokploy organization ID.
- script String
- Optional script executed by the schedule.
- server
Id String - Target server ID.
- service
Name String - Optional Compose service name.
- shell
Type String - Shell used to execute the command (bash or sh).
- timezone String
- Timezone for the schedule.
- command string
- Command executed by the schedule.
- cron
Expression string - Cron expression for the schedule.
- name string
- Schedule name.
- schedule
Type string - Schedule target type: application, compose, server, or dokploy-server.
- app
Name string - Optional application name.
- application
Id string - Target application ID.
- compose
Id string - Target Compose ID.
- description string
- Optional schedule description.
- enabled boolean
- Whether the schedule is enabled; defaults to false.
- organization
Id string - Dokploy organization ID.
- script string
- Optional script executed by the schedule.
- server
Id string - Target server ID.
- service
Name string - Optional Compose service name.
- shell
Type string - Shell used to execute the command (bash or sh).
- timezone string
- Timezone for the schedule.
- command str
- Command executed by the schedule.
- cron_
expression str - Cron expression for the schedule.
- name str
- Schedule name.
- schedule_
type str - Schedule target type: application, compose, server, or dokploy-server.
- app_
name str - Optional application name.
- application_
id str - Target application ID.
- compose_
id str - Target Compose ID.
- description str
- Optional schedule description.
- enabled bool
- Whether the schedule is enabled; defaults to false.
- organization_
id str - Dokploy organization ID.
- script str
- Optional script executed by the schedule.
- server_
id str - Target server ID.
- service_
name str - Optional Compose service name.
- shell_
type str - Shell used to execute the command (bash or sh).
- timezone str
- Timezone for the schedule.
- command String
- Command executed by the schedule.
- cron
Expression String - Cron expression for the schedule.
- name String
- Schedule name.
- schedule
Type String - Schedule target type: application, compose, server, or dokploy-server.
- app
Name String - Optional application name.
- application
Id String - Target application ID.
- compose
Id String - Target Compose ID.
- description String
- Optional schedule description.
- enabled Boolean
- Whether the schedule is enabled; defaults to false.
- organization
Id String - Dokploy organization ID.
- script String
- Optional script executed by the schedule.
- server
Id String - Target server ID.
- service
Name String - Optional Compose service name.
- shell
Type String - Shell used to execute the command (bash or sh).
- timezone String
- Timezone for the schedule.
Outputs
All input properties are implicitly available as output properties. Additionally, the Schedule resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Schedule
Id string - Stable Dokploy schedule ID.
- Id string
- The provider-assigned unique ID for this managed resource.
- Schedule
Id string - Stable Dokploy schedule ID.
- id string
- The provider-assigned unique ID for this managed resource.
- schedule_
id string - Stable Dokploy schedule ID.
- id String
- The provider-assigned unique ID for this managed resource.
- schedule
Id String - Stable Dokploy schedule ID.
- id string
- The provider-assigned unique ID for this managed resource.
- schedule
Id string - Stable Dokploy schedule ID.
- id str
- The provider-assigned unique ID for this managed resource.
- schedule_
id str - Stable Dokploy schedule ID.
- id String
- The provider-assigned unique ID for this managed resource.
- schedule
Id String - Stable Dokploy schedule ID.
Look up Existing Schedule Resource
Get an existing Schedule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): Schedule@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> Schedulefunc GetSchedule(ctx *Context, name string, id IDInput, state *ScheduleState, opts ...ResourceOption) (*Schedule, error)public static Schedule Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static Schedule get(String name, Output<String> id, CustomResourceOptions options)resources: existingSchedule: type: dokploy:Schedule get: id: ${id}import {
to = dokploy_schedule.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state ScheduleState
- Pass nil. This resource has no state arguments.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Package Details
- Repository
- dokploy dimeskigj/pulumi-dokploy
- License
- Apache-2.0
published on Thursday, Nov 5, 2026 by dimeskigj