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

}

Inheritance

System.Object

Resource

CustomResource

PipelineSchedule

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.GitLab

Assembly: Pulumi.GitLab.dll

Syntax

public class PipelineSchedule : CustomResource

Constructors

PipelineSchedule(String, PipelineScheduleArgs, CustomResourceOptions)

Create a PipelineSchedule resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
PipelineScheduleArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Active

The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially.

Declaration

public Output<bool?> Active { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Cron

The cron (e.g. 0 1 * * *).

Declaration

public Output<string> Cron { get; }

Property Value

Type	Description
Output<System.String>

CronTimezone

The timezone.

Declaration

public Output<string> CronTimezone { get; }

Property Value

Type	Description
Output<System.String>

Description

The description of the pipeline schedule.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

Project

The name or id of the project to add the schedule to.

Declaration

public Output<string> Project { get; }

Property Value

Type	Description
Output<System.String>

Ref

The branch/tag name to be triggered.

Declaration

public Output<string> Ref { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, PipelineScheduleState, CustomResourceOptions)

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

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
PipelineScheduleState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
PipelineSchedule