1. Docs
  2. Reference
  3. API
  4. @pulumi/gitlab

Package @pulumi/gitlab

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-gitlab repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-gitlab repo.

var gitlab = require("@pulumi/gitlab");

import * as gitlab from "@pulumi/gitlab";

Modules

Resources

Functions

Others

Resources

Resource BranchProtection

class BranchProtection extends CustomResource

This resource allows you to protect a specific branch by an access level so that the user with less access level cannot Merge/Push to the branch. GitLab EE features to protect by group or user are not supported.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const branchProtect = new gitlab.BranchProtection("BranchProtect", {
    branch: "BranchProtected",
    mergeAccessLevel: "developer",
    project: "12345",
    pushAccessLevel: "developer",
});

constructor

new BranchProtection(name: string, args: BranchProtectionArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: BranchProtectionState, opts?: pulumi.CustomResourceOptions): BranchProtection

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is BranchProtection

Returns true if the given object is an instance of BranchProtection. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property branch

public branch: pulumi.Output<string>;

Name of the branch.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property mergeAccessLevel

public mergeAccessLevel: pulumi.Output<string>;

One of five levels of access to the project.

property project

public project: pulumi.Output<string>;

The id of the project.

property pushAccessLevel

public pushAccessLevel: pulumi.Output<string>;

One of five levels of access to the project.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource DeployKey

class DeployKey extends CustomResource

This resource allows you to create and manage deploy keys for your GitLab projects.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const example = new gitlab.DeployKey("example", {
    key: "ssh-rsa AAAA...",
    project: "example/deploying",
    title: "Example deploy key",
});

constructor

new DeployKey(name: string, args: DeployKeyArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DeployKeyState, opts?: pulumi.CustomResourceOptions): DeployKey

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is DeployKey

Returns true if the given object is an instance of DeployKey. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property canPush

public canPush: pulumi.Output<boolean | undefined>;

Allow this deploy key to be used to push changes to the project. Defaults to false. NOTE:: this cannot currently be managed.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property key

public key: pulumi.Output<string>;

The public ssh key body.

property project

public project: pulumi.Output<string>;

The name or id of the project to add the deploy key to.

property title

public title: pulumi.Output<string>;

A title to describe the deploy key with.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource DeployKeyEnable

class DeployKeyEnable extends CustomResource

This resource allows you to enable pre-existing deploy keys for your GitLab projects.

the GITLAB KEY_ID for the deploy key must be known

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

// A repo to host the deployment key
const parentProject = new gitlab.Project("parent", {});
// A second repo to use the deployment key from the parent project
const fooProject = new gitlab.Project("foo", {});
// Upload a deployment key for the parent repo
const parentDeployKey = new gitlab.DeployKey("parent", {
    key: "ssh-rsa AAAA...",
    project: parentProject.id,
    title: "Example deploy key",
});
// Enable the deployment key on the second repo
const fooDeployKeyEnable = new gitlab.DeployKeyEnable("foo", {
    keyId: parentDeployKey.id,
    project: fooProject.id,
});

constructor

new DeployKeyEnable(name: string, args: DeployKeyEnableArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DeployKeyEnableState, opts?: pulumi.CustomResourceOptions): DeployKeyEnable

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is DeployKeyEnable

Returns true if the given object is an instance of DeployKeyEnable. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property canPush

public canPush: pulumi.Output<boolean>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property key

public key: pulumi.Output<string>;

property keyId

public keyId: pulumi.Output<string>;

The Gitlab key id for the pre-existing deploy key

property project

public project: pulumi.Output<string>;

The name or id of the project to add the deploy key to.

property title

public title: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource DeployToken

class DeployToken extends CustomResource

This resource allows you to create and manage deploy token for your GitLab projects and groups.

Example Usage - Project

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const example = new gitlab.DeployToken("example", {
    expiresAt: "2020-03-14T00:00:00.000Z",
    project: "example/deploying",
    scopes: [
        "readRepository",
        "readRegistry",
    ],
    username: "example-username",
});

Example Usage - Group

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const example = new gitlab.DeployToken("example", {
    group: "example/deploying",
    scopes: ["readRepository"],
});

constructor

new DeployToken(name: string, args: DeployTokenArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DeployTokenState, opts?: pulumi.CustomResourceOptions): DeployToken

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is DeployToken

Returns true if the given object is an instance of DeployToken. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property expiresAt

public expiresAt: pulumi.Output<string | undefined>;

property group

public group: pulumi.Output<string | undefined>;

The name or id of the group to add the deploy token to. Either project or group must be set.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

A name to describe the deploy token with.

property project

public project: pulumi.Output<string | undefined>;

The name or id of the project to add the deploy token to. Either project or group must be set.

property scopes

public scopes: pulumi.Output<string[]>;

Valid values: readRepository, readRegistry.

property token

public token: pulumi.Output<string>;

The secret token. This is only populated when creating a new deploy token.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property username

public username: pulumi.Output<string>;

A username for the deploy token. Default is gitlab+deploy-token-{n}.

Resource Group

class Group extends CustomResource

constructor

new Group(name: string, args: GroupArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GroupState, opts?: pulumi.CustomResourceOptions): Group

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Group

Returns true if the given object is an instance of Group. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

The description of the group.

property fullName

public fullName: pulumi.Output<string>;

The full name of the group.

property fullPath

public fullPath: pulumi.Output<string>;

The full path of the group.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property lfsEnabled

public lfsEnabled: pulumi.Output<boolean | undefined>;

Boolean, defaults to true. Whether to enable LFS support for projects in this group.

property name

public name: pulumi.Output<string>;

The name of this group.

property parentId

public parentId: pulumi.Output<number | undefined>;

Integer, id of the parent group (creates a nested group).

property path

public path: pulumi.Output<string>;

The path of the group.

property requestAccessEnabled

public requestAccessEnabled: pulumi.Output<boolean | undefined>;

Boolean, defaults to false. Whether to enable users to request access to the group.

property runnersToken

public runnersToken: pulumi.Output<string>;

The group level registration token to use during runner setup.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property visibilityLevel

public visibilityLevel: pulumi.Output<string>;

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

property webUrl

public webUrl: pulumi.Output<string>;

Web URL of the group.

Resource GroupCluster

class GroupCluster extends CustomResource

This resource allows you to create and manage group clusters for your GitLab groups. For further information on clusters, consult the gitlab documentation.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const foo = new gitlab.Group("foo", {
    path: "foo-path",
});
const bar = new gitlab.GroupCluster("bar", {
    domain: "example.com",
    enabled: true,
    environmentScope: "*",
    group: foo.id,
    kubernetesApiUrl: "https://124.124.124",
    kubernetesAuthorizationType: "rbac",
    kubernetesCaCert: "some-cert",
    kubernetesToken: "some-token",
    managementClusterId: "123456",
});

constructor

new GroupCluster(name: string, args: GroupClusterArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GroupClusterState, opts?: pulumi.CustomResourceOptions): GroupCluster

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is GroupCluster

Returns true if the given object is an instance of GroupCluster. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property clusterType

public clusterType: pulumi.Output<string>;

property createdAt

public createdAt: pulumi.Output<string>;

property domain

public domain: pulumi.Output<string | undefined>;

The base domain of the cluster.

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Determines if cluster is active or not. Defaults to true. This attribute cannot be read.

property environmentScope

public environmentScope: pulumi.Output<string | undefined>;

The associated environment to the cluster. Defaults to *.

property group

public group: pulumi.Output<string>;

The id of the group to add the cluster to.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kubernetesApiUrl

public kubernetesApiUrl: pulumi.Output<string>;

The URL to access the Kubernetes API.

property kubernetesAuthorizationType

public kubernetesAuthorizationType: pulumi.Output<string | undefined>;

The cluster authorization type. Valid values are rbac, abac, unknownAuthorization. Defaults to rbac.

property kubernetesCaCert

public kubernetesCaCert: pulumi.Output<string | undefined>;

TLS certificate (needed if API is using a self-signed TLS certificate).

property kubernetesToken

public kubernetesToken: pulumi.Output<string>;

The token to authenticate against Kubernetes.

property managed

public managed: pulumi.Output<boolean | undefined>;

Determines if cluster is managed by gitlab or not. Defaults to true. This attribute cannot be read.

property managementProjectId

public managementProjectId: pulumi.Output<string | undefined>;

property name

public name: pulumi.Output<string>;

The name of cluster.

property platformType

public platformType: pulumi.Output<string>;

property providerType

public providerType: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource GroupLabel

class GroupLabel extends CustomResource

This resource allows you to create and manage labels for your GitLab groups. For further information on labels, consult the gitlab documentation.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const fixme = new gitlab.GroupLabel("fixme", {
    color: "#ffcc00",
    description: "issue with failing tests",
    group: "example",
});

constructor

new GroupLabel(name: string, args: GroupLabelArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GroupLabelState, opts?: pulumi.CustomResourceOptions): GroupLabel

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is GroupLabel

Returns true if the given object is an instance of GroupLabel. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property color

public color: pulumi.Output<string>;

The color of the label given in 6-digit hex notation with leading ‘#’ sign (e.g. #FFAABB) or one of the CSS color names.

property description

public description: pulumi.Output<string | undefined>;

The description of the label.

property group

public group: pulumi.Output<string>;

The name or id of the group to add the label to.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the label.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class GroupLdapLink extends CustomResource

This resource allows you to add an LDAP link to an existing GitLab group.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const test = new gitlab.GroupLdapLink("test", {
    accessLevel: "developer",
    cn: "testuser",
    groupId: "12345",
    ldapProvider: "ldapmain",
});
new GroupLdapLink(name: string, args: GroupLdapLinkArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GroupLdapLinkState, opts?: pulumi.CustomResourceOptions): GroupLdapLink

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

getProvider(moduleMember: string): ProviderResource | undefined
public static isInstance(obj: any): obj is GroupLdapLink

Returns true if the given object is an instance of GroupLdapLink. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

public accessLevel: pulumi.Output<string>;

Acceptable values are: guest, reporter, developer, maintainer, owner.

public cn: pulumi.Output<string>;

The CN of the LDAP group to link with.

public force: pulumi.Output<boolean | undefined>;
public groupId: pulumi.Output<string>;

The id of the GitLab group.

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

public ldapProvider: pulumi.Output<string>;

The name of the LDAP provider as stored in the GitLab database.

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource GroupMembership

class GroupMembership extends CustomResource

This resource allows you to add a user to an existing group.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const test = new gitlab.GroupMembership("test", {
    accessLevel: "guest",
    expiresAt: "2020-12-31",
    groupId: "12345",
    userId: 1337,
});

constructor

new GroupMembership(name: string, args: GroupMembershipArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GroupMembershipState, opts?: pulumi.CustomResourceOptions): GroupMembership

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is GroupMembership

Returns true if the given object is an instance of GroupMembership. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accessLevel

public accessLevel: pulumi.Output<string>;

Acceptable values are: guest, reporter, developer, maintainer, owner.

property expiresAt

public expiresAt: pulumi.Output<string | undefined>;

Expiration date for the group membership. Format: YYYY-MM-DD

property groupId

public groupId: pulumi.Output<string>;

The id of the group.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userId

public userId: pulumi.Output<number>;

The id of the user.

Resource GroupVariable

class GroupVariable extends CustomResource

This resource allows you to create and manage CI/CD variables for your GitLab groups. For further information on variables, consult the gitlab documentation.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const example = new gitlab.GroupVariable("example", {
    group: "12345",
    key: "groupVariableKey",
    masked: false,
    protected: false,
    value: "groupVariableValue",
});

constructor

new GroupVariable(name: string, args: GroupVariableArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GroupVariableState, opts?: pulumi.CustomResourceOptions): GroupVariable

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is GroupVariable

Returns true if the given object is an instance of GroupVariable. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property group

public group: pulumi.Output<string>;

The name or id of the group to add the hook to.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property key

public key: pulumi.Output<string>;

The name of the variable.

property masked

public masked: pulumi.Output<boolean | undefined>;

property protected

public protected: pulumi.Output<boolean | undefined>;

If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property value

public value: pulumi.Output<string>;

The value of the variable.

property variableType

public variableType: pulumi.Output<string | undefined>;

The type of a variable. Available types are: envVar (default) and file.

Resource Label

class Label extends CustomResource

This resource allows you to create and manage labels for your GitLab projects. For further information on labels, consult the gitlab documentation.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const fixme = new gitlab.Label("fixme", {
    color: "#ffcc00",
    description: "issue with failing tests",
    project: "example",
});

constructor

new Label(name: string, args: LabelArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: LabelState, opts?: pulumi.CustomResourceOptions): Label

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Label

Returns true if the given object is an instance of Label. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property color

public color: pulumi.Output<string>;

The color of the label given in 6-digit hex notation with leading ‘#’ sign (e.g. #FFAABB) or one of the CSS color names.

property description

public description: pulumi.Output<string | undefined>;

The description of the label.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the label.

property project

public project: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource PipelineSchedule

class PipelineSchedule extends CustomResource

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

Example Usage

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

constructor

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

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

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

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is 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.

property active

public active: pulumi.Output<boolean | undefined>;

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

property cron

public cron: pulumi.Output<string>;

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

property cronTimezone

public cronTimezone: pulumi.Output<string | undefined>;

The timezone.

property description

public description: pulumi.Output<string>;

The description of the pipeline schedule.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property project

public project: pulumi.Output<string>;

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

property ref

public ref: pulumi.Output<string>;

The branch/tag name to be triggered.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource PipelineScheduleVariable

class PipelineScheduleVariable extends CustomResource

This resource allows you to create and manage variables for pipeline schedules.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const examplePipelineSchedule = new gitlab.PipelineSchedule("examplePipelineSchedule", {
    project: "12345",
    description: "Used to schedule builds",
    ref: "master",
    cron: "0 1 * * *",
});
const examplePipelineScheduleVariable = new gitlab.PipelineScheduleVariable("examplePipelineScheduleVariable", {
    project: gitlab_pipeline_schedule.project,
    pipelineScheduleId: gitlab_pipeline_schedule.id,
    key: "EXAMPLE_KEY",
    value: "example",
});

constructor

new PipelineScheduleVariable(name: string, args: PipelineScheduleVariableArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PipelineScheduleVariableState, opts?: pulumi.CustomResourceOptions): PipelineScheduleVariable

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is PipelineScheduleVariable

Returns true if the given object is an instance of PipelineScheduleVariable. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property key

public key: pulumi.Output<string>;

Name of the variable.

property pipelineScheduleId

public pipelineScheduleId: pulumi.Output<number>;

The id of the pipeline schedule.

property project

public project: pulumi.Output<string>;

The id of the project to add the schedule to.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property value

public value: pulumi.Output<string>;

Value of the variable.

Resource PipelineTrigger

class PipelineTrigger extends CustomResource

This resource allows you to create and manage pipeline triggers

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const example = new gitlab.PipelineTrigger("example", {
    description: "Used to trigger builds",
    project: "12345",
});

constructor

new PipelineTrigger(name: string, args: PipelineTriggerArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PipelineTriggerState, opts?: pulumi.CustomResourceOptions): PipelineTrigger

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is PipelineTrigger

Returns true if the given object is an instance of PipelineTrigger. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string>;

The description of the pipeline trigger.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property project

public project: pulumi.Output<string>;

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

property token

public token: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Project

class Project extends CustomResource

constructor

new Project(name: string, args?: ProjectArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProjectState, opts?: pulumi.CustomResourceOptions): Project

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Project

Returns true if the given object is an instance of Project. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property approvalsBeforeMerge

public approvalsBeforeMerge: pulumi.Output<number | undefined>;

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

property archived

public archived: pulumi.Output<boolean | undefined>;

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

property containerRegistryEnabled

public containerRegistryEnabled: pulumi.Output<boolean | undefined>;

Enable container registry for the project.

property defaultBranch

public defaultBranch: pulumi.Output<string | undefined>;

The default branch for the project.

property description

public description: pulumi.Output<string | undefined>;

A description of the project.

property httpUrlToRepo

public httpUrlToRepo: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property initializeWithReadme

public initializeWithReadme: pulumi.Output<boolean | undefined>;

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

property issuesEnabled

public issuesEnabled: pulumi.Output<boolean | undefined>;

Enable issue tracking for the project.

property lfsEnabled

public lfsEnabled: pulumi.Output<boolean | undefined>;

Enable LFS for the project.

property mergeMethod

public mergeMethod: pulumi.Output<string | undefined>;

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

property mergeRequestsEnabled

public mergeRequestsEnabled: pulumi.Output<boolean | undefined>;

Enable merge requests for the project.

property name

public name: pulumi.Output<string>;

The name of the project.

property namespaceId

public namespaceId: pulumi.Output<number>;

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

property onlyAllowMergeIfAllDiscussionsAreResolved

public onlyAllowMergeIfAllDiscussionsAreResolved: pulumi.Output<boolean | undefined>;

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

property onlyAllowMergeIfPipelineSucceeds

public onlyAllowMergeIfPipelineSucceeds: pulumi.Output<boolean | undefined>;

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

property path

public path: pulumi.Output<string | undefined>;

The path of the repository.

property pipelinesEnabled

public pipelinesEnabled: pulumi.Output<boolean | undefined>;

Enable pipelines for the project.

property requestAccessEnabled

public requestAccessEnabled: pulumi.Output<boolean | undefined>;

Allow users to request member access.

property runnersToken

public runnersToken: pulumi.Output<string>;

Registration token to use during runner setup.

property sharedRunnersEnabled

public sharedRunnersEnabled: pulumi.Output<boolean>;

Enable shared runners for this project.

property sharedWithGroups

public sharedWithGroups: pulumi.Output<ProjectSharedWithGroup[] | undefined>;

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

property snippetsEnabled

public snippetsEnabled: pulumi.Output<boolean | undefined>;

Enable snippets for the project.

property sshUrlToRepo

public sshUrlToRepo: pulumi.Output<string>;

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

property tags

public tags: pulumi.Output<string[] | undefined>;

Tags (topics) of the project.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property visibilityLevel

public visibilityLevel: pulumi.Output<string | undefined>;

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

property webUrl

public webUrl: pulumi.Output<string>;

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

property wikiEnabled

public wikiEnabled: pulumi.Output<boolean | undefined>;

Enable wiki for the project.

Resource ProjectCluster

class ProjectCluster extends CustomResource

This resource allows you to create and manage project clusters for your GitLab projects. For further information on clusters, consult the gitlab documentation.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const foo = new gitlab.Project("foo", {});
const bar = new gitlab.ProjectCluster("bar", {
    domain: "example.com",
    enabled: true,
    environmentScope: "*",
    kubernetesApiUrl: "https://124.124.124",
    kubernetesAuthorizationType: "rbac",
    kubernetesCaCert: "some-cert",
    kubernetesNamespace: "namespace",
    kubernetesToken: "some-token",
    managementClusterId: "123456",
    project: foo.id,
});

constructor

new ProjectCluster(name: string, args: ProjectClusterArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProjectClusterState, opts?: pulumi.CustomResourceOptions): ProjectCluster

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ProjectCluster

Returns true if the given object is an instance of ProjectCluster. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property clusterType

public clusterType: pulumi.Output<string>;

property createdAt

public createdAt: pulumi.Output<string>;

property domain

public domain: pulumi.Output<string | undefined>;

The base domain of the cluster.

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Determines if cluster is active or not. Defaults to true. This attribute cannot be read.

property environmentScope

public environmentScope: pulumi.Output<string | undefined>;

The associated environment to the cluster. Defaults to *.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kubernetesApiUrl

public kubernetesApiUrl: pulumi.Output<string>;

The URL to access the Kubernetes API.

property kubernetesAuthorizationType

public kubernetesAuthorizationType: pulumi.Output<string | undefined>;

The cluster authorization type. Valid values are rbac, abac, unknownAuthorization. Defaults to rbac.

property kubernetesCaCert

public kubernetesCaCert: pulumi.Output<string | undefined>;

TLS certificate (needed if API is using a self-signed TLS certificate).

property kubernetesNamespace

public kubernetesNamespace: pulumi.Output<string | undefined>;

The unique namespace related to the project.

property kubernetesToken

public kubernetesToken: pulumi.Output<string>;

The token to authenticate against Kubernetes.

property managed

public managed: pulumi.Output<boolean | undefined>;

Determines if cluster is managed by gitlab or not. Defaults to true. This attribute cannot be read.

property managementProjectId

public managementProjectId: pulumi.Output<string | undefined>;

property name

public name: pulumi.Output<string>;

The name of cluster.

property platformType

public platformType: pulumi.Output<string>;

property project

public project: pulumi.Output<string>;

The id of the project to add the cluster to.

property providerType

public providerType: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ProjectHook

class ProjectHook extends CustomResource

This resource allows you to create and manage hooks for your GitLab projects. For further information on hooks, consult the gitlab documentation.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const example = new gitlab.ProjectHook("example", {
    mergeRequestsEvents: true,
    project: "example/hooked",
    url: "https://example.com/hook/example",
});

constructor

new ProjectHook(name: string, args: ProjectHookArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProjectHookState, opts?: pulumi.CustomResourceOptions): ProjectHook

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ProjectHook

Returns true if the given object is an instance of ProjectHook. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property enableSslVerification

public enableSslVerification: pulumi.Output<boolean | undefined>;

Enable ssl verification when invoking the hook.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property issuesEvents

public issuesEvents: pulumi.Output<boolean | undefined>;

Invoke the hook for issues events.

property jobEvents

public jobEvents: pulumi.Output<boolean | undefined>;

Invoke the hook for job events.

property mergeRequestsEvents

public mergeRequestsEvents: pulumi.Output<boolean | undefined>;

Invoke the hook for merge requests.

property noteEvents

public noteEvents: pulumi.Output<boolean | undefined>;

Invoke the hook for notes events.

property pipelineEvents

public pipelineEvents: pulumi.Output<boolean | undefined>;

Invoke the hook for pipeline events.

property project

public project: pulumi.Output<string>;

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

property pushEvents

public pushEvents: pulumi.Output<boolean | undefined>;

Invoke the hook for push events.

property tagPushEvents

public tagPushEvents: pulumi.Output<boolean | undefined>;

Invoke the hook for tag push events.

property token

public token: pulumi.Output<string | undefined>;

A token to present when invoking the hook.

property url

public url: pulumi.Output<string>;

The url of the hook to invoke.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property wikiPageEvents

public wikiPageEvents: pulumi.Output<boolean | undefined>;

Invoke the hook for wiki page events.

Resource ProjectMembership

class ProjectMembership extends CustomResource

This resource allows you to add a current user to an existing project with a set access level.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const test = new gitlab.ProjectMembership("test", {
    accessLevel: "guest",
    projectId: "12345",
    userId: 1337,
});

constructor

new ProjectMembership(name: string, args: ProjectMembershipArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProjectMembershipState, opts?: pulumi.CustomResourceOptions): ProjectMembership

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ProjectMembership

Returns true if the given object is an instance of ProjectMembership. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accessLevel

public accessLevel: pulumi.Output<string>;

One of five levels of access to the project.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property projectId

public projectId: pulumi.Output<string>;

The id of the project.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userId

public userId: pulumi.Output<number>;

The id of the user.

Resource ProjectPushRules

class ProjectPushRules extends CustomResource

This resource allows you to create and manage push rules for your GitLab projects. For further information on push rules, consult the gitlab documentation.

constructor

new ProjectPushRules(name: string, args: ProjectPushRulesArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProjectPushRulesState, opts?: pulumi.CustomResourceOptions): ProjectPushRules

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ProjectPushRules

Returns true if the given object is an instance of ProjectPushRules. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property authorEmailRegex

public authorEmailRegex: pulumi.Output<string | undefined>;

All commit author emails must match this regex, e.g. “@my-company.com$”

property branchNameRegex

public branchNameRegex: pulumi.Output<string | undefined>;

All branch names must match this regex, e.g. “(feature|hotfix)\/*”

property commitMessageRegex

public commitMessageRegex: pulumi.Output<string | undefined>;

All commit messages must match this regex, e.g. “Fixed \d+..*”

property denyDeleteTag

public denyDeleteTag: pulumi.Output<boolean | undefined>;

Deny deleting a tag

property fileNameRegex

public fileNameRegex: pulumi.Output<string | undefined>;

All commited filenames must not match this regex, e.g. “(jar|exe)$”

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property maxFileSize

public maxFileSize: pulumi.Output<number | undefined>;

Maximum file size (MB)

property memberCheck

public memberCheck: pulumi.Output<boolean | undefined>;

Restrict commits by author (email) to existing GitLab users

property preventSecrets

public preventSecrets: pulumi.Output<boolean | undefined>;

GitLab will reject any files that are likely to contain secrets

property project

public project: pulumi.Output<string>;

The name or id of the project to add the push rules to.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ProjectShareGroup

class ProjectShareGroup extends CustomResource

This resource allows you to share a project with a group

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const test = new gitlab.ProjectShareGroup("test", {
    accessLevel: "guest",
    groupId: 1337,
    projectId: "12345",
});

constructor

new ProjectShareGroup(name: string, args: ProjectShareGroupArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProjectShareGroupState, opts?: pulumi.CustomResourceOptions): ProjectShareGroup

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ProjectShareGroup

Returns true if the given object is an instance of ProjectShareGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accessLevel

public accessLevel: pulumi.Output<string>;

One of five levels of access to the project.

property groupId

public groupId: pulumi.Output<number>;

The id of the group.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property projectId

public projectId: pulumi.Output<string>;

The id of the project.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ProjectVariable

class ProjectVariable extends CustomResource

This resource allows you to create and manage CI/CD variables for your GitLab projects. For further information on variables, consult the gitlab documentation.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const example = new gitlab.ProjectVariable("example", {
    key: "projectVariableKey",
    project: "12345",
    protected: false,
    value: "projectVariableValue",
});

constructor

new ProjectVariable(name: string, args: ProjectVariableArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProjectVariableState, opts?: pulumi.CustomResourceOptions): ProjectVariable

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ProjectVariable

Returns true if the given object is an instance of ProjectVariable. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property environmentScope

public environmentScope: pulumi.Output<string | undefined>;

The environmentScope of the variable

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property key

public key: pulumi.Output<string>;

The name of the variable.

property masked

public masked: pulumi.Output<boolean | undefined>;

If set to true, the variable will be masked if it would have been written to the logs. Defaults to false.

property project

public project: pulumi.Output<string>;

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

property protected

public protected: pulumi.Output<boolean | undefined>;

If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property value

public value: pulumi.Output<string>;

The value of the variable.

property variableType

public variableType: pulumi.Output<string | undefined>;

The type of a variable. Available types are: envVar (default) and file.

Resource Provider

class Provider extends ProviderResource

The provider type for the gitlab package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

constructor

new Provider(name: string, args?: ProviderArgs, opts?: pulumi.ResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Provider

Returns true if the given object is an instance of Provider. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

method register

static register(provider: ProviderResource | undefined): Promise<string | undefined>

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ServiceJira

class ServiceJira extends CustomResource

This resource allows you to manage Jira integration.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const awesomeProject = new gitlab.Project("awesomeProject", {
    description: "My awesome project.",
    visibilityLevel: "public",
});
const jira = new gitlab.ServiceJira("jira", {
    password: "mypass",
    project: awesomeProject.id,
    url: "https://jira.example.com",
    username: "user",
});

constructor

new ServiceJira(name: string, args: ServiceJiraArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServiceJiraState, opts?: pulumi.CustomResourceOptions): ServiceJira

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ServiceJira

Returns true if the given object is an instance of ServiceJira. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property active

public active: pulumi.Output<boolean>;

property commentOnEventEnabled

public commentOnEventEnabled: pulumi.Output<boolean>;

Enable comments inside Jira issues on each GitLab event (commit / merge request)

property commitEvents

public commitEvents: pulumi.Output<boolean>;

Enable notifications for commit events

property createdAt

public createdAt: pulumi.Output<string>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property jiraIssueTransitionId

public jiraIssueTransitionId: pulumi.Output<string | undefined>;

The ID of a transition that moves issues to a closed state. You can find this number under the JIRA workflow administration (Administration > Issues > Workflows) by selecting View under Operations of the desired workflow of your project. By default, this ID is set to 2.

property mergeRequestsEvents

public mergeRequestsEvents: pulumi.Output<boolean>;

Enable notifications for merge request events

property password

public password: pulumi.Output<string>;

The password of the user created to be used with GitLab/JIRA.

property project

public project: pulumi.Output<string>;

ID of the project you want to activate integration on.

property projectKey

public projectKey: pulumi.Output<string | undefined>;

The short identifier for your JIRA project, all uppercase, e.g., PROJ.

property title

public title: pulumi.Output<string>;

property updatedAt

public updatedAt: pulumi.Output<string>;

property url

public url: pulumi.Output<string>;

The URL to the JIRA project which is being linked to this GitLab project. For example, https://jira.example.com.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property username

public username: pulumi.Output<string>;

The username of the user created to be used with GitLab/JIRA.

Resource ServiceSlack

class ServiceSlack extends CustomResource

This resource allows you to manage Slack notifications integration.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const awesomeProject = new gitlab.Project("awesomeProject", {
    description: "My awesome project.",
    visibilityLevel: "public",
});
const slack = new gitlab.ServiceSlack("slack", {
    project: awesomeProject.id,
    pushChannel: "pushChan",
    pushEvents: true,
    username: "myuser",
    webhook: "https://webhook.com",
});

constructor

new ServiceSlack(name: string, args: ServiceSlackArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServiceSlackState, opts?: pulumi.CustomResourceOptions): ServiceSlack

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ServiceSlack

Returns true if the given object is an instance of ServiceSlack. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property branchesToBeNotified

public branchesToBeNotified: pulumi.Output<string>;

Branches to send notifications for. Valid options are “all”, “default”, “protected”, and “defaultAndProtected”.

property confidentialIssueChannel

public confidentialIssueChannel: pulumi.Output<string | undefined>;

The name of the channel to receive confidential issue events notifications.

property confidentialIssuesEvents

public confidentialIssuesEvents: pulumi.Output<boolean>;

Enable notifications for confidential issues events.

property confidentialNoteEvents

public confidentialNoteEvents: pulumi.Output<boolean>;

Enable notifications for confidential note events.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property issueChannel

public issueChannel: pulumi.Output<string | undefined>;

The name of the channel to receive issue events notifications.

property issuesEvents

public issuesEvents: pulumi.Output<boolean>;

Enable notifications for issues events.

property jobEvents

public jobEvents: pulumi.Output<boolean>;

property mergeRequestChannel

public mergeRequestChannel: pulumi.Output<string | undefined>;

The name of the channel to receive merge request events notifications.

property mergeRequestsEvents

public mergeRequestsEvents: pulumi.Output<boolean>;

Enable notifications for merge requests events.

property noteChannel

public noteChannel: pulumi.Output<string | undefined>;

The name of the channel to receive note events notifications.

property noteEvents

public noteEvents: pulumi.Output<boolean>;

Enable notifications for note events.

property notifyOnlyBrokenPipelines

public notifyOnlyBrokenPipelines: pulumi.Output<boolean>;

Send notifications for broken pipelines.

property notifyOnlyDefaultBranch

public notifyOnlyDefaultBranch: pulumi.Output<boolean>;

DEPRECATED: This parameter has been replaced with branchesToBeNotified.

property pipelineChannel

public pipelineChannel: pulumi.Output<string | undefined>;

The name of the channel to receive pipeline events notifications.

property pipelineEvents

public pipelineEvents: pulumi.Output<boolean>;

Enable notifications for pipeline events.

property project

public project: pulumi.Output<string>;

ID of the project you want to activate integration on.

property pushChannel

public pushChannel: pulumi.Output<string | undefined>;

The name of the channel to receive push events notifications.

property pushEvents

public pushEvents: pulumi.Output<boolean>;

Enable notifications for push events.

property tagPushChannel

public tagPushChannel: pulumi.Output<string | undefined>;

The name of the channel to receive tag push events notifications.

property tagPushEvents

public tagPushEvents: pulumi.Output<boolean>;

Enable notifications for tag push events.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property username

public username: pulumi.Output<string | undefined>;

Username to use.

property webhook

public webhook: pulumi.Output<string>;

Webhook URL (ex.: https://hooks.slack.com/services/...)

property wikiPageChannel

public wikiPageChannel: pulumi.Output<string | undefined>;

The name of the channel to receive wiki page events notifications.

property wikiPageEvents

public wikiPageEvents: pulumi.Output<boolean>;

Enable notifications for wiki page events.

Resource TagProtection

class TagProtection extends CustomResource

This resource allows you to protect a specific tag or wildcard by an access level so that the user with less access level cannot Create the tags.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const tagProtect = new gitlab.TagProtection("TagProtect", {
    createAccessLevel: "developer",
    project: "12345",
    tag: "TagProtected",
});

constructor

new TagProtection(name: string, args: TagProtectionArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TagProtectionState, opts?: pulumi.CustomResourceOptions): TagProtection

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is TagProtection

Returns true if the given object is an instance of TagProtection. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property createAccessLevel

public createAccessLevel: pulumi.Output<string>;

One of five levels of access to the project.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property project

public project: pulumi.Output<string>;

The id of the project.

property tag

public tag: pulumi.Output<string>;

Name of the tag or wildcard.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource User

class User extends CustomResource

constructor

new User(name: string, args: UserArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: UserState, opts?: pulumi.CustomResourceOptions): User

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is User

Returns true if the given object is an instance of User. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property canCreateGroup

public canCreateGroup: pulumi.Output<boolean | undefined>;

Boolean, defaults to false. Whether to allow the user to create groups.

property email

public email: pulumi.Output<string>;

The e-mail address of the user.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property isAdmin

public isAdmin: pulumi.Output<boolean | undefined>;

Boolean, defaults to false. Whether to enable administrative priviledges for the user.

property isExternal

public isExternal: pulumi.Output<boolean | undefined>;

Boolean, defaults to false. Whether a user has access only to some internal or private projects. External users can only access projects to which they are explicitly granted access.

property name

public name: pulumi.Output<string>;

The name of the user.

property password

public password: pulumi.Output<string>;

The password of the user.

property projectsLimit

public projectsLimit: pulumi.Output<number | undefined>;

Integer, defaults to 0. Number of projects user can create.

property resetPassword

public resetPassword: pulumi.Output<boolean | undefined>;

Boolean, defaults to false. Send user password reset link.

property skipConfirmation

public skipConfirmation: pulumi.Output<boolean | undefined>;

Boolean, defaults to true. Whether to skip confirmation.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property username

public username: pulumi.Output<string>;

The username of the user.

Functions

Function getGroup

getGroup(args?: GetGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetGroupResult>

Provides details about a specific group in the gitlab provider.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const foo = pulumi.output(gitlab.getGroup({
    groupId: 123,
}, { async: true }));

Function getProject

getProject(args: GetProjectArgs, opts?: pulumi.InvokeOptions): Promise<GetProjectResult>

Provides details about a specific project in the gitlab provider. The results include the name of the project, path, description, default branch, etc.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const example = pulumi.output(gitlab.getProject({
    id: 30,
}, { async: true }));

Function getProjects

getProjects(args?: GetProjectsArgs, opts?: pulumi.InvokeOptions): Promise<GetProjectsResult>

Provides details about a list of projects in the Gitlab provider. Listing all projects and group projects with project filtering or group project filtering is supported.

NOTE: This data source supports all available filters exposed by the xanzy/go-gitlab package, which might not expose all available filters exposed by the Gitlab APIs.

Example Usage

List projects within a group tree
import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const mygroup = gitlab.getGroup({
    fullPath: "mygroup",
});
const groupProjects = mygroup.then(mygroup => gitlab.getProjects({
    groupId: mygroup.id,
    orderBy: "name",
    includeSubgroups: true,
    withShared: false,
}));
List projects using the search syntax
import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const projects = pulumi.output(gitlab.getProjects({
    search: "postgresql",
    visibility: "private",
}, { async: true }));

Function getUser

getUser(args?: GetUserArgs, opts?: pulumi.InvokeOptions): Promise<GetUserResult>

Provides details about a specific user in the gitlab provider. Especially the ability to lookup the id for linking to other resources.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const example = pulumi.output(gitlab.getUser({
    username: "myuser",
}, { async: true }));

Function getUsers

getUsers(args?: GetUsersArgs, opts?: pulumi.InvokeOptions): Promise<GetUsersResult>

Provides details about a list of users in the gitlab provider. The results include id, username, email, name and more about the requested users. Users can also be sorted and filtered using several options.

NOTE: Some of the available options require administrator privileges. Please visit [Gitlab API documentation][usersForAdmins] for more information.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const example = pulumi.output(gitlab.getUsers({
    createdBefore: "2019-01-01",
    orderBy: "name",
    sort: "desc",
}, { async: true }));

Others

interface BranchProtectionArgs

interface BranchProtectionArgs

The set of arguments for constructing a BranchProtection resource.

property branch

branch: pulumi.Input<string>;

Name of the branch.

property mergeAccessLevel

mergeAccessLevel: pulumi.Input<string>;

One of five levels of access to the project.

property project

project: pulumi.Input<string>;

The id of the project.

property pushAccessLevel

pushAccessLevel: pulumi.Input<string>;

One of five levels of access to the project.

interface BranchProtectionState

interface BranchProtectionState

Input properties used for looking up and filtering BranchProtection resources.

property branch

branch?: pulumi.Input<string>;

Name of the branch.

property mergeAccessLevel

mergeAccessLevel?: pulumi.Input<string>;

One of five levels of access to the project.

property project

project?: pulumi.Input<string>;

The id of the project.

property pushAccessLevel

pushAccessLevel?: pulumi.Input<string>;

One of five levels of access to the project.

interface DeployKeyArgs

interface DeployKeyArgs

The set of arguments for constructing a DeployKey resource.

property canPush

canPush?: pulumi.Input<boolean>;

Allow this deploy key to be used to push changes to the project. Defaults to false. NOTE:: this cannot currently be managed.

property key

key: pulumi.Input<string>;

The public ssh key body.

property project

project: pulumi.Input<string>;

The name or id of the project to add the deploy key to.

property title

title: pulumi.Input<string>;

A title to describe the deploy key with.

interface DeployKeyEnableArgs

interface DeployKeyEnableArgs

The set of arguments for constructing a DeployKeyEnable resource.

property canPush

canPush?: pulumi.Input<boolean>;

property key

key?: pulumi.Input<string>;

property keyId

keyId: pulumi.Input<string>;

The Gitlab key id for the pre-existing deploy key

property project

project: pulumi.Input<string>;

The name or id of the project to add the deploy key to.

property title

title?: pulumi.Input<string>;

interface DeployKeyEnableState

interface DeployKeyEnableState

Input properties used for looking up and filtering DeployKeyEnable resources.

property canPush

canPush?: pulumi.Input<boolean>;

property key

key?: pulumi.Input<string>;

property keyId

keyId?: pulumi.Input<string>;

The Gitlab key id for the pre-existing deploy key

property project

project?: pulumi.Input<string>;

The name or id of the project to add the deploy key to.

property title

title?: pulumi.Input<string>;

interface DeployKeyState

interface DeployKeyState

Input properties used for looking up and filtering DeployKey resources.

property canPush

canPush?: pulumi.Input<boolean>;

Allow this deploy key to be used to push changes to the project. Defaults to false. NOTE:: this cannot currently be managed.

property key

key?: pulumi.Input<string>;

The public ssh key body.

property project

project?: pulumi.Input<string>;

The name or id of the project to add the deploy key to.

property title

title?: pulumi.Input<string>;

A title to describe the deploy key with.

interface DeployTokenArgs

interface DeployTokenArgs

The set of arguments for constructing a DeployToken resource.

property expiresAt

expiresAt?: pulumi.Input<string>;

property group

group?: pulumi.Input<string>;

The name or id of the group to add the deploy token to. Either project or group must be set.

property name

name?: pulumi.Input<string>;

A name to describe the deploy token with.

property project

project?: pulumi.Input<string>;

The name or id of the project to add the deploy token to. Either project or group must be set.

property scopes

scopes: pulumi.Input<pulumi.Input<string>[]>;

Valid values: readRepository, readRegistry.

property username

username?: pulumi.Input<string>;

A username for the deploy token. Default is gitlab+deploy-token-{n}.

interface DeployTokenState

interface DeployTokenState

Input properties used for looking up and filtering DeployToken resources.

property expiresAt

expiresAt?: pulumi.Input<string>;

property group

group?: pulumi.Input<string>;

The name or id of the group to add the deploy token to. Either project or group must be set.

property name

name?: pulumi.Input<string>;

A name to describe the deploy token with.

property project

project?: pulumi.Input<string>;

The name or id of the project to add the deploy token to. Either project or group must be set.

property scopes

scopes?: pulumi.Input<pulumi.Input<string>[]>;

Valid values: readRepository, readRegistry.

property token

token?: pulumi.Input<string>;

The secret token. This is only populated when creating a new deploy token.

property username

username?: pulumi.Input<string>;

A username for the deploy token. Default is gitlab+deploy-token-{n}.

function getEnv

getEnv(vars: string[]): string | undefined

function getEnvBoolean

getEnvBoolean(vars: string[]): boolean | undefined

function getEnvNumber

getEnvNumber(vars: string[]): number | undefined

interface GetGroupArgs

interface GetGroupArgs

A collection of arguments for invoking getGroup.

property fullPath

fullPath?: undefined | string;

The full path of the group.

property groupId

groupId?: undefined | number;

The ID of the group.

interface GetGroupResult

interface GetGroupResult

A collection of values returned by getGroup.

property description

description: string;

The description of the group.

property fullName

fullName: string;

The full name of the group.

property fullPath

fullPath: string;

The full path of the group.

property groupId

groupId: number;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property lfsEnabled

lfsEnabled: boolean;

Boolean, is LFS enabled for projects in this group.

property name

name: string;

The name of this group.

property parentId

parentId: number;

Integer, ID of the parent group.

property path

path: string;

The path of the group.

property requestAccessEnabled

requestAccessEnabled: boolean;

Boolean, is request for access enabled to the group.

property runnersToken

runnersToken: string;

The group level registration token to use during runner setup.

property visibilityLevel

visibilityLevel: string;

Visibility level of the group. Possible values are private, internal, public.

property webUrl

webUrl: string;

Web URL of the group.

interface GetProjectArgs

interface GetProjectArgs

A collection of arguments for invoking getProject.

property archived

archived?: undefined | false | true;

Whether the project is in read-only mode (archived).

property defaultBranch

defaultBranch?: undefined | string;

The default branch for the project.

property description

description?: undefined | string;

A description of the project.

property httpUrlToRepo

httpUrlToRepo?: undefined | string;

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

property id

id: number;

The integer that uniquely identifies the project within the gitlab install.

property issuesEnabled

issuesEnabled?: undefined | false | true;

Enable issue tracking for the project.

property lfsEnabled

lfsEnabled?: undefined | false | true;

Enable LFS for the project.

property mergeRequestsEnabled

mergeRequestsEnabled?: undefined | false | true;

Enable merge requests for the project.

property name

name?: undefined | string;

property namespaceId

namespaceId?: undefined | number;

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

property path

path?: undefined | string;

The path of the repository.

property pipelinesEnabled

pipelinesEnabled?: undefined | false | true;

Enable pipelines for the project.

property requestAccessEnabled

requestAccessEnabled?: undefined | false | true;

Allow users to request member access.

property runnersToken

runnersToken?: undefined | string;

Registration token to use during runner setup.

property snippetsEnabled

snippetsEnabled?: undefined | false | true;

Enable snippets for the project.

property sshUrlToRepo

sshUrlToRepo?: undefined | string;

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

property visibilityLevel

visibilityLevel?: undefined | string;

Repositories are created as private by default.

property webUrl

webUrl?: undefined | string;

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

property wikiEnabled

wikiEnabled?: undefined | false | true;

Enable wiki for the project.

interface GetProjectResult

interface GetProjectResult

A collection of values returned by getProject.

property archived

archived: boolean;

Whether the project is in read-only mode (archived).

property defaultBranch

defaultBranch: string;

The default branch for the project.

property description

description: string;

A description of the project.

property httpUrlToRepo

httpUrlToRepo: string;

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

property id

id: number;

Integer that uniquely identifies the project within the gitlab install.

property issuesEnabled

issuesEnabled: boolean;

Enable issue tracking for the project.

property lfsEnabled

lfsEnabled: boolean;

Enable LFS for the project.

property mergeRequestsEnabled

mergeRequestsEnabled: boolean;

Enable merge requests for the project.

property name

name: string;

property namespaceId

namespaceId: number;

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

property path

path: string;

The path of the repository.

property pipelinesEnabled

pipelinesEnabled: boolean;

Enable pipelines for the project.

property requestAccessEnabled

requestAccessEnabled: boolean;

Allow users to request member access.

property runnersToken

runnersToken: string;

Registration token to use during runner setup.

property snippetsEnabled

snippetsEnabled: boolean;

Enable snippets for the project.

property sshUrlToRepo

sshUrlToRepo: string;

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

property visibilityLevel

visibilityLevel: string;

Repositories are created as private by default.

property webUrl

webUrl: string;

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

property wikiEnabled

wikiEnabled: boolean;

Enable wiki for the project.

interface GetProjectsArgs

interface GetProjectsArgs

A collection of arguments for invoking getProjects.

property archived

archived?: undefined | false | true;

Limit by archived status.

property groupId

groupId?: undefined | number;

The ID of the group owned by the authenticated user to look projects for within. Cannot be used with minAccessLevel, withProgrammingLanguage or statistics.

property includeSubgroups

includeSubgroups?: undefined | false | true;

Include projects in subgroups of this group. Default is false. Needs groupId.

property maxQueryablePages

maxQueryablePages?: undefined | number;

Prevents overloading your Gitlab instance in case of a misconfiguration. Default is 10.

property membership

membership?: undefined | false | true;

Limit by projects that the current user is a member of.

property minAccessLevel

minAccessLevel?: undefined | number;

Limit to projects where current user has at least this access level, refer to the official documentation for values. Cannot be used with groupId.

property orderBy

orderBy?: undefined | string;

Return projects ordered by id, name, path, createdAt, updatedAt, or lastActivityAt fields. Default is createdAt.

property owned

owned?: undefined | false | true;

Limit by projects owned by the current user.

property page

page?: undefined | number;

property perPage

perPage?: undefined | number;
search?: undefined | string;

Return list of authorized projects matching the search criteria.

property simple

simple?: undefined | false | true;

Return only the ID, URL, name, and path of each project.

property sort

sort?: undefined | string;

Return projects sorted in asc or desc order. Default is desc.

property starred

starred?: undefined | false | true;

Limit by projects starred by the current user.

property statistics

statistics?: undefined | false | true;

Include project statistics. Cannot be used with groupId.

property visibility

visibility?: undefined | string;

Limit by visibility public, internal, or private.

property withCustomAttributes

withCustomAttributes?: undefined | false | true;

Include custom attributes in response (admins only).

property withIssuesEnabled

withIssuesEnabled?: undefined | false | true;

Limit by projects with issues feature enabled. Default is false.

property withMergeRequestsEnabled

withMergeRequestsEnabled?: undefined | false | true;

Limit by projects with merge requests feature enabled. Default is false.

property withProgrammingLanguage

withProgrammingLanguage?: undefined | string;

Limit by projects which use the given programming language. Cannot be used with groupId.

property withShared

withShared?: undefined | false | true;

Include projects shared to this group. Default is true. Needs groupId.

interface GetProjectsResult

interface GetProjectsResult

A collection of values returned by getProjects.

property archived

archived?: undefined | false | true;

property groupId

groupId?: undefined | number;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property includeSubgroups

includeSubgroups?: undefined | false | true;

property maxQueryablePages

maxQueryablePages?: undefined | number;

property membership

membership?: undefined | false | true;

property minAccessLevel

minAccessLevel?: undefined | number;

property orderBy

orderBy?: undefined | string;

property owned

owned?: undefined | false | true;

property page

page?: undefined | number;

property perPage

perPage?: undefined | number;

property projects

projects: GetProjectsProject[];

A list containing the projects matching the supplied arguments

search?: undefined | string;

property simple

simple?: undefined | false | true;

property sort

sort?: undefined | string;

property starred

starred?: undefined | false | true;

property statistics

statistics?: undefined | false | true;

property visibility

visibility?: undefined | string;

The visibility of the project.

property withCustomAttributes

withCustomAttributes?: undefined | false | true;

property withIssuesEnabled

withIssuesEnabled?: undefined | false | true;

property withMergeRequestsEnabled

withMergeRequestsEnabled?: undefined | false | true;

property withProgrammingLanguage

withProgrammingLanguage?: undefined | string;

property withShared

withShared?: undefined | false | true;

interface GetUserArgs

interface GetUserArgs

A collection of arguments for invoking getUser.

property email

email?: undefined | string;

The e-mail address of the user. (Requires administrator privileges)

property userId

userId?: undefined | number;

The ID of the user.

property username

username?: undefined | string;

The username of the user.

interface GetUserResult

interface GetUserResult

A collection of values returned by getUser.

property avatarUrl

avatarUrl: string;

The avatar URL of the user.

property bio

bio: string;

The bio of the user.

property canCreateGroup

canCreateGroup: boolean;

Whether the user can create groups.

property canCreateProject

canCreateProject: boolean;

Whether the user can create projects.

property colorSchemeId

colorSchemeId: number;

User’s color scheme ID.

property createdAt

createdAt: string;

Date the user was created at.

property currentSignInAt

currentSignInAt: string;

Current user’s sign-in date.

property email

email: string;

The e-mail address of the user.

property externUid

externUid: string;

The external UID of the user.

property external

external: boolean;

Whether the user is external.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property isAdmin

isAdmin: boolean;

Whether the user is an admin.

property lastSignInAt

lastSignInAt: string;

Last user’s sign-in date.

property linkedin

linkedin: string;

Linkedin profile of the user.

property location

location: string;

The location of the user.

property name

name: string;

The name of the user.

property organization

organization: string;

The organization of the user.

property projectsLimit

projectsLimit: number;

Number of projects the user can create.

property skype

skype: string;

Skype username of the user.

property state

state: string;

Whether the user is active or blocked.

property themeId

themeId: number;

User’s theme ID.

property twitter

twitter: string;

Twitter username of the user.

property twoFactorEnabled

twoFactorEnabled: boolean;

Whether user’s two factor auth is enabled.

property userId

userId: number;

property userProvider

userProvider: string;

The UID provider of the user.

property username

username: string;

The username of the user.

property websiteUrl

websiteUrl: string;

User’s website URL.

interface GetUsersArgs

interface GetUsersArgs

A collection of arguments for invoking getUsers.

property active

active?: undefined | false | true;

Filter users that are active.

property blocked

blocked?: undefined | false | true;

Filter users that are blocked.

property createdAfter

createdAfter?: undefined | string;

Search for users created after a specific date. (Requires administrator privileges)

property createdBefore

createdBefore?: undefined | string;

Search for users created before a specific date. (Requires administrator privileges)

property externProvider

externProvider?: undefined | string;

Lookup users by external provider. (Requires administrator privileges)

property externUid

externUid?: undefined | string;

Lookup users by external UID. (Requires administrator privileges)

property orderBy

orderBy?: undefined | string;

Order the users’ list by id, name, username, createdAt or updatedAt. (Requires administrator privileges)

search?: undefined | string;

Search users by username, name or email.

property sort

sort?: undefined | string;

Sort users’ list in asc or desc order. (Requires administrator privileges)

interface GetUsersResult

interface GetUsersResult

A collection of values returned by getUsers.

property active

active?: undefined | false | true;

property blocked

blocked?: undefined | false | true;

property createdAfter

createdAfter?: undefined | string;

property createdBefore

createdBefore?: undefined | string;

property externProvider

externProvider?: undefined | string;

property externUid

externUid?: undefined | string;

The external UID of the user.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property orderBy

orderBy?: undefined | string;
search?: undefined | string;

property sort

sort?: undefined | string;

property users

users: GetUsersUser[];

The list of users.

function getVersion

getVersion(): string

interface GroupArgs

interface GroupArgs

The set of arguments for constructing a Group resource.

property description

description?: pulumi.Input<string>;

The description of the group.

property lfsEnabled

lfsEnabled?: pulumi.Input<boolean>;

Boolean, defaults to true. Whether to enable LFS support for projects in this group.

property name

name?: pulumi.Input<string>;

The name of this group.

property parentId

parentId?: pulumi.Input<number>;

Integer, id of the parent group (creates a nested group).

property path

path: pulumi.Input<string>;

The path of the group.

property requestAccessEnabled

requestAccessEnabled?: pulumi.Input<boolean>;

Boolean, defaults to false. Whether to enable users to request access to the group.

property visibilityLevel

visibilityLevel?: pulumi.Input<string>;

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

interface GroupClusterArgs

interface GroupClusterArgs

The set of arguments for constructing a GroupCluster resource.

property domain

domain?: pulumi.Input<string>;

The base domain of the cluster.

property enabled

enabled?: pulumi.Input<boolean>;

Determines if cluster is active or not. Defaults to true. This attribute cannot be read.

property environmentScope

environmentScope?: pulumi.Input<string>;

The associated environment to the cluster. Defaults to *.

property group

group: pulumi.Input<string>;

The id of the group to add the cluster to.

property kubernetesApiUrl

kubernetesApiUrl: pulumi.Input<string>;

The URL to access the Kubernetes API.

property kubernetesAuthorizationType

kubernetesAuthorizationType?: pulumi.Input<string>;

The cluster authorization type. Valid values are rbac, abac, unknownAuthorization. Defaults to rbac.

property kubernetesCaCert

kubernetesCaCert?: pulumi.Input<string>;

TLS certificate (needed if API is using a self-signed TLS certificate).

property kubernetesToken

kubernetesToken: pulumi.Input<string>;

The token to authenticate against Kubernetes.

property managed

managed?: pulumi.Input<boolean>;

Determines if cluster is managed by gitlab or not. Defaults to true. This attribute cannot be read.

property managementProjectId

managementProjectId?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

The name of cluster.

interface GroupClusterState

interface GroupClusterState

Input properties used for looking up and filtering GroupCluster resources.

property clusterType

clusterType?: pulumi.Input<string>;

property createdAt

createdAt?: pulumi.Input<string>;

property domain

domain?: pulumi.Input<string>;

The base domain of the cluster.

property enabled

enabled?: pulumi.Input<boolean>;

Determines if cluster is active or not. Defaults to true. This attribute cannot be read.

property environmentScope

environmentScope?: pulumi.Input<string>;

The associated environment to the cluster. Defaults to *.

property group

group?: pulumi.Input<string>;

The id of the group to add the cluster to.

property kubernetesApiUrl

kubernetesApiUrl?: pulumi.Input<string>;

The URL to access the Kubernetes API.

property kubernetesAuthorizationType

kubernetesAuthorizationType?: pulumi.Input<string>;

The cluster authorization type. Valid values are rbac, abac, unknownAuthorization. Defaults to rbac.

property kubernetesCaCert

kubernetesCaCert?: pulumi.Input<string>;

TLS certificate (needed if API is using a self-signed TLS certificate).

property kubernetesToken

kubernetesToken?: pulumi.Input<string>;

The token to authenticate against Kubernetes.

property managed

managed?: pulumi.Input<boolean>;

Determines if cluster is managed by gitlab or not. Defaults to true. This attribute cannot be read.

property managementProjectId

managementProjectId?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

The name of cluster.

property platformType

platformType?: pulumi.Input<string>;

property providerType

providerType?: pulumi.Input<string>;

interface GroupLabelArgs

interface GroupLabelArgs

The set of arguments for constructing a GroupLabel resource.

property color

color: pulumi.Input<string>;

The color of the label given in 6-digit hex notation with leading ‘#’ sign (e.g. #FFAABB) or one of the CSS color names.

property description

description?: pulumi.Input<string>;

The description of the label.

property group

group: pulumi.Input<string>;

The name or id of the group to add the label to.

property name

name?: pulumi.Input<string>;

The name of the label.

interface GroupLabelState

interface GroupLabelState

Input properties used for looking up and filtering GroupLabel resources.

property color

color?: pulumi.Input<string>;

The color of the label given in 6-digit hex notation with leading ‘#’ sign (e.g. #FFAABB) or one of the CSS color names.

property description

description?: pulumi.Input<string>;

The description of the label.

property group

group?: pulumi.Input<string>;

The name or id of the group to add the label to.

property name

name?: pulumi.Input<string>;

The name of the label.

interface GroupLdapLinkArgs

interface GroupLdapLinkArgs

The set of arguments for constructing a GroupLdapLink resource.

property accessLevel

accessLevel: pulumi.Input<string>;

Acceptable values are: guest, reporter, developer, maintainer, owner.

property cn

cn: pulumi.Input<string>;

The CN of the LDAP group to link with.

property force

force?: pulumi.Input<boolean>;

property groupId

groupId: pulumi.Input<string>;

The id of the GitLab group.

property ldapProvider

ldapProvider: pulumi.Input<string>;

The name of the LDAP provider as stored in the GitLab database.

interface GroupLdapLinkState

interface GroupLdapLinkState

Input properties used for looking up and filtering GroupLdapLink resources.

property accessLevel

accessLevel?: pulumi.Input<string>;

Acceptable values are: guest, reporter, developer, maintainer, owner.

property cn

cn?: pulumi.Input<string>;

The CN of the LDAP group to link with.

property force

force?: pulumi.Input<boolean>;

property groupId

groupId?: pulumi.Input<string>;

The id of the GitLab group.

property ldapProvider

ldapProvider?: pulumi.Input<string>;

The name of the LDAP provider as stored in the GitLab database.

interface GroupMembershipArgs

interface GroupMembershipArgs

The set of arguments for constructing a GroupMembership resource.

property accessLevel

accessLevel: pulumi.Input<string>;

Acceptable values are: guest, reporter, developer, maintainer, owner.

property expiresAt

expiresAt?: pulumi.Input<string>;

Expiration date for the group membership. Format: YYYY-MM-DD

property groupId

groupId: pulumi.Input<string>;

The id of the group.

property userId

userId: pulumi.Input<number>;

The id of the user.

interface GroupMembershipState

interface GroupMembershipState

Input properties used for looking up and filtering GroupMembership resources.

property accessLevel

accessLevel?: pulumi.Input<string>;

Acceptable values are: guest, reporter, developer, maintainer, owner.

property expiresAt

expiresAt?: pulumi.Input<string>;

Expiration date for the group membership. Format: YYYY-MM-DD

property groupId

groupId?: pulumi.Input<string>;

The id of the group.

property userId

userId?: pulumi.Input<number>;

The id of the user.

interface GroupState

interface GroupState

Input properties used for looking up and filtering Group resources.

property description

description?: pulumi.Input<string>;

The description of the group.

property fullName

fullName?: pulumi.Input<string>;

The full name of the group.

property fullPath

fullPath?: pulumi.Input<string>;

The full path of the group.

property lfsEnabled

lfsEnabled?: pulumi.Input<boolean>;

Boolean, defaults to true. Whether to enable LFS support for projects in this group.

property name

name?: pulumi.Input<string>;

The name of this group.

property parentId

parentId?: pulumi.Input<number>;

Integer, id of the parent group (creates a nested group).

property path

path?: pulumi.Input<string>;

The path of the group.

property requestAccessEnabled

requestAccessEnabled?: pulumi.Input<boolean>;

Boolean, defaults to false. Whether to enable users to request access to the group.

property runnersToken

runnersToken?: pulumi.Input<string>;

The group level registration token to use during runner setup.

property visibilityLevel

visibilityLevel?: pulumi.Input<string>;

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

property webUrl

webUrl?: pulumi.Input<string>;

Web URL of the group.

interface GroupVariableArgs

interface GroupVariableArgs

The set of arguments for constructing a GroupVariable resource.

property group

group: pulumi.Input<string>;

The name or id of the group to add the hook to.

property key

key: pulumi.Input<string>;

The name of the variable.

property masked

masked?: pulumi.Input<boolean>;

property protected

protected?: pulumi.Input<boolean>;

If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.

property value

value: pulumi.Input<string>;

The value of the variable.

property variableType

variableType?: pulumi.Input<string>;

The type of a variable. Available types are: envVar (default) and file.

interface GroupVariableState

interface GroupVariableState

Input properties used for looking up and filtering GroupVariable resources.

property group

group?: pulumi.Input<string>;

The name or id of the group to add the hook to.

property key

key?: pulumi.Input<string>;

The name of the variable.

property masked

masked?: pulumi.Input<boolean>;

property protected

protected?: pulumi.Input<boolean>;

If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.

property value

value?: pulumi.Input<string>;

The value of the variable.

property variableType

variableType?: pulumi.Input<string>;

The type of a variable. Available types are: envVar (default) and file.

interface LabelArgs

interface LabelArgs

The set of arguments for constructing a Label resource.

property color

color: pulumi.Input<string>;

The color of the label given in 6-digit hex notation with leading ‘#’ sign (e.g. #FFAABB) or one of the CSS color names.

property description

description?: pulumi.Input<string>;

The description of the label.

property name

name?: pulumi.Input<string>;

The name of the label.

property project

project: pulumi.Input<string>;

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

interface LabelState

interface LabelState

Input properties used for looking up and filtering Label resources.

property color

color?: pulumi.Input<string>;

The color of the label given in 6-digit hex notation with leading ‘#’ sign (e.g. #FFAABB) or one of the CSS color names.

property description

description?: pulumi.Input<string>;

The description of the label.

property name

name?: pulumi.Input<string>;

The name of the label.

property project

project?: pulumi.Input<string>;

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

interface PipelineScheduleArgs

interface PipelineScheduleArgs

The set of arguments for constructing a PipelineSchedule resource.

property active

active?: pulumi.Input<boolean>;

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

property cron

cron: pulumi.Input<string>;

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

property cronTimezone

cronTimezone?: pulumi.Input<string>;

The timezone.

property description

description: pulumi.Input<string>;

The description of the pipeline schedule.

property project

project: pulumi.Input<string>;

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

property ref

ref: pulumi.Input<string>;

The branch/tag name to be triggered.

interface PipelineScheduleState

interface PipelineScheduleState

Input properties used for looking up and filtering PipelineSchedule resources.

property active

active?: pulumi.Input<boolean>;

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

property cron

cron?: pulumi.Input<string>;

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

property cronTimezone

cronTimezone?: pulumi.Input<string>;

The timezone.

property description

description?: pulumi.Input<string>;

The description of the pipeline schedule.

property project

project?: pulumi.Input<string>;

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

property ref

ref?: pulumi.Input<string>;

The branch/tag name to be triggered.

interface PipelineScheduleVariableArgs

interface PipelineScheduleVariableArgs

The set of arguments for constructing a PipelineScheduleVariable resource.

property key

key: pulumi.Input<string>;

Name of the variable.

property pipelineScheduleId

pipelineScheduleId: pulumi.Input<number>;

The id of the pipeline schedule.

property project

project: pulumi.Input<string>;

The id of the project to add the schedule to.

property value

value: pulumi.Input<string>;

Value of the variable.

interface PipelineScheduleVariableState

interface PipelineScheduleVariableState

Input properties used for looking up and filtering PipelineScheduleVariable resources.

property key

key?: pulumi.Input<string>;

Name of the variable.

property pipelineScheduleId

pipelineScheduleId?: pulumi.Input<number>;

The id of the pipeline schedule.

property project

project?: pulumi.Input<string>;

The id of the project to add the schedule to.

property value

value?: pulumi.Input<string>;

Value of the variable.

interface PipelineTriggerArgs

interface PipelineTriggerArgs

The set of arguments for constructing a PipelineTrigger resource.

property description

description: pulumi.Input<string>;

The description of the pipeline trigger.

property project

project: pulumi.Input<string>;

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

interface PipelineTriggerState

interface PipelineTriggerState

Input properties used for looking up and filtering PipelineTrigger resources.

property description

description?: pulumi.Input<string>;

The description of the pipeline trigger.

property project

project?: pulumi.Input<string>;

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

property token

token?: pulumi.Input<string>;

interface ProjectArgs

interface ProjectArgs

The set of arguments for constructing a Project resource.

property approvalsBeforeMerge

approvalsBeforeMerge?: pulumi.Input<number>;

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

property archived

archived?: pulumi.Input<boolean>;

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

property containerRegistryEnabled

containerRegistryEnabled?: pulumi.Input<boolean>;

Enable container registry for the project.

property defaultBranch

defaultBranch?: pulumi.Input<string>;

The default branch for the project.

property description

description?: pulumi.Input<string>;

A description of the project.

property initializeWithReadme

initializeWithReadme?: pulumi.Input<boolean>;

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

property issuesEnabled

issuesEnabled?: pulumi.Input<boolean>;

Enable issue tracking for the project.

property lfsEnabled

lfsEnabled?: pulumi.Input<boolean>;

Enable LFS for the project.

property mergeMethod

mergeMethod?: pulumi.Input<string>;

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

property mergeRequestsEnabled

mergeRequestsEnabled?: pulumi.Input<boolean>;

Enable merge requests for the project.

property name

name?: pulumi.Input<string>;

The name of the project.

property namespaceId

namespaceId?: pulumi.Input<number>;

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

property onlyAllowMergeIfAllDiscussionsAreResolved

onlyAllowMergeIfAllDiscussionsAreResolved?: pulumi.Input<boolean>;

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

property onlyAllowMergeIfPipelineSucceeds

onlyAllowMergeIfPipelineSucceeds?: pulumi.Input<boolean>;

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

property path

path?: pulumi.Input<string>;

The path of the repository.

property pipelinesEnabled

pipelinesEnabled?: pulumi.Input<boolean>;

Enable pipelines for the project.

property requestAccessEnabled

requestAccessEnabled?: pulumi.Input<boolean>;

Allow users to request member access.

property sharedRunnersEnabled

sharedRunnersEnabled?: pulumi.Input<boolean>;

Enable shared runners for this project.

property sharedWithGroups

sharedWithGroups?: pulumi.Input<pulumi.Input<ProjectSharedWithGroup>[]>;

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

property snippetsEnabled

snippetsEnabled?: pulumi.Input<boolean>;

Enable snippets for the project.

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

Tags (topics) of the project.

property visibilityLevel

visibilityLevel?: pulumi.Input<string>;

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

property wikiEnabled

wikiEnabled?: pulumi.Input<boolean>;

Enable wiki for the project.

interface ProjectClusterArgs

interface ProjectClusterArgs

The set of arguments for constructing a ProjectCluster resource.

property domain

domain?: pulumi.Input<string>;

The base domain of the cluster.

property enabled

enabled?: pulumi.Input<boolean>;

Determines if cluster is active or not. Defaults to true. This attribute cannot be read.

property environmentScope

environmentScope?: pulumi.Input<string>;

The associated environment to the cluster. Defaults to *.

property kubernetesApiUrl

kubernetesApiUrl: pulumi.Input<string>;

The URL to access the Kubernetes API.

property kubernetesAuthorizationType

kubernetesAuthorizationType?: pulumi.Input<string>;

The cluster authorization type. Valid values are rbac, abac, unknownAuthorization. Defaults to rbac.

property kubernetesCaCert

kubernetesCaCert?: pulumi.Input<string>;

TLS certificate (needed if API is using a self-signed TLS certificate).

property kubernetesNamespace

kubernetesNamespace?: pulumi.Input<string>;

The unique namespace related to the project.

property kubernetesToken

kubernetesToken: pulumi.Input<string>;

The token to authenticate against Kubernetes.

property managed

managed?: pulumi.Input<boolean>;

Determines if cluster is managed by gitlab or not. Defaults to true. This attribute cannot be read.

property managementProjectId

managementProjectId?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

The name of cluster.

property project

project: pulumi.Input<string>;

The id of the project to add the cluster to.

interface ProjectClusterState

interface ProjectClusterState

Input properties used for looking up and filtering ProjectCluster resources.

property clusterType

clusterType?: pulumi.Input<string>;

property createdAt

createdAt?: pulumi.Input<string>;

property domain

domain?: pulumi.Input<string>;

The base domain of the cluster.

property enabled

enabled?: pulumi.Input<boolean>;

Determines if cluster is active or not. Defaults to true. This attribute cannot be read.

property environmentScope

environmentScope?: pulumi.Input<string>;

The associated environment to the cluster. Defaults to *.

property kubernetesApiUrl

kubernetesApiUrl?: pulumi.Input<string>;

The URL to access the Kubernetes API.

property kubernetesAuthorizationType

kubernetesAuthorizationType?: pulumi.Input<string>;

The cluster authorization type. Valid values are rbac, abac, unknownAuthorization. Defaults to rbac.

property kubernetesCaCert

kubernetesCaCert?: pulumi.Input<string>;

TLS certificate (needed if API is using a self-signed TLS certificate).

property kubernetesNamespace

kubernetesNamespace?: pulumi.Input<string>;

The unique namespace related to the project.

property kubernetesToken

kubernetesToken?: pulumi.Input<string>;

The token to authenticate against Kubernetes.

property managed

managed?: pulumi.Input<boolean>;

Determines if cluster is managed by gitlab or not. Defaults to true. This attribute cannot be read.

property managementProjectId

managementProjectId?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

The name of cluster.

property platformType

platformType?: pulumi.Input<string>;

property project

project?: pulumi.Input<string>;

The id of the project to add the cluster to.

property providerType

providerType?: pulumi.Input<string>;

interface ProjectHookArgs

interface ProjectHookArgs

The set of arguments for constructing a ProjectHook resource.

property enableSslVerification

enableSslVerification?: pulumi.Input<boolean>;

Enable ssl verification when invoking the hook.

property issuesEvents

issuesEvents?: pulumi.Input<boolean>;

Invoke the hook for issues events.

property jobEvents

jobEvents?: pulumi.Input<boolean>;

Invoke the hook for job events.

property mergeRequestsEvents

mergeRequestsEvents?: pulumi.Input<boolean>;

Invoke the hook for merge requests.

property noteEvents

noteEvents?: pulumi.Input<boolean>;

Invoke the hook for notes events.

property pipelineEvents

pipelineEvents?: pulumi.Input<boolean>;

Invoke the hook for pipeline events.

property project

project: pulumi.Input<string>;

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

property pushEvents

pushEvents?: pulumi.Input<boolean>;

Invoke the hook for push events.

property tagPushEvents

tagPushEvents?: pulumi.Input<boolean>;

Invoke the hook for tag push events.

property token

token?: pulumi.Input<string>;

A token to present when invoking the hook.

property url

url: pulumi.Input<string>;

The url of the hook to invoke.

property wikiPageEvents

wikiPageEvents?: pulumi.Input<boolean>;

Invoke the hook for wiki page events.

interface ProjectHookState

interface ProjectHookState

Input properties used for looking up and filtering ProjectHook resources.

property enableSslVerification

enableSslVerification?: pulumi.Input<boolean>;

Enable ssl verification when invoking the hook.

property issuesEvents

issuesEvents?: pulumi.Input<boolean>;

Invoke the hook for issues events.

property jobEvents

jobEvents?: pulumi.Input<boolean>;

Invoke the hook for job events.

property mergeRequestsEvents

mergeRequestsEvents?: pulumi.Input<boolean>;

Invoke the hook for merge requests.

property noteEvents

noteEvents?: pulumi.Input<boolean>;

Invoke the hook for notes events.

property pipelineEvents

pipelineEvents?: pulumi.Input<boolean>;

Invoke the hook for pipeline events.

property project

project?: pulumi.Input<string>;

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

property pushEvents

pushEvents?: pulumi.Input<boolean>;

Invoke the hook for push events.

property tagPushEvents

tagPushEvents?: pulumi.Input<boolean>;

Invoke the hook for tag push events.

property token

token?: pulumi.Input<string>;

A token to present when invoking the hook.

property url

url?: pulumi.Input<string>;

The url of the hook to invoke.

property wikiPageEvents

wikiPageEvents?: pulumi.Input<boolean>;

Invoke the hook for wiki page events.

interface ProjectMembershipArgs

interface ProjectMembershipArgs

The set of arguments for constructing a ProjectMembership resource.

property accessLevel

accessLevel: pulumi.Input<string>;

One of five levels of access to the project.

property projectId

projectId: pulumi.Input<string>;

The id of the project.

property userId

userId: pulumi.Input<number>;

The id of the user.

interface ProjectMembershipState

interface ProjectMembershipState

Input properties used for looking up and filtering ProjectMembership resources.

property accessLevel

accessLevel?: pulumi.Input<string>;

One of five levels of access to the project.

property projectId

projectId?: pulumi.Input<string>;

The id of the project.

property userId

userId?: pulumi.Input<number>;

The id of the user.

interface ProjectPushRulesArgs

interface ProjectPushRulesArgs

The set of arguments for constructing a ProjectPushRules resource.

property authorEmailRegex

authorEmailRegex?: pulumi.Input<string>;

All commit author emails must match this regex, e.g. “@my-company.com$”

property branchNameRegex

branchNameRegex?: pulumi.Input<string>;

All branch names must match this regex, e.g. “(feature|hotfix)\/*”

property commitMessageRegex

commitMessageRegex?: pulumi.Input<string>;

All commit messages must match this regex, e.g. “Fixed \d+..*”

property denyDeleteTag

denyDeleteTag?: pulumi.Input<boolean>;

Deny deleting a tag

property fileNameRegex

fileNameRegex?: pulumi.Input<string>;

All commited filenames must not match this regex, e.g. “(jar|exe)$”

property maxFileSize

maxFileSize?: pulumi.Input<number>;

Maximum file size (MB)

property memberCheck

memberCheck?: pulumi.Input<boolean>;

Restrict commits by author (email) to existing GitLab users

property preventSecrets

preventSecrets?: pulumi.Input<boolean>;

GitLab will reject any files that are likely to contain secrets

property project

project: pulumi.Input<string>;

The name or id of the project to add the push rules to.

interface ProjectPushRulesState

interface ProjectPushRulesState

Input properties used for looking up and filtering ProjectPushRules resources.

property authorEmailRegex

authorEmailRegex?: pulumi.Input<string>;

All commit author emails must match this regex, e.g. “@my-company.com$”

property branchNameRegex

branchNameRegex?: pulumi.Input<string>;

All branch names must match this regex, e.g. “(feature|hotfix)\/*”

property commitMessageRegex

commitMessageRegex?: pulumi.Input<string>;

All commit messages must match this regex, e.g. “Fixed \d+..*”

property denyDeleteTag

denyDeleteTag?: pulumi.Input<boolean>;

Deny deleting a tag

property fileNameRegex

fileNameRegex?: pulumi.Input<string>;

All commited filenames must not match this regex, e.g. “(jar|exe)$”

property maxFileSize

maxFileSize?: pulumi.Input<number>;

Maximum file size (MB)

property memberCheck

memberCheck?: pulumi.Input<boolean>;

Restrict commits by author (email) to existing GitLab users

property preventSecrets

preventSecrets?: pulumi.Input<boolean>;

GitLab will reject any files that are likely to contain secrets

property project

project?: pulumi.Input<string>;

The name or id of the project to add the push rules to.

interface ProjectShareGroupArgs

interface ProjectShareGroupArgs

The set of arguments for constructing a ProjectShareGroup resource.

property accessLevel

accessLevel: pulumi.Input<string>;

One of five levels of access to the project.

property groupId

groupId: pulumi.Input<number>;

The id of the group.

property projectId

projectId: pulumi.Input<string>;

The id of the project.

interface ProjectShareGroupState

interface ProjectShareGroupState

Input properties used for looking up and filtering ProjectShareGroup resources.

property accessLevel

accessLevel?: pulumi.Input<string>;

One of five levels of access to the project.

property groupId

groupId?: pulumi.Input<number>;

The id of the group.

property projectId

projectId?: pulumi.Input<string>;

The id of the project.

interface ProjectState

interface ProjectState

Input properties used for looking up and filtering Project resources.

property approvalsBeforeMerge

approvalsBeforeMerge?: pulumi.Input<number>;

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

property archived

archived?: pulumi.Input<boolean>;

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

property containerRegistryEnabled

containerRegistryEnabled?: pulumi.Input<boolean>;

Enable container registry for the project.

property defaultBranch

defaultBranch?: pulumi.Input<string>;

The default branch for the project.

property description

description?: pulumi.Input<string>;

A description of the project.

property httpUrlToRepo

httpUrlToRepo?: pulumi.Input<string>;

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

property initializeWithReadme

initializeWithReadme?: pulumi.Input<boolean>;

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

property issuesEnabled

issuesEnabled?: pulumi.Input<boolean>;

Enable issue tracking for the project.

property lfsEnabled

lfsEnabled?: pulumi.Input<boolean>;

Enable LFS for the project.

property mergeMethod

mergeMethod?: pulumi.Input<string>;

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

property mergeRequestsEnabled

mergeRequestsEnabled?: pulumi.Input<boolean>;

Enable merge requests for the project.

property name

name?: pulumi.Input<string>;

The name of the project.

property namespaceId

namespaceId?: pulumi.Input<number>;

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

property onlyAllowMergeIfAllDiscussionsAreResolved

onlyAllowMergeIfAllDiscussionsAreResolved?: pulumi.Input<boolean>;

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

property onlyAllowMergeIfPipelineSucceeds

onlyAllowMergeIfPipelineSucceeds?: pulumi.Input<boolean>;

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

property path

path?: pulumi.Input<string>;

The path of the repository.

property pipelinesEnabled

pipelinesEnabled?: pulumi.Input<boolean>;

Enable pipelines for the project.

property requestAccessEnabled

requestAccessEnabled?: pulumi.Input<boolean>;

Allow users to request member access.

property runnersToken

runnersToken?: pulumi.Input<string>;

Registration token to use during runner setup.

property sharedRunnersEnabled

sharedRunnersEnabled?: pulumi.Input<boolean>;

Enable shared runners for this project.

property sharedWithGroups

sharedWithGroups?: pulumi.Input<pulumi.Input<ProjectSharedWithGroup>[]>;

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

property snippetsEnabled

snippetsEnabled?: pulumi.Input<boolean>;

Enable snippets for the project.

property sshUrlToRepo

sshUrlToRepo?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

Tags (topics) of the project.

property visibilityLevel

visibilityLevel?: pulumi.Input<string>;

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

property webUrl

webUrl?: pulumi.Input<string>;

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

property wikiEnabled

wikiEnabled?: pulumi.Input<boolean>;

Enable wiki for the project.

interface ProjectVariableArgs

interface ProjectVariableArgs

The set of arguments for constructing a ProjectVariable resource.

property environmentScope

environmentScope?: pulumi.Input<string>;

The environmentScope of the variable

property key

key: pulumi.Input<string>;

The name of the variable.

property masked

masked?: pulumi.Input<boolean>;

If set to true, the variable will be masked if it would have been written to the logs. Defaults to false.

property project

project: pulumi.Input<string>;

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

property protected

protected?: pulumi.Input<boolean>;

If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.

property value

value: pulumi.Input<string>;

The value of the variable.

property variableType

variableType?: pulumi.Input<string>;

The type of a variable. Available types are: envVar (default) and file.

interface ProjectVariableState

interface ProjectVariableState

Input properties used for looking up and filtering ProjectVariable resources.

property environmentScope

environmentScope?: pulumi.Input<string>;

The environmentScope of the variable

property key

key?: pulumi.Input<string>;

The name of the variable.

property masked

masked?: pulumi.Input<boolean>;

If set to true, the variable will be masked if it would have been written to the logs. Defaults to false.

property project

project?: pulumi.Input<string>;

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

property protected

protected?: pulumi.Input<boolean>;

If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.

property value

value?: pulumi.Input<string>;

The value of the variable.

property variableType

variableType?: pulumi.Input<string>;

The type of a variable. Available types are: envVar (default) and file.

interface ProviderArgs

interface ProviderArgs

The set of arguments for constructing a Provider resource.

property baseUrl

baseUrl?: pulumi.Input<string>;

The GitLab Base API URL

property cacertFile

cacertFile?: pulumi.Input<string>;

A file containing the ca certificate to use in case ssl certificate is not from a standard chain

property clientCert

clientCert?: pulumi.Input<string>;

File path to client certificate when GitLab instance is behind company proxy. File must contain PEM encoded data.

property clientKey

clientKey?: pulumi.Input<string>;

File path to client key when GitLab instance is behind company proxy. File must contain PEM encoded data.

property insecure

insecure?: pulumi.Input<boolean>;

Disable SSL verification of API calls

property token

token?: pulumi.Input<string>;

The OAuth token used to connect to GitLab.

interface ServiceJiraArgs

interface ServiceJiraArgs

The set of arguments for constructing a ServiceJira resource.

property commentOnEventEnabled

commentOnEventEnabled?: pulumi.Input<boolean>;

Enable comments inside Jira issues on each GitLab event (commit / merge request)

property commitEvents

commitEvents?: pulumi.Input<boolean>;

Enable notifications for commit events

property jiraIssueTransitionId

jiraIssueTransitionId?: pulumi.Input<string>;

The ID of a transition that moves issues to a closed state. You can find this number under the JIRA workflow administration (Administration > Issues > Workflows) by selecting View under Operations of the desired workflow of your project. By default, this ID is set to 2.

property mergeRequestsEvents

mergeRequestsEvents?: pulumi.Input<boolean>;

Enable notifications for merge request events

property password

password: pulumi.Input<string>;

The password of the user created to be used with GitLab/JIRA.

property project

project: pulumi.Input<string>;

ID of the project you want to activate integration on.

property projectKey

projectKey?: pulumi.Input<string>;

The short identifier for your JIRA project, all uppercase, e.g., PROJ.

property url

url: pulumi.Input<string>;

The URL to the JIRA project which is being linked to this GitLab project. For example, https://jira.example.com.

property username

username: pulumi.Input<string>;

The username of the user created to be used with GitLab/JIRA.

interface ServiceJiraState

interface ServiceJiraState

Input properties used for looking up and filtering ServiceJira resources.

property active

active?: pulumi.Input<boolean>;

property commentOnEventEnabled

commentOnEventEnabled?: pulumi.Input<boolean>;

Enable comments inside Jira issues on each GitLab event (commit / merge request)

property commitEvents

commitEvents?: pulumi.Input<boolean>;

Enable notifications for commit events

property createdAt

createdAt?: pulumi.Input<string>;

property jiraIssueTransitionId

jiraIssueTransitionId?: pulumi.Input<string>;

The ID of a transition that moves issues to a closed state. You can find this number under the JIRA workflow administration (Administration > Issues > Workflows) by selecting View under Operations of the desired workflow of your project. By default, this ID is set to 2.

property mergeRequestsEvents

mergeRequestsEvents?: pulumi.Input<boolean>;

Enable notifications for merge request events

property password

password?: pulumi.Input<string>;

The password of the user created to be used with GitLab/JIRA.

property project

project?: pulumi.Input<string>;

ID of the project you want to activate integration on.

property projectKey

projectKey?: pulumi.Input<string>;

The short identifier for your JIRA project, all uppercase, e.g., PROJ.

property title

title?: pulumi.Input<string>;

property updatedAt

updatedAt?: pulumi.Input<string>;

property url

url?: pulumi.Input<string>;

The URL to the JIRA project which is being linked to this GitLab project. For example, https://jira.example.com.

property username

username?: pulumi.Input<string>;

The username of the user created to be used with GitLab/JIRA.

interface ServiceSlackArgs

interface ServiceSlackArgs

The set of arguments for constructing a ServiceSlack resource.

property branchesToBeNotified

branchesToBeNotified?: pulumi.Input<string>;

Branches to send notifications for. Valid options are “all”, “default”, “protected”, and “defaultAndProtected”.

property confidentialIssueChannel

confidentialIssueChannel?: pulumi.Input<string>;

The name of the channel to receive confidential issue events notifications.

property confidentialIssuesEvents

confidentialIssuesEvents?: pulumi.Input<boolean>;

Enable notifications for confidential issues events.

property confidentialNoteEvents

confidentialNoteEvents?: pulumi.Input<boolean>;

Enable notifications for confidential note events.

property issueChannel

issueChannel?: pulumi.Input<string>;

The name of the channel to receive issue events notifications.

property issuesEvents

issuesEvents?: pulumi.Input<boolean>;

Enable notifications for issues events.

property mergeRequestChannel

mergeRequestChannel?: pulumi.Input<string>;

The name of the channel to receive merge request events notifications.

property mergeRequestsEvents

mergeRequestsEvents?: pulumi.Input<boolean>;

Enable notifications for merge requests events.

property noteChannel

noteChannel?: pulumi.Input<string>;

The name of the channel to receive note events notifications.

property noteEvents

noteEvents?: pulumi.Input<boolean>;

Enable notifications for note events.

property notifyOnlyBrokenPipelines

notifyOnlyBrokenPipelines?: pulumi.Input<boolean>;

Send notifications for broken pipelines.

property notifyOnlyDefaultBranch

DEPRECATED use 'branches_to_be_notified' argument instead
notifyOnlyDefaultBranch?: pulumi.Input<boolean>;

DEPRECATED: This parameter has been replaced with branchesToBeNotified.

property pipelineChannel

pipelineChannel?: pulumi.Input<string>;

The name of the channel to receive pipeline events notifications.

property pipelineEvents

pipelineEvents?: pulumi.Input<boolean>;

Enable notifications for pipeline events.

property project

project: pulumi.Input<string>;

ID of the project you want to activate integration on.

property pushChannel

pushChannel?: pulumi.Input<string>;

The name of the channel to receive push events notifications.

property pushEvents

pushEvents?: pulumi.Input<boolean>;

Enable notifications for push events.

property tagPushChannel

tagPushChannel?: pulumi.Input<string>;

The name of the channel to receive tag push events notifications.

property tagPushEvents

tagPushEvents?: pulumi.Input<boolean>;

Enable notifications for tag push events.

property username

username?: pulumi.Input<string>;

Username to use.

property webhook

webhook: pulumi.Input<string>;

Webhook URL (ex.: https://hooks.slack.com/services/...)

property wikiPageChannel

wikiPageChannel?: pulumi.Input<string>;

The name of the channel to receive wiki page events notifications.

property wikiPageEvents

wikiPageEvents?: pulumi.Input<boolean>;

Enable notifications for wiki page events.

interface ServiceSlackState

interface ServiceSlackState

Input properties used for looking up and filtering ServiceSlack resources.

property branchesToBeNotified

branchesToBeNotified?: pulumi.Input<string>;

Branches to send notifications for. Valid options are “all”, “default”, “protected”, and “defaultAndProtected”.

property confidentialIssueChannel

confidentialIssueChannel?: pulumi.Input<string>;

The name of the channel to receive confidential issue events notifications.

property confidentialIssuesEvents

confidentialIssuesEvents?: pulumi.Input<boolean>;

Enable notifications for confidential issues events.

property confidentialNoteEvents

confidentialNoteEvents?: pulumi.Input<boolean>;

Enable notifications for confidential note events.

property issueChannel

issueChannel?: pulumi.Input<string>;

The name of the channel to receive issue events notifications.

property issuesEvents

issuesEvents?: pulumi.Input<boolean>;

Enable notifications for issues events.

property jobEvents

jobEvents?: pulumi.Input<boolean>;

property mergeRequestChannel

mergeRequestChannel?: pulumi.Input<string>;

The name of the channel to receive merge request events notifications.

property mergeRequestsEvents

mergeRequestsEvents?: pulumi.Input<boolean>;

Enable notifications for merge requests events.

property noteChannel

noteChannel?: pulumi.Input<string>;

The name of the channel to receive note events notifications.

property noteEvents

noteEvents?: pulumi.Input<boolean>;

Enable notifications for note events.

property notifyOnlyBrokenPipelines

notifyOnlyBrokenPipelines?: pulumi.Input<boolean>;

Send notifications for broken pipelines.

property notifyOnlyDefaultBranch

DEPRECATED use 'branches_to_be_notified' argument instead
notifyOnlyDefaultBranch?: pulumi.Input<boolean>;

DEPRECATED: This parameter has been replaced with branchesToBeNotified.

property pipelineChannel

pipelineChannel?: pulumi.Input<string>;

The name of the channel to receive pipeline events notifications.

property pipelineEvents

pipelineEvents?: pulumi.Input<boolean>;

Enable notifications for pipeline events.

property project

project?: pulumi.Input<string>;

ID of the project you want to activate integration on.

property pushChannel

pushChannel?: pulumi.Input<string>;

The name of the channel to receive push events notifications.

property pushEvents

pushEvents?: pulumi.Input<boolean>;

Enable notifications for push events.

property tagPushChannel

tagPushChannel?: pulumi.Input<string>;

The name of the channel to receive tag push events notifications.

property tagPushEvents

tagPushEvents?: pulumi.Input<boolean>;

Enable notifications for tag push events.

property username

username?: pulumi.Input<string>;

Username to use.

property webhook

webhook?: pulumi.Input<string>;

Webhook URL (ex.: https://hooks.slack.com/services/...)

property wikiPageChannel

wikiPageChannel?: pulumi.Input<string>;

The name of the channel to receive wiki page events notifications.

property wikiPageEvents

wikiPageEvents?: pulumi.Input<boolean>;

Enable notifications for wiki page events.

interface TagProtectionArgs

interface TagProtectionArgs

The set of arguments for constructing a TagProtection resource.

property createAccessLevel

createAccessLevel: pulumi.Input<string>;

One of five levels of access to the project.

property project

project: pulumi.Input<string>;

The id of the project.

property tag

tag: pulumi.Input<string>;

Name of the tag or wildcard.

interface TagProtectionState

interface TagProtectionState

Input properties used for looking up and filtering TagProtection resources.

property createAccessLevel

createAccessLevel?: pulumi.Input<string>;

One of five levels of access to the project.

property project

project?: pulumi.Input<string>;

The id of the project.

property tag

tag?: pulumi.Input<string>;

Name of the tag or wildcard.

interface UserArgs

interface UserArgs

The set of arguments for constructing a User resource.

property canCreateGroup

canCreateGroup?: pulumi.Input<boolean>;

Boolean, defaults to false. Whether to allow the user to create groups.

property email

email: pulumi.Input<string>;

The e-mail address of the user.

property isAdmin

isAdmin?: pulumi.Input<boolean>;

Boolean, defaults to false. Whether to enable administrative priviledges for the user.

property isExternal

isExternal?: pulumi.Input<boolean>;

Boolean, defaults to false. Whether a user has access only to some internal or private projects. External users can only access projects to which they are explicitly granted access.

property name

name?: pulumi.Input<string>;

The name of the user.

property password

password: pulumi.Input<string>;

The password of the user.

property projectsLimit

projectsLimit?: pulumi.Input<number>;

Integer, defaults to 0. Number of projects user can create.

property resetPassword

resetPassword?: pulumi.Input<boolean>;

Boolean, defaults to false. Send user password reset link.

property skipConfirmation

skipConfirmation?: pulumi.Input<boolean>;

Boolean, defaults to true. Whether to skip confirmation.

property username

username: pulumi.Input<string>;

The username of the user.

interface UserState

interface UserState

Input properties used for looking up and filtering User resources.

property canCreateGroup

canCreateGroup?: pulumi.Input<boolean>;

Boolean, defaults to false. Whether to allow the user to create groups.

property email

email?: pulumi.Input<string>;

The e-mail address of the user.

property isAdmin

isAdmin?: pulumi.Input<boolean>;

Boolean, defaults to false. Whether to enable administrative priviledges for the user.

property isExternal

isExternal?: pulumi.Input<boolean>;

Boolean, defaults to false. Whether a user has access only to some internal or private projects. External users can only access projects to which they are explicitly granted access.

property name

name?: pulumi.Input<string>;

The name of the user.

property password

password?: pulumi.Input<string>;

The password of the user.

property projectsLimit

projectsLimit?: pulumi.Input<number>;

Integer, defaults to 0. Number of projects user can create.

property resetPassword

resetPassword?: pulumi.Input<boolean>;

Boolean, defaults to false. Send user password reset link.

property skipConfirmation

skipConfirmation?: pulumi.Input<boolean>;

Boolean, defaults to true. Whether to skip confirmation.

property username

username?: pulumi.Input<string>;

The username of the user.