@spacelift-io/pulumi-spacelift/run.d.ts

A Pulumi package for creating and managing Spacelift resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * `spacelift.Run` allows programmatically triggering runs in response to arbitrary changes in the keepers section.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as spacelift from "@spacelift-io/pulumi-spacelift";
 *
 * const thisStack = new spacelift.Stack("thisStack", {
 *     repository: "test",
 *     branch: "main",
 * });
 * const thisRun = new spacelift.Run("thisRun", {
 *     stackId: thisStack.id,
 *     keepers: {
 *         branch: thisStack.branch,
 *     },
 * });
 * ```
 */
export declare class Run extends pulumi.CustomResource {
    /**
     * Get an existing Run 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 state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RunState, opts?: pulumi.CustomResourceOptions): Run;
    /**
     * Returns true if the given object is an instance of Run.  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 Run;
    /**
     * The commit SHA for which to trigger a run.
     */
    readonly commitSha: pulumi.Output<string | undefined>;
    /**
     * Arbitrary map of values that, when changed, will trigger recreation of the resource.
     */
    readonly keepers: pulumi.Output<{
        [key: string]: any;
    } | undefined>;
    /**
     * Whether the run is a proposed run. Defaults to `false`.
     */
    readonly proposed: pulumi.Output<boolean | undefined>;
    /**
     * ID of the stack on which the run is to be triggered.
     */
    readonly stackId: pulumi.Output<string>;
    /**
     * Create a Run 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: RunArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Run resources.
 */
export interface RunState {
    /**
     * The commit SHA for which to trigger a run.
     */
    commitSha?: pulumi.Input<string>;
    /**
     * Arbitrary map of values that, when changed, will trigger recreation of the resource.
     */
    keepers?: pulumi.Input<{
        [key: string]: any;
    }>;
    /**
     * Whether the run is a proposed run. Defaults to `false`.
     */
    proposed?: pulumi.Input<boolean>;
    /**
     * ID of the stack on which the run is to be triggered.
     */
    stackId?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Run resource.
 */
export interface RunArgs {
    /**
     * The commit SHA for which to trigger a run.
     */
    commitSha?: pulumi.Input<string>;
    /**
     * Arbitrary map of values that, when changed, will trigger recreation of the resource.
     */
    keepers?: pulumi.Input<{
        [key: string]: any;
    }>;
    /**
     * Whether the run is a proposed run. Defaults to `false`.
     */
    proposed?: pulumi.Input<boolean>;
    /**
     * ID of the stack on which the run is to be triggered.
     */
    stackId: pulumi.Input<string>;
}