Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Pulumi Cloud (Pulumi Service provider)
  4. API Docs
  5. api
  6. api/deployments
  7. ScheduledDeployment

This provider is currently in preview.

Viewing docs for Pulumi Cloud v1.1.0
published on Thursday, May 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-pulumiservice

pulumiservice.api/deployments.ScheduledDeployment

pulumiservice logo

This provider is currently in preview.

Viewing docs for Pulumi Cloud v1.1.0
published on Thursday, May 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-pulumiservice

    Creates a custom deployment schedule for a stack using Pulumi Deployments. Custom schedules allow you to automate recurring or one-time Pulumi operations on a stack. The request must include exactly one of ‘scheduleCron’ (a cron expression for recurring executions, e.g. ‘0 */4 * * *’ for every 4 hours) or ‘scheduleOnce’ (an ISO 8601 timestamp for a one-time execution). The ‘request’ field contains the deployment configuration that will be executed on each scheduled run, including the Pulumi operation type and any settings overrides. The stack must have deployment settings configured before a schedule can be created.

    Create ScheduledDeployment Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ScheduledDeployment(name: string, args: ScheduledDeploymentArgs, opts?: CustomResourceOptions);
    @overload
def ScheduledDeployment(resource_name: str,
                        args: ScheduledDeploymentArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def ScheduledDeployment(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        org_name: Optional[str] = None,
                        project_name: Optional[str] = None,
                        stack_name: Optional[str] = None,
                        request: Optional[Any] = None,
                        schedule_cron: Optional[str] = None,
                        schedule_id: Optional[str] = None,
                        schedule_once: Optional[str] = None)
    func NewScheduledDeployment(ctx *Context, name string, args ScheduledDeploymentArgs, opts ...ResourceOption) (*ScheduledDeployment, error)
    public ScheduledDeployment(string name, ScheduledDeploymentArgs args, CustomResourceOptions? opts = null)
    public ScheduledDeployment(String name, ScheduledDeploymentArgs args)
public ScheduledDeployment(String name, ScheduledDeploymentArgs args, CustomResourceOptions options)

    type: pulumiservice:api/deployments:ScheduledDeployment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "pulumiservice_api_deployments_scheduleddeployment" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ScheduledDeploymentArgs
    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 ScheduledDeploymentArgs
    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 ScheduledDeploymentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScheduledDeploymentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScheduledDeploymentArgs
    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 scheduledDeploymentResource = new PulumiService.Api.Deployments.ScheduledDeployment("scheduledDeploymentResource", new()
{
    OrgName = "string",
    ProjectName = "string",
    StackName = "string",
    Request = "any",
    ScheduleCron = "string",
    ScheduleID = "string",
    ScheduleOnce = "string",
});

    example, err := deployments.NewScheduledDeployment(ctx, "scheduledDeploymentResource", &deployments.ScheduledDeploymentArgs{
	OrgName:      pulumi.String("string"),
	ProjectName:  pulumi.String("string"),
	StackName:    pulumi.String("string"),
	Request:      pulumi.Any("any"),
	ScheduleCron: pulumi.String("string"),
	ScheduleID:   pulumi.String("string"),
	ScheduleOnce: pulumi.String("string"),
})

    resource "pulumiservice_api_deployments_scheduleddeployment" "scheduledDeploymentResource" {
  org_name      = "string"
  project_name  = "string"
  stack_name    = "string"
  request       = "any"
  schedule_cron = "string"
  schedule_id   = "string"
  schedule_once = "string"
}

    var scheduledDeploymentResource = new ScheduledDeployment("scheduledDeploymentResource", ScheduledDeploymentArgs.builder()
    .orgName("string")
    .projectName("string")
    .stackName("string")
    .request("any")
    .scheduleCron("string")
    .scheduleID("string")
    .scheduleOnce("string")
    .build());

    scheduled_deployment_resource = pulumiservice.api.deployments.ScheduledDeployment("scheduledDeploymentResource",
    org_name="string",
    project_name="string",
    stack_name="string",
    request="any",
    schedule_cron="string",
    schedule_id="string",
    schedule_once="string")

    const scheduledDeploymentResource = new pulumiservice.api.deployments.ScheduledDeployment("scheduledDeploymentResource", {
    orgName: "string",
    projectName: "string",
    stackName: "string",
    request: "any",
    scheduleCron: "string",
    scheduleID: "string",
    scheduleOnce: "string",
});

    type: pulumiservice:api/deployments:ScheduledDeployment
properties:
    orgName: string
    projectName: string
    request: any
    scheduleCron: string
    scheduleID: string
    scheduleOnce: string
    stackName: string

    ScheduledDeployment 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 ScheduledDeployment resource accepts the following input properties:

    OrgName string
    The organization name
    ProjectName string
    The project name
    StackName string
    The stack name
    Request object
    Deployment request payload to execute when the schedule fires. This has the same shape and semantics as CreateDeploymentRequest used for immediate deployments.
    ScheduleCron string
    Cron expression defining a recurring schedule for this deployment. When set, scheduleOnce must be null. Uses standard 5-field cron syntax (MIN HOUR DOM MON DOW) and is evaluated in UTC.
    ScheduleID string
    The schedule identifier
    ScheduleOnce string
    Single point-in-time schedule for this deployment. When set, scheduleCron must be null. The value must be an ISO 8601 timestamp with timezone.
    OrgName string
    The organization name
    ProjectName string
    The project name
    StackName string
    The stack name
    Request interface{}
    Deployment request payload to execute when the schedule fires. This has the same shape and semantics as CreateDeploymentRequest used for immediate deployments.
    ScheduleCron string
    Cron expression defining a recurring schedule for this deployment. When set, scheduleOnce must be null. Uses standard 5-field cron syntax (MIN HOUR DOM MON DOW) and is evaluated in UTC.
    ScheduleID string
    The schedule identifier
    ScheduleOnce string
    Single point-in-time schedule for this deployment. When set, scheduleCron must be null. The value must be an ISO 8601 timestamp with timezone.
    org_name string
    The organization name
    project_name string
    The project name
    stack_name string
    The stack name
    request any
    Deployment request payload to execute when the schedule fires. This has the same shape and semantics as CreateDeploymentRequest used for immediate deployments.
    schedule_cron string
    Cron expression defining a recurring schedule for this deployment. When set, scheduleOnce must be null. Uses standard 5-field cron syntax (MIN HOUR DOM MON DOW) and is evaluated in UTC.
    schedule_id string
    The schedule identifier
    schedule_once string
    Single point-in-time schedule for this deployment. When set, scheduleCron must be null. The value must be an ISO 8601 timestamp with timezone.
    orgName String
    The organization name
    projectName String
    The project name
    stackName String
    The stack name
    request Object
    Deployment request payload to execute when the schedule fires. This has the same shape and semantics as CreateDeploymentRequest used for immediate deployments.
    scheduleCron String
    Cron expression defining a recurring schedule for this deployment. When set, scheduleOnce must be null. Uses standard 5-field cron syntax (MIN HOUR DOM MON DOW) and is evaluated in UTC.
    scheduleID String
    The schedule identifier
    scheduleOnce String
    Single point-in-time schedule for this deployment. When set, scheduleCron must be null. The value must be an ISO 8601 timestamp with timezone.
    orgName string
    The organization name
    projectName string
    The project name
    stackName string
    The stack name
    request any
    Deployment request payload to execute when the schedule fires. This has the same shape and semantics as CreateDeploymentRequest used for immediate deployments.
    scheduleCron string
    Cron expression defining a recurring schedule for this deployment. When set, scheduleOnce must be null. Uses standard 5-field cron syntax (MIN HOUR DOM MON DOW) and is evaluated in UTC.
    scheduleID string
    The schedule identifier
    scheduleOnce string
    Single point-in-time schedule for this deployment. When set, scheduleCron must be null. The value must be an ISO 8601 timestamp with timezone.
    org_name str
    The organization name
    project_name str
    The project name
    stack_name str
    The stack name
    request Any
    Deployment request payload to execute when the schedule fires. This has the same shape and semantics as CreateDeploymentRequest used for immediate deployments.
    schedule_cron str
    Cron expression defining a recurring schedule for this deployment. When set, scheduleOnce must be null. Uses standard 5-field cron syntax (MIN HOUR DOM MON DOW) and is evaluated in UTC.
    schedule_id str
    The schedule identifier
    schedule_once str
    Single point-in-time schedule for this deployment. When set, scheduleCron must be null. The value must be an ISO 8601 timestamp with timezone.
    orgName String
    The organization name
    projectName String
    The project name
    stackName String
    The stack name
    request Any
    Deployment request payload to execute when the schedule fires. This has the same shape and semantics as CreateDeploymentRequest used for immediate deployments.
    scheduleCron String
    Cron expression defining a recurring schedule for this deployment. When set, scheduleOnce must be null. Uses standard 5-field cron syntax (MIN HOUR DOM MON DOW) and is evaluated in UTC.
    scheduleID String
    The schedule identifier
    scheduleOnce String
    Single point-in-time schedule for this deployment. When set, scheduleCron must be null. The value must be an ISO 8601 timestamp with timezone.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ScheduledDeployment resource produces the following output properties:

    Created string
    The timestamp when this scheduled action was created.
    Definition Dictionary<string, object>
    The action definition, which varies based on the action kind.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kind string
    The kind of action to be executed.
    LastExecuted string
    The timestamp of the last execution, if any.
    Modified string
    The timestamp when this scheduled action was last modified.
    NextExecution string
    The timestamp of the next scheduled execution.
    OrgID string
    The organization ID that owns this scheduled action.
    Paused bool
    Whether the scheduled action is currently paused.
    Created string
    The timestamp when this scheduled action was created.
    Definition map[string]interface{}
    The action definition, which varies based on the action kind.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kind string
    The kind of action to be executed.
    LastExecuted string
    The timestamp of the last execution, if any.
    Modified string
    The timestamp when this scheduled action was last modified.
    NextExecution string
    The timestamp of the next scheduled execution.
    OrgID string
    The organization ID that owns this scheduled action.
    Paused bool
    Whether the scheduled action is currently paused.
    created string
    The timestamp when this scheduled action was created.
    definition map(any)
    The action definition, which varies based on the action kind.
    id string
    The provider-assigned unique ID for this managed resource.
    kind string
    The kind of action to be executed.
    last_executed string
    The timestamp of the last execution, if any.
    modified string
    The timestamp when this scheduled action was last modified.
    next_execution string
    The timestamp of the next scheduled execution.
    org_id string
    The organization ID that owns this scheduled action.
    paused bool
    Whether the scheduled action is currently paused.
    created String
    The timestamp when this scheduled action was created.
    definition Map<String,Object>
    The action definition, which varies based on the action kind.
    id String
    The provider-assigned unique ID for this managed resource.
    kind String
    The kind of action to be executed.
    lastExecuted String
    The timestamp of the last execution, if any.
    modified String
    The timestamp when this scheduled action was last modified.
    nextExecution String
    The timestamp of the next scheduled execution.
    orgID String
    The organization ID that owns this scheduled action.
    paused Boolean
    Whether the scheduled action is currently paused.
    created string
    The timestamp when this scheduled action was created.
    definition {[key: string]: any}
    The action definition, which varies based on the action kind.
    id string
    The provider-assigned unique ID for this managed resource.
    kind string
    The kind of action to be executed.
    lastExecuted string
    The timestamp of the last execution, if any.
    modified string
    The timestamp when this scheduled action was last modified.
    nextExecution string
    The timestamp of the next scheduled execution.
    orgID string
    The organization ID that owns this scheduled action.
    paused boolean
    Whether the scheduled action is currently paused.
    created str
    The timestamp when this scheduled action was created.
    definition Mapping[str, Any]
    The action definition, which varies based on the action kind.
    id str
    The provider-assigned unique ID for this managed resource.
    kind str
    The kind of action to be executed.
    last_executed str
    The timestamp of the last execution, if any.
    modified str
    The timestamp when this scheduled action was last modified.
    next_execution str
    The timestamp of the next scheduled execution.
    org_id str
    The organization ID that owns this scheduled action.
    paused bool
    Whether the scheduled action is currently paused.
    created String
    The timestamp when this scheduled action was created.
    definition Map<Any>
    The action definition, which varies based on the action kind.
    id String
    The provider-assigned unique ID for this managed resource.
    kind String
    The kind of action to be executed.
    lastExecuted String
    The timestamp of the last execution, if any.
    modified String
    The timestamp when this scheduled action was last modified.
    nextExecution String
    The timestamp of the next scheduled execution.
    orgID String
    The organization ID that owns this scheduled action.
    paused Boolean
    Whether the scheduled action is currently paused.

    Package Details

    Repository
    pulumiservice pulumi/pulumi-pulumiservice
    License
    Apache-2.0
    pulumiservice logo

    This provider is currently in preview.

    Viewing docs for Pulumi Cloud v1.1.0
    published on Thursday, May 21, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-pulumiservice

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial