pipelineSchedule.ts

// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

import * as pulumi from "@pulumi/pulumi";
import * as utilities from "./utilities";

/**
 * This resource allows you to create and manage pipeline schedules.
 * For further information on clusters, consult the [gitlab
 * documentation](https://docs.gitlab.com/ce/user/project/pipelines/schedules.html).
 * 
 * ## Example Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gitlab from "@pulumi/gitlab";
 * 
 * const example = new gitlab.PipelineSchedule("example", {
 *     cron: "0 1 * * *",
 *     description: "Used to schedule builds",
 *     project: "12345",
 *     ref: "master",
 * });
 * ```
 *
 * > This content is derived from https://github.com/terraform-providers/terraform-provider-gitlab/blob/master/website/docs/r/pipeline_schedule.html.markdown.
 */
export class PipelineSchedule extends pulumi.CustomResource {
    /**
     * Get an existing PipelineSchedule 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.
     */
    public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PipelineScheduleState, opts?: pulumi.CustomResourceOptions): PipelineSchedule {
        return new PipelineSchedule(name, <any>state, { ...opts, id: id });
    }

    /** @internal */
    public static readonly __pulumiType = 'gitlab:index/pipelineSchedule:PipelineSchedule';

    /**
     * Returns true if the given object is an instance of PipelineSchedule.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    public static isInstance(obj: any): obj is PipelineSchedule {
        if (obj === undefined || obj === null) {
            return false;
        }
        return obj['__pulumiType'] === PipelineSchedule.__pulumiType;
    }

    /**
     * The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially.
     */
    public readonly active!: pulumi.Output<boolean | undefined>;
    /**
     * The cron (e.g. `0 1 * * *`).
     */
    public readonly cron!: pulumi.Output<string>;
    /**
     * The timezone.
     */
    public readonly cronTimezone!: pulumi.Output<string | undefined>;
    /**
     * The description of the pipeline schedule.
     */
    public readonly description!: pulumi.Output<string>;
    /**
     * The name or id of the project to add the schedule to.
     */
    public readonly project!: pulumi.Output<string>;
    /**
     * The branch/tag name to be triggered.
     */
    public readonly ref!: pulumi.Output<string>;

    /**
     * Create a PipelineSchedule 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: PipelineScheduleArgs, opts?: pulumi.CustomResourceOptions)
    constructor(name: string, argsOrState?: PipelineScheduleArgs | PipelineScheduleState, opts?: pulumi.CustomResourceOptions) {
        let inputs: pulumi.Inputs = {};
        if (opts && opts.id) {
            const state = argsOrState as PipelineScheduleState | undefined;
            inputs["active"] = state ? state.active : undefined;
            inputs["cron"] = state ? state.cron : undefined;
            inputs["cronTimezone"] = state ? state.cronTimezone : undefined;
            inputs["description"] = state ? state.description : undefined;
            inputs["project"] = state ? state.project : undefined;
            inputs["ref"] = state ? state.ref : undefined;
        } else {
            const args = argsOrState as PipelineScheduleArgs | undefined;
            if (!args || args.cron === undefined) {
                throw new Error("Missing required property 'cron'");
            }
            if (!args || args.description === undefined) {
                throw new Error("Missing required property 'description'");
            }
            if (!args || args.project === undefined) {
                throw new Error("Missing required property 'project'");
            }
            if (!args || args.ref === undefined) {
                throw new Error("Missing required property 'ref'");
            }
            inputs["active"] = args ? args.active : undefined;
            inputs["cron"] = args ? args.cron : undefined;
            inputs["cronTimezone"] = args ? args.cronTimezone : undefined;
            inputs["description"] = args ? args.description : undefined;
            inputs["project"] = args ? args.project : undefined;
            inputs["ref"] = args ? args.ref : undefined;
        }
        if (!opts) {
            opts = {}
        }

        if (!opts.version) {
            opts.version = utilities.getVersion();
        }
        super(PipelineSchedule.__pulumiType, name, inputs, opts);
    }
}

/**
 * Input properties used for looking up and filtering PipelineSchedule resources.
 */
export interface PipelineScheduleState {
    /**
     * The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially.
     */
    readonly active?: pulumi.Input<boolean>;
    /**
     * The cron (e.g. `0 1 * * *`).
     */
    readonly cron?: pulumi.Input<string>;
    /**
     * The timezone.
     */
    readonly cronTimezone?: pulumi.Input<string>;
    /**
     * The description of the pipeline schedule.
     */
    readonly description?: pulumi.Input<string>;
    /**
     * The name or id of the project to add the schedule to.
     */
    readonly project?: pulumi.Input<string>;
    /**
     * The branch/tag name to be triggered.
     */
    readonly ref?: pulumi.Input<string>;
}

/**
 * The set of arguments for constructing a PipelineSchedule resource.
 */
export interface PipelineScheduleArgs {
    /**
     * The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially.
     */
    readonly active?: pulumi.Input<boolean>;
    /**
     * The cron (e.g. `0 1 * * *`).
     */
    readonly cron: pulumi.Input<string>;
    /**
     * The timezone.
     */
    readonly cronTimezone?: pulumi.Input<string>;
    /**
     * The description of the pipeline schedule.
     */
    readonly description: pulumi.Input<string>;
    /**
     * The name or id of the project to add the schedule to.
     */
    readonly project: pulumi.Input<string>;
    /**
     * The branch/tag name to be triggered.
     */
    readonly ref: pulumi.Input<string>;
}