PipelineSchedule

This resource allows you to create and manage pipeline schedules. For further information on clusters, consult the gitlab documentation.

Example Usage

using Pulumi;
using GitLab = Pulumi.GitLab;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new GitLab.PipelineSchedule("example", new GitLab.PipelineScheduleArgs
        {
            Cron = "0 1 * * *",
            Description = "Used to schedule builds",
            Project = "12345",
            Ref = "master",
        });
    }

}

Coming soon!

import pulumi
import pulumi_gitlab as gitlab

example = gitlab.PipelineSchedule("example",
    cron="0 1 * * *",
    description="Used to schedule builds",
    project="12345",
    ref="master")

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",
});

Create a PipelineSchedule Resource

new PipelineSchedule(name: string, args: PipelineScheduleArgs, opts?: CustomResourceOptions);

def PipelineSchedule(resource_name, opts=None, active=None, cron=None, cron_timezone=None, description=None, project=None, ref=None, __props__=None);

func NewPipelineSchedule(ctx *Context, name string, args PipelineScheduleArgs, opts ...ResourceOption) (*PipelineSchedule, error)

public PipelineSchedule(string name, PipelineScheduleArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args PipelineScheduleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args PipelineScheduleArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PipelineScheduleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

PipelineSchedule Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The PipelineSchedule resource accepts the following input properties:

Cron string: The cron (e.g. 0 1 * * *).
Description string: The description of the pipeline schedule.
Project string: The name or id of the project to add the schedule to.
Ref string: The branch/tag name to be triggered.
Active bool: The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially.
CronTimezone string: The timezone.

Cron string: The cron (e.g. 0 1 * * *).
Description string: The description of the pipeline schedule.
Project string: The name or id of the project to add the schedule to.
Ref string: The branch/tag name to be triggered.
Active bool: The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially.
CronTimezone string: The timezone.

cron string: The cron (e.g. 0 1 * * *).
description string: The description of the pipeline schedule.
project string: The name or id of the project to add the schedule to.
ref string: The branch/tag name to be triggered.
active boolean: The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially.
cronTimezone string: The timezone.

cron str: The cron (e.g. 0 1 * * *).
description str: The description of the pipeline schedule.
project str: The name or id of the project to add the schedule to.
ref str: The branch/tag name to be triggered.
active bool: The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially.
cron_timezone str: The timezone.

Outputs

All input properties are implicitly available as output properties. Additionally, the PipelineSchedule resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing PipelineSchedule Resource

Get an existing PipelineSchedule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: PipelineScheduleState, opts?: CustomResourceOptions): PipelineSchedule

static get(resource_name, id, opts=None, active=None, cron=None, cron_timezone=None, description=None, project=None, ref=None, __props__=None);

func GetPipelineSchedule(ctx *Context, name string, id IDInput, state *PipelineScheduleState, opts ...ResourceOption) (*PipelineSchedule, error)

public static PipelineSchedule Get(string name, Input<string> id, PipelineScheduleState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Active bool: The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially.
Cron string: The cron (e.g. 0 1 * * *).
CronTimezone string: The timezone.
Description string: The description of the pipeline schedule.
Project string: The name or id of the project to add the schedule to.
Ref string: The branch/tag name to be triggered.

Active bool: The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially.
Cron string: The cron (e.g. 0 1 * * *).
CronTimezone string: The timezone.
Description string: The description of the pipeline schedule.
Project string: The name or id of the project to add the schedule to.
Ref string: The branch/tag name to be triggered.

active boolean: The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially.
cron string: The cron (e.g. 0 1 * * *).
cronTimezone string: The timezone.
description string: The description of the pipeline schedule.
project string: The name or id of the project to add the schedule to.
ref string: The branch/tag name to be triggered.

active bool: The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially.
cron str: The cron (e.g. 0 1 * * *).
cron_timezone str: The timezone.
description str: The description of the pipeline schedule.
project str: The name or id of the project to add the schedule to.
ref str: The branch/tag name to be triggered.

Package Details

Repository: https://github.com/pulumi/pulumi-gitlab
License: Apache-2.0
Notes: This Pulumi package is based on the gitlab Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud