@pulumi/pulumiservice
Version:
[](https://slack.pulumi.com) [](https://www.npmjs.com/package/@pulumi/pulumiservice) [![Python version](https://badge.fury.io
108 lines • 4.54 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* 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.
*/
export declare class ScheduledDeployment extends pulumi.CustomResource {
/**
* Get an existing ScheduledDeployment 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): ScheduledDeployment;
/**
* Returns true if the given object is an instance of ScheduledDeployment. 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 ScheduledDeployment;
/**
* The timestamp when this scheduled action was created.
*/
readonly created: pulumi.Output<string>;
/**
* The action definition, which varies based on the action kind.
*/
readonly definition: pulumi.Output<{
[key: string]: any;
}>;
/**
* The kind of action to be executed.
*/
readonly kind: pulumi.Output<string>;
/**
* The timestamp of the last execution, if any.
*/
readonly lastExecuted: pulumi.Output<string>;
/**
* The timestamp when this scheduled action was last modified.
*/
readonly modified: pulumi.Output<string>;
/**
* The timestamp of the next scheduled execution.
*/
readonly nextExecution: pulumi.Output<string>;
/**
* The organization ID that owns this scheduled action.
*/
readonly orgID: pulumi.Output<string>;
/**
* Whether the scheduled action is currently paused.
*/
readonly paused: pulumi.Output<boolean>;
/**
* A cron expression defining the recurring schedule.
*/
readonly scheduleCron: pulumi.Output<string | undefined>;
/**
* The unique identifier for this scheduled action.
*/
readonly scheduleID: pulumi.Output<string>;
/**
* A timestamp for a one-time scheduled execution.
*/
readonly scheduleOnce: pulumi.Output<string | undefined>;
/**
* Create a ScheduledDeployment 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: ScheduledDeploymentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a ScheduledDeployment resource.
*/
export interface ScheduledDeploymentArgs {
/**
* The organization name
*/
orgName: pulumi.Input<string>;
/**
* The project name
*/
projectName: pulumi.Input<string>;
/**
* Deployment request payload to execute when the schedule fires. This has the same shape and semantics as CreateDeploymentRequest used for immediate deployments.
*/
request?: any | undefined;
/**
* 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.
*/
scheduleCron?: pulumi.Input<string | undefined>;
/**
* The schedule identifier
*/
scheduleID?: pulumi.Input<string | undefined>;
/**
* Single point-in-time schedule for this deployment. When set, scheduleCron must be null. The value must be an ISO 8601 timestamp with timezone.
*/
scheduleOnce?: pulumi.Input<string | undefined>;
/**
* The stack name
*/
stackName: pulumi.Input<string>;
}
//# sourceMappingURL=scheduledDeployment.d.ts.map