@pulumi/pulumiservice
Version:
[](https://slack.pulumi.com) [](https://www.npmjs.com/package/@pulumi/pulumiservice) [![Python version](https://badge.fury.io
108 lines • 3.85 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Creates a new scheduled action for a Pulumi ESC environment. Schedules can be used to automate recurring operations on environments, such as secret rotation. The request body specifies the schedule timing and the action to perform. Returns the created ScheduledAction on success. Requires the secret rotation feature to be enabled for the organization.
*/
export declare class EnvironmentSchedule extends pulumi.CustomResource {
/**
* Get an existing EnvironmentSchedule 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): EnvironmentSchedule;
/**
* Returns true if the given object is an instance of EnvironmentSchedule. 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 EnvironmentSchedule;
/**
* 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 EnvironmentSchedule 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: EnvironmentScheduleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a EnvironmentSchedule resource.
*/
export interface EnvironmentScheduleArgs {
/**
* The environment name
*/
envName: pulumi.Input<string>;
/**
* The organization name
*/
orgName: pulumi.Input<string>;
/**
* The project name
*/
projectName: pulumi.Input<string>;
/**
* The schedule cron
*/
scheduleCron?: pulumi.Input<string | undefined>;
/**
* The schedule ID
*/
scheduleID?: pulumi.Input<string | undefined>;
/**
* The schedule once
*/
scheduleOnce?: pulumi.Input<string | undefined>;
/**
* The secret rotation request
*/
secretRotationRequest?: any | undefined;
}
//# sourceMappingURL=environmentSchedule.d.ts.map