@pulumi/pulumiservice
Version:
87 lines (86 loc) • 3.16 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as enums from "./types/enums";
/**
* A scheduled recurring or single time run of a pulumi command.
*/
export declare class DeploymentSchedule extends pulumi.CustomResource {
/**
* Get an existing DeploymentSchedule resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): DeploymentSchedule;
/**
* Returns true if the given object is an instance of DeploymentSchedule. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is DeploymentSchedule;
/**
* Organization name.
*/
readonly organization: pulumi.Output<string>;
/**
* Project name.
*/
readonly project: pulumi.Output<string>;
/**
* Which operation to run.
*/
readonly pulumiOperation: pulumi.Output<enums.PulumiOperation>;
/**
* Cron expression for recurring scheduled runs. If you are supplying this, do not supply timestamp.
*/
readonly scheduleCron: pulumi.Output<string | undefined>;
/**
* Schedule ID of the created schedule, assigned by Pulumi Cloud.
*/
readonly scheduleId: pulumi.Output<string>;
/**
* Stack name.
*/
readonly stack: pulumi.Output<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.
*/
readonly timestamp: pulumi.Output<string | undefined>;
/**
* Create a DeploymentSchedule resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: DeploymentScheduleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a DeploymentSchedule resource.
*/
export interface DeploymentScheduleArgs {
/**
* Organization name.
*/
organization: pulumi.Input<string>;
/**
* Project name.
*/
project: pulumi.Input<string>;
/**
* Which command to run.
*/
pulumiOperation: pulumi.Input<enums.PulumiOperation>;
/**
* Cron expression for recurring scheduled runs. If you are supplying this, do not supply timestamp.
*/
scheduleCron?: pulumi.Input<string>;
/**
* Stack name.
*/
stack: pulumi.Input<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.
*/
timestamp?: pulumi.Input<string>;
}