Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Pulumi Cloud (Pulumi Service provider)
  3. API Docs
  4. DeploymentSchedule
Pulumi Cloud v0.27.1 published on Thursday, Nov 14, 2024 by Pulumi
pulumi/pulumi-pulumiservice

pulumiservice.DeploymentSchedule

Explore with Pulumi AI

pulumiservice logo
Pulumi Cloud v0.27.1 published on Thursday, Nov 14, 2024 by Pulumi
pulumi/pulumi-pulumiservice

    A scheduled recurring or single time run of a pulumi command.

    Create DeploymentSchedule Resource

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

    Constructor syntax

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

@overload
def DeploymentSchedule(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       organization: Optional[str] = None,
                       project: Optional[str] = None,
                       pulumi_operation: Optional[PulumiOperation] = None,
                       stack: Optional[str] = None,
                       schedule_cron: Optional[str] = None,
                       timestamp: Optional[str] = None)
    func NewDeploymentSchedule(ctx *Context, name string, args DeploymentScheduleArgs, opts ...ResourceOption) (*DeploymentSchedule, error)
    public DeploymentSchedule(string name, DeploymentScheduleArgs args, CustomResourceOptions? opts = null)
    public DeploymentSchedule(String name, DeploymentScheduleArgs args)
public DeploymentSchedule(String name, DeploymentScheduleArgs args, CustomResourceOptions options)

    type: pulumiservice:DeploymentSchedule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args DeploymentScheduleArgs
    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 DeploymentScheduleArgs
    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 DeploymentScheduleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DeploymentScheduleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DeploymentScheduleArgs
    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 deploymentScheduleResource = new PulumiService.DeploymentSchedule("deploymentScheduleResource", new()
{
    Organization = "string",
    Project = "string",
    PulumiOperation = PulumiService.PulumiOperation.Update,
    Stack = "string",
    ScheduleCron = "string",
    Timestamp = "string",
});

    example, err := pulumiservice.NewDeploymentSchedule(ctx, "deploymentScheduleResource", &pulumiservice.DeploymentScheduleArgs{
	Organization:    pulumi.String("string"),
	Project:         pulumi.String("string"),
	PulumiOperation: pulumiservice.PulumiOperationUpdate,
	Stack:           pulumi.String("string"),
	ScheduleCron:    pulumi.String("string"),
	Timestamp:       pulumi.String("string"),
})

    var deploymentScheduleResource = new DeploymentSchedule("deploymentScheduleResource", DeploymentScheduleArgs.builder()
    .organization("string")
    .project("string")
    .pulumiOperation("update")
    .stack("string")
    .scheduleCron("string")
    .timestamp("string")
    .build());

    deployment_schedule_resource = pulumiservice.DeploymentSchedule("deploymentScheduleResource",
    organization="string",
    project="string",
    pulumi_operation=pulumiservice.PulumiOperation.UPDATE,
    stack="string",
    schedule_cron="string",
    timestamp="string")

    const deploymentScheduleResource = new pulumiservice.DeploymentSchedule("deploymentScheduleResource", {
    organization: "string",
    project: "string",
    pulumiOperation: pulumiservice.PulumiOperation.Update,
    stack: "string",
    scheduleCron: "string",
    timestamp: "string",
});

    type: pulumiservice:DeploymentSchedule
properties:
    organization: string
    project: string
    pulumiOperation: update
    scheduleCron: string
    stack: string
    timestamp: string

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

    Organization string
    Organization name.
    Project string
    Project name.
    PulumiOperation Pulumi.PulumiService.PulumiOperation
    Which command to run.
    Stack string
    Stack name.
    ScheduleCron string
    Cron expression for recurring scheduled runs. If you are supplying this, do not supply timestamp.
    Timestamp string
    The time at which the schedule should run, in ISO 8601 format. Eg: 2020-01-01T00:00:00Z. If you are supplying this, do not supply scheduleCron.
    Organization string
    Organization name.
    Project string
    Project name.
    PulumiOperation PulumiOperation
    Which command to run.
    Stack string
    Stack name.
    ScheduleCron string
    Cron expression for recurring scheduled runs. If you are supplying this, do not supply timestamp.
    Timestamp string
    The time at which the schedule should run, in ISO 8601 format. Eg: 2020-01-01T00:00:00Z. If you are supplying this, do not supply scheduleCron.
    organization String
    Organization name.
    project String
    Project name.
    pulumiOperation PulumiOperation
    Which command to run.
    stack String
    Stack name.
    scheduleCron String
    Cron expression for recurring scheduled runs. If you are supplying this, do not supply timestamp.
    timestamp String
    The time at which the schedule should run, in ISO 8601 format. Eg: 2020-01-01T00:00:00Z. If you are supplying this, do not supply scheduleCron.
    organization string
    Organization name.
    project string
    Project name.
    pulumiOperation PulumiOperation
    Which command to run.
    stack string
    Stack name.
    scheduleCron string
    Cron expression for recurring scheduled runs. If you are supplying this, do not supply timestamp.
    timestamp string
    The time at which the schedule should run, in ISO 8601 format. Eg: 2020-01-01T00:00:00Z. If you are supplying this, do not supply scheduleCron.
    organization str
    Organization name.
    project str
    Project name.
    pulumi_operation PulumiOperation
    Which command to run.
    stack str
    Stack name.
    schedule_cron str
    Cron expression for recurring scheduled runs. If you are supplying this, do not supply timestamp.
    timestamp str
    The time at which the schedule should run, in ISO 8601 format. Eg: 2020-01-01T00:00:00Z. If you are supplying this, do not supply scheduleCron.
    organization String
    Organization name.
    project String
    Project name.
    pulumiOperation "update" | "preview" | "refresh" | "destroy"
    Which command to run.
    stack String
    Stack name.
    scheduleCron String
    Cron expression for recurring scheduled runs. If you are supplying this, do not supply timestamp.
    timestamp String
    The time at which the schedule should run, in ISO 8601 format. Eg: 2020-01-01T00:00:00Z. If you are supplying this, do not supply scheduleCron.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    ScheduleId string
    Schedule ID of the created schedule, assigned by Pulumi Cloud.
    Id string
    The provider-assigned unique ID for this managed resource.
    ScheduleId string
    Schedule ID of the created schedule, assigned by Pulumi Cloud.
    id String
    The provider-assigned unique ID for this managed resource.
    scheduleId String
    Schedule ID of the created schedule, assigned by Pulumi Cloud.
    id string
    The provider-assigned unique ID for this managed resource.
    scheduleId string
    Schedule ID of the created schedule, assigned by Pulumi Cloud.
    id str
    The provider-assigned unique ID for this managed resource.
    schedule_id str
    Schedule ID of the created schedule, assigned by Pulumi Cloud.
    id String
    The provider-assigned unique ID for this managed resource.
    scheduleId String
    Schedule ID of the created schedule, assigned by Pulumi Cloud.

    Supporting Types

    PulumiOperation, PulumiOperationArgs

    Update
    updateAnalogous to pulumi up command.
    Preview
    previewAnalogous to pulumi preview command.
    Refresh
    refreshAnalogous to pulumi refresh command.
    Destroy
    destroyAnalogous to pulumi destroy command.
    PulumiOperationUpdate
    updateAnalogous to pulumi up command.
    PulumiOperationPreview
    previewAnalogous to pulumi preview command.
    PulumiOperationRefresh
    refreshAnalogous to pulumi refresh command.
    PulumiOperationDestroy
    destroyAnalogous to pulumi destroy command.
    Update
    updateAnalogous to pulumi up command.
    Preview
    previewAnalogous to pulumi preview command.
    Refresh
    refreshAnalogous to pulumi refresh command.
    Destroy
    destroyAnalogous to pulumi destroy command.
    Update
    updateAnalogous to pulumi up command.
    Preview
    previewAnalogous to pulumi preview command.
    Refresh
    refreshAnalogous to pulumi refresh command.
    Destroy
    destroyAnalogous to pulumi destroy command.
    UPDATE
    updateAnalogous to pulumi up command.
    PREVIEW
    previewAnalogous to pulumi preview command.
    REFRESH
    refreshAnalogous to pulumi refresh command.
    DESTROY
    destroyAnalogous to pulumi destroy command.
    "update"
    updateAnalogous to pulumi up command.
    "preview"
    previewAnalogous to pulumi preview command.
    "refresh"
    refreshAnalogous to pulumi refresh command.
    "destroy"
    destroyAnalogous to pulumi destroy command.

    Package Details

    Repository
    pulumiservice pulumi/pulumi-pulumiservice
    License
    Apache-2.0
    pulumiservice logo
    Pulumi Cloud v0.27.1 published on Thursday, Nov 14, 2024 by Pulumi
    pulumi/pulumi-pulumiservice