Class Project

Inheritance

System.Object

Resource

CustomResource

Project

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 Project : CustomResource

Constructors

View Source

Project(String, ProjectArgs, CustomResourceOptions)

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

Declaration

public Project(string name, ProjectArgs args = null, CustomResourceOptions options = null)

Parameters

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

Properties

View Source

ApprovalsBeforeMerge

Number of merge request approvals required for merging. Default is 0.

Declaration

public Output<int?> ApprovalsBeforeMerge { get; }

Property Value

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

View Source

Archived

Whether the project is in read-only mode (archived). Repositories can be archived/unarchived by toggling this parameter.

Declaration

public Output<bool?> Archived { get; }

Property Value

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

View Source

ContainerRegistryEnabled

Enable container registry for the project.

Declaration

public Output<bool?> ContainerRegistryEnabled { get; }

Property Value

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

View Source

DefaultBranch

The default branch for the project.

Declaration

public Output<string> DefaultBranch { get; }

Property Value

Type	Description
Output<System.String>

View Source

Description

A description of the project.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

View Source

HttpUrlToRepo

URL that can be provided to git clone to clone the repository via HTTP.

Declaration

public Output<string> HttpUrlToRepo { get; }

Property Value

Type	Description
Output<System.String>

View Source

InitializeWithReadme

Create master branch with first commit containing a README.md file.

Declaration

public Output<bool?> InitializeWithReadme { get; }

Property Value

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

View Source

IssuesEnabled

Enable issue tracking for the project.

Declaration

public Output<bool?> IssuesEnabled { get; }

Property Value

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

View Source

LfsEnabled

Enable LFS for the project.

Declaration

public Output<bool?> LfsEnabled { get; }

Property Value

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

View Source

MergeMethod

Set to ff to create fast-forward merges Valid values are merge, rebase_merge, ff Repositories are created with merge by default

Declaration

public Output<string> MergeMethod { get; }

Property Value

Type	Description
Output<System.String>

View Source

MergeRequestsEnabled

Enable merge requests for the project.

Declaration

public Output<bool?> MergeRequestsEnabled { get; }

Property Value

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

View Source

Name

The name of the project.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

View Source

NamespaceId

The namespace (group or user) of the project. Defaults to your user. See gitlab..Group for an example.

Declaration

public Output<int> NamespaceId { get; }

Property Value

Type	Description
Output<System.Int32>

View Source

OnlyAllowMergeIfAllDiscussionsAreResolved

Set to true if you want allow merges only if all discussions are resolved.

Declaration

public Output<bool?> OnlyAllowMergeIfAllDiscussionsAreResolved { get; }

Property Value

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

View Source

OnlyAllowMergeIfPipelineSucceeds

Set to true if you want allow merges only if a pipeline succeeds.

Declaration

public Output<bool?> OnlyAllowMergeIfPipelineSucceeds { get; }

Property Value

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

View Source

Path

The path of the repository.

Declaration

public Output<string> Path { get; }

Property Value

Type	Description
Output<System.String>

View Source

PipelinesEnabled

Enable pipelines for the project.

Declaration

public Output<bool?> PipelinesEnabled { get; }

Property Value

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

View Source

RequestAccessEnabled

Allow users to request member access.

Declaration

public Output<bool?> RequestAccessEnabled { get; }

Property Value

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

View Source

RunnersToken

Registration token to use during runner setup.

Declaration

public Output<string> RunnersToken { get; }

Property Value

Type	Description
Output<System.String>

View Source

SharedRunnersEnabled

Enable shared runners for this project.

Declaration

public Output<bool> SharedRunnersEnabled { get; }

Property Value

Type	Description
Output<System.Boolean>

View Source

SharedWithGroups

Enable sharing the project with a list of groups (maps).

Declaration

public Output<ImmutableArray<ProjectSharedWithGroup>> SharedWithGroups { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<ProjectSharedWithGroup>>

View Source

SnippetsEnabled

Enable snippets for the project.

Declaration

public Output<bool?> SnippetsEnabled { get; }

Property Value

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

View Source

SshUrlToRepo

URL that can be provided to git clone to clone the repository via SSH.

Declaration

public Output<string> SshUrlToRepo { get; }

Property Value

Type	Description
Output<System.String>

View Source

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

VisibilityLevel

Set to public to create a public project. Valid values are private, internal, public. Repositories are created as private by default.

Declaration

public Output<string> VisibilityLevel { get; }

Property Value

Type	Description
Output<System.String>

View Source

WebUrl

URL that can be used to find the project in a browser.

Declaration

public Output<string> WebUrl { get; }

Property Value

Type	Description
Output<System.String>

View Source

WikiEnabled

Enable wiki for the project.

Declaration

public Output<bool?> WikiEnabled { get; }

Property Value

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

Methods

View Source

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

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

Declaration

public static Project Get(string name, Input<string> id, ProjectState 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.
ProjectState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Project