This page documents the language specification for the gitlab package. If you're looking for help working with the inputs, outputs, or functions of gitlab resources in a Pulumi program, please see the resource documentation for examples and API reference.

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.

class pulumi_gitlab.AwaitableGetGroupResult(description=None, full_name=None, full_path=None, group_id=None, id=None, lfs_enabled=None, name=None, parent_id=None, path=None, request_access_enabled=None, runners_token=None, visibility_level=None, web_url=None)¶

class pulumi_gitlab.AwaitableGetProjectResult(archived=None, default_branch=None, description=None, http_url_to_repo=None, id=None, issues_enabled=None, lfs_enabled=None, merge_requests_enabled=None, name=None, namespace_id=None, path=None, pipelines_enabled=None, remove_source_branch_after_merge=None, request_access_enabled=None, runners_token=None, snippets_enabled=None, ssh_url_to_repo=None, visibility_level=None, web_url=None, wiki_enabled=None)¶

class pulumi_gitlab.AwaitableGetProjectsResult(archived=None, group_id=None, id=None, include_subgroups=None, max_queryable_pages=None, membership=None, min_access_level=None, order_by=None, owned=None, page=None, per_page=None, projects=None, search=None, simple=None, sort=None, starred=None, statistics=None, visibility=None, with_custom_attributes=None, with_issues_enabled=None, with_merge_requests_enabled=None, with_programming_language=None, with_shared=None)¶

class pulumi_gitlab.AwaitableGetUserResult(avatar_url=None, bio=None, can_create_group=None, can_create_project=None, color_scheme_id=None, created_at=None, current_sign_in_at=None, email=None, extern_uid=None, external=None, id=None, is_admin=None, last_sign_in_at=None, linkedin=None, location=None, name=None, organization=None, projects_limit=None, skype=None, state=None, theme_id=None, twitter=None, two_factor_enabled=None, user_id=None, user_provider=None, username=None, website_url=None)¶

class pulumi_gitlab.AwaitableGetUsersResult(active=None, blocked=None, created_after=None, created_before=None, extern_provider=None, extern_uid=None, id=None, order_by=None, search=None, sort=None, users=None)¶

class pulumi_gitlab.BranchProtection(resource_name, opts=None, branch=None, merge_access_level=None, project=None, push_access_level=None, __props__=None, __name__=None, __opts__=None)¶

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.

import pulumi
import pulumi_gitlab as gitlab

branch_protect = gitlab.BranchProtection("branchProtect",
    branch="BranchProtected",
    merge_access_level="developer",
    project="12345",
    push_access_level="developer")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
branch (pulumi.Input[str]) – Name of the branch.
merge_access_level (pulumi.Input[str]) – One of five levels of access to the project.
project (pulumi.Input[str]) – The id of the project.
push_access_level (pulumi.Input[str]) – One of five levels of access to the project.

branch: pulumi.Output[str] = None¶: Name of the branch.

merge_access_level: pulumi.Output[str] = None¶: One of five levels of access to the project.

project: pulumi.Output[str] = None¶: The id of the project.

push_access_level: pulumi.Output[str] = None¶: One of five levels of access to the project.

static get(resource_name, id, opts=None, branch=None, merge_access_level=None, project=None, push_access_level=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
branch (pulumi.Input[str]) – Name of the branch.
merge_access_level (pulumi.Input[str]) – One of five levels of access to the project.
project (pulumi.Input[str]) – The id of the project.
push_access_level (pulumi.Input[str]) – One of five levels of access to the project.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gitlab.DeployKey(resource_name, opts=None, can_push=None, key=None, project=None, title=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_gitlab as gitlab

example = gitlab.DeployKey("example",
    key="ssh-rsa AAAA...",
    project="example/deploying",
    title="Example deploy key")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
can_push (pulumi.Input[bool]) – Allow this deploy key to be used to push changes to the project. Defaults to false. NOTE: this cannot currently be managed.
key (pulumi.Input[str]) – The public ssh key body.
project (pulumi.Input[str]) – The name or id of the project to add the deploy key to.
title (pulumi.Input[str]) – A title to describe the deploy key with.

can_push: pulumi.Output[bool] = None¶: Allow this deploy key to be used to push changes to the project. Defaults to false. NOTE: this cannot currently be managed.

key: pulumi.Output[str] = None¶: The public ssh key body.

project: pulumi.Output[str] = None¶: The name or id of the project to add the deploy key to.

title: pulumi.Output[str] = None¶: A title to describe the deploy key with.

static get(resource_name, id, opts=None, can_push=None, key=None, project=None, title=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
can_push (pulumi.Input[bool]) – Allow this deploy key to be used to push changes to the project. Defaults to false. NOTE: this cannot currently be managed.
key (pulumi.Input[str]) – The public ssh key body.
project (pulumi.Input[str]) – The name or id of the project to add the deploy key to.
title (pulumi.Input[str]) – A title to describe the deploy key with.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gitlab.DeployKeyEnable(resource_name, opts=None, can_push=None, key=None, key_id=None, project=None, title=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_gitlab as gitlab

# A repo to host the deployment key
parent_project = gitlab.Project("parentProject")
# A second repo to use the deployment key from the parent project
foo_project = gitlab.Project("fooProject")
# Upload a deployment key for the parent repo
parent_deploy_key = gitlab.DeployKey("parentDeployKey",
    key="ssh-rsa AAAA...",
    project=parent_project.id,
    title="Example deploy key")
# Enable the deployment key on the second repo
foo_deploy_key_enable = gitlab.DeployKeyEnable("fooDeployKeyEnable",
    key_id=parent_deploy_key.id,
    project=foo_project.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
key_id (pulumi.Input[str]) – The Gitlab key id for the pre-existing deploy key
project (pulumi.Input[str]) – The name or id of the project to add the deploy key to.

key_id: pulumi.Output[str] = None¶: The Gitlab key id for the pre-existing deploy key

project: pulumi.Output[str] = None¶: The name or id of the project to add the deploy key to.

static get(resource_name, id, opts=None, can_push=None, key=None, key_id=None, project=None, title=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
key_id (pulumi.Input[str]) – The Gitlab key id for the pre-existing deploy key
project (pulumi.Input[str]) – The name or id of the project to add the deploy key to.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gitlab.DeployToken(resource_name, opts=None, expires_at=None, group=None, name=None, project=None, scopes=None, username=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_gitlab as gitlab

example = gitlab.DeployToken("example",
    expires_at="2020-03-14T00:00:00.000Z",
    project="example/deploying",
    scopes=[
        "read_repository",
        "read_registry",
    ],
    username="example-username")

import pulumi
import pulumi_gitlab as gitlab

example = gitlab.DeployToken("example",
    group="example/deploying",
    scopes=["read_repository"])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
group (pulumi.Input[str]) – The name or id of the group to add the deploy token to. Either project or group must be set.
name (pulumi.Input[str]) – A name to describe the deploy token with.
project (pulumi.Input[str]) – The name or id of the project to add the deploy token to. Either project or group must be set.
scopes (pulumi.Input[list]) – Valid values: read_repository, read_registry.
username (pulumi.Input[str]) – A username for the deploy token. Default is gitlab+deploy-token-{n}.

group: pulumi.Output[str] = None¶: The name or id of the group to add the deploy token to. Either project or group must be set.

name: pulumi.Output[str] = None¶: A name to describe the deploy token with.

project: pulumi.Output[str] = None¶: The name or id of the project to add the deploy token to. Either project or group must be set.

scopes: pulumi.Output[list] = None¶: Valid values: read_repository, read_registry.

token: pulumi.Output[str] = None¶: The secret token. This is only populated when creating a new deploy token.

username: pulumi.Output[str] = None¶: A username for the deploy token. Default is gitlab+deploy-token-{n}.

static get(resource_name, id, opts=None, expires_at=None, group=None, name=None, project=None, scopes=None, token=None, username=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
group (pulumi.Input[str]) – The name or id of the group to add the deploy token to. Either project or group must be set.
name (pulumi.Input[str]) – A name to describe the deploy token with.
project (pulumi.Input[str]) – The name or id of the project to add the deploy token to. Either project or group must be set.
scopes (pulumi.Input[list]) – Valid values: read_repository, read_registry.
token (pulumi.Input[str]) – The secret token. This is only populated when creating a new deploy token.
username (pulumi.Input[str]) – A username for the deploy token. Default is gitlab+deploy-token-{n}.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gitlab.GetGroupResult(description=None, full_name=None, full_path=None, group_id=None, id=None, lfs_enabled=None, name=None, parent_id=None, path=None, request_access_enabled=None, runners_token=None, visibility_level=None, web_url=None)¶

A collection of values returned by getGroup.

description = None¶: The description of the group.

full_name = None¶: The full name of the group.

full_path = None¶: The full path of the group.

id = None¶: The provider-assigned unique ID for this managed resource.

lfs_enabled = None¶: Boolean, is LFS enabled for projects in this group.

name = None¶: The name of this group.

parent_id = None¶: Integer, ID of the parent group.

path = None¶: The path of the group.

request_access_enabled = None¶: Boolean, is request for access enabled to the group.

runners_token = None¶: The group level registration token to use during runner setup.

visibility_level = None¶: Visibility level of the group. Possible values are private, internal, public.

web_url = None¶: Web URL of the group.

class pulumi_gitlab.GetProjectResult(archived=None, default_branch=None, description=None, http_url_to_repo=None, id=None, issues_enabled=None, lfs_enabled=None, merge_requests_enabled=None, name=None, namespace_id=None, path=None, pipelines_enabled=None, remove_source_branch_after_merge=None, request_access_enabled=None, runners_token=None, snippets_enabled=None, ssh_url_to_repo=None, visibility_level=None, web_url=None, wiki_enabled=None)¶

A collection of values returned by getProject.

archived = None¶: Whether the project is in read-only mode (archived).

default_branch = None¶: The default branch for the project.

description = None¶: A description of the project.

http_url_to_repo = None¶: URL that can be provided to git clone to clone the repository via HTTP.

id = None¶: Integer that uniquely identifies the project within the gitlab install.

issues_enabled = None¶: Enable issue tracking for the project.

lfs_enabled = None¶: Enable LFS for the project.

merge_requests_enabled = None¶: Enable merge requests for the project.

namespace_id = None¶: The namespace (group or user) of the project. Defaults to your user. See .Group for an example.

path = None¶: The path of the repository.

pipelines_enabled = None¶: Enable pipelines for the project.

remove_source_branch_after_merge = None¶: Enable Delete source branch option by default for all new merge requests

request_access_enabled = None¶: Allow users to request member access.

runners_token = None¶: Registration token to use during runner setup.

snippets_enabled = None¶: Enable snippets for the project.

ssh_url_to_repo = None¶: URL that can be provided to git clone to clone the repository via SSH.

visibility_level = None¶: Repositories are created as private by default.

web_url = None¶: URL that can be used to find the project in a browser.

wiki_enabled = None¶: Enable wiki for the project.

class pulumi_gitlab.GetProjectsResult(archived=None, group_id=None, id=None, include_subgroups=None, max_queryable_pages=None, membership=None, min_access_level=None, order_by=None, owned=None, page=None, per_page=None, projects=None, search=None, simple=None, sort=None, starred=None, statistics=None, visibility=None, with_custom_attributes=None, with_issues_enabled=None, with_merge_requests_enabled=None, with_programming_language=None, with_shared=None)¶

A collection of values returned by getProjects.

id = None¶: The provider-assigned unique ID for this managed resource.

projects = None¶: A list containing the projects matching the supplied arguments

visibility = None¶: The visibility of the project.

class pulumi_gitlab.GetUserResult(avatar_url=None, bio=None, can_create_group=None, can_create_project=None, color_scheme_id=None, created_at=None, current_sign_in_at=None, email=None, extern_uid=None, external=None, id=None, is_admin=None, last_sign_in_at=None, linkedin=None, location=None, name=None, organization=None, projects_limit=None, skype=None, state=None, theme_id=None, twitter=None, two_factor_enabled=None, user_id=None, user_provider=None, username=None, website_url=None)¶

A collection of values returned by getUser.

avatar_url = None¶: The avatar URL of the user.

bio = None¶: The bio of the user.

can_create_group = None¶: Whether the user can create groups.

can_create_project = None¶: Whether the user can create projects.

color_scheme_id = None¶: User’s color scheme ID.

created_at = None¶: Date the user was created at.

current_sign_in_at = None¶: Current user’s sign-in date.

email = None¶: The e-mail address of the user.

extern_uid = None¶: The external UID of the user.

external = None¶: Whether the user is external.

id = None¶: The provider-assigned unique ID for this managed resource.

is_admin = None¶: Whether the user is an admin.

last_sign_in_at = None¶: Last user’s sign-in date.

linkedin = None¶: Linkedin profile of the user.

location = None¶: The location of the user.

name = None¶: The name of the user.

organization = None¶: The organization of the user.

projects_limit = None¶: Number of projects the user can create.

skype = None¶: Skype username of the user.

state = None¶: Whether the user is active or blocked.

theme_id = None¶: User’s theme ID.

twitter = None¶: Twitter username of the user.

two_factor_enabled = None¶: Whether user’s two factor auth is enabled.

user_provider = None¶: The UID provider of the user.

username = None¶: The username of the user.

website_url = None¶: User’s website URL.

class pulumi_gitlab.GetUsersResult(active=None, blocked=None, created_after=None, created_before=None, extern_provider=None, extern_uid=None, id=None, order_by=None, search=None, sort=None, users=None)¶

A collection of values returned by getUsers.

extern_uid = None¶: The external UID of the user.

id = None¶: The provider-assigned unique ID for this managed resource.

users = None¶: The list of users.

class pulumi_gitlab.Group(resource_name, opts=None, description=None, lfs_enabled=None, name=None, parent_id=None, path=None, request_access_enabled=None, visibility_level=None, __props__=None, __name__=None, __opts__=None)¶

Create a Group resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] description: The description of the group. :param pulumi.Input[bool] lfs_enabled: Boolean, defaults to true. Whether to enable LFS

support for projects in this group.

Parameters

name (pulumi.Input[str]) – The name of this group.
parent_id (pulumi.Input[float]) – Integer, id of the parent group (creates a nested group).
path (pulumi.Input[str]) – The path of the group.
request_access_enabled (pulumi.Input[bool]) – Boolean, defaults to false. Whether to enable users to request access to the group.
visibility_level (pulumi.Input[str]) – Set to public to create a public group. Valid values are private, internal, public. Groups are created as private by default.

description: pulumi.Output[str] = None¶: The description of the group.

full_name: pulumi.Output[str] = None¶: The full name of the group.

full_path: pulumi.Output[str] = None¶: The full path of the group.

lfs_enabled: pulumi.Output[bool] = None¶: Boolean, defaults to true. Whether to enable LFS support for projects in this group.

name: pulumi.Output[str] = None¶: The name of this group.

parent_id: pulumi.Output[float] = None¶: Integer, id of the parent group (creates a nested group).

path: pulumi.Output[str] = None¶: The path of the group.

request_access_enabled: pulumi.Output[bool] = None¶: Boolean, defaults to false. Whether to enable users to request access to the group.

runners_token: pulumi.Output[str] = None¶: The group level registration token to use during runner setup.

visibility_level: pulumi.Output[str] = None¶: Set to public to create a public group. Valid values are private, internal, public. Groups are created as private by default.

web_url: pulumi.Output[str] = None¶: Web URL of the group.

static get(resource_name, id, opts=None, description=None, full_name=None, full_path=None, lfs_enabled=None, name=None, parent_id=None, path=None, request_access_enabled=None, runners_token=None, visibility_level=None, web_url=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The description of the group.
full_name (pulumi.Input[str]) – The full name of the group.
full_path (pulumi.Input[str]) – The full path of the group.
lfs_enabled (pulumi.Input[bool]) – Boolean, defaults to true. Whether to enable LFS support for projects in this group.
name (pulumi.Input[str]) – The name of this group.
parent_id (pulumi.Input[float]) – Integer, id of the parent group (creates a nested group).
path (pulumi.Input[str]) – The path of the group.
request_access_enabled (pulumi.Input[bool]) – Boolean, defaults to false. Whether to enable users to request access to the group.
runners_token (pulumi.Input[str]) – The group level registration token to use during runner setup.
visibility_level (pulumi.Input[str]) – Set to public to create a public group. Valid values are private, internal, public. Groups are created as private by default.
web_url (pulumi.Input[str]) – Web URL of the group.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gitlab.GroupCluster(resource_name, opts=None, domain=None, enabled=None, environment_scope=None, group=None, kubernetes_api_url=None, kubernetes_authorization_type=None, kubernetes_ca_cert=None, kubernetes_token=None, managed=None, management_project_id=None, name=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_gitlab as gitlab

foo = gitlab.Group("foo", path="foo-path")
bar = gitlab.GroupCluster("bar",
    domain="example.com",
    enabled=True,
    environment_scope="*",
    group=foo.id,
    kubernetes_api_url="https://124.124.124",
    kubernetes_authorization_type="rbac",
    kubernetes_ca_cert="some-cert",
    kubernetes_token="some-token",
    management_cluster_id="123456")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
domain (pulumi.Input[str]) – The base domain of the cluster.
enabled (pulumi.Input[bool]) – Determines if cluster is active or not. Defaults to true. This attribute cannot be read.
environment_scope (pulumi.Input[str]) – The associated environment to the cluster. Defaults to *.
group (pulumi.Input[str]) – The id of the group to add the cluster to.
kubernetes_api_url (pulumi.Input[str]) – The URL to access the Kubernetes API.
kubernetes_authorization_type (pulumi.Input[str]) – The cluster authorization type. Valid values are rbac, abac, unknown_authorization. Defaults to rbac.
kubernetes_ca_cert (pulumi.Input[str]) – TLS certificate (needed if API is using a self-signed TLS certificate).
kubernetes_token (pulumi.Input[str]) – The token to authenticate against Kubernetes.
managed (pulumi.Input[bool]) – Determines if cluster is managed by gitlab or not. Defaults to true. This attribute cannot be read.
name (pulumi.Input[str]) – The name of cluster.

domain: pulumi.Output[str] = None¶: The base domain of the cluster.

enabled: pulumi.Output[bool] = None¶: Determines if cluster is active or not. Defaults to true. This attribute cannot be read.

environment_scope: pulumi.Output[str] = None¶: The associated environment to the cluster. Defaults to *.

group: pulumi.Output[str] = None¶: The id of the group to add the cluster to.

kubernetes_api_url: pulumi.Output[str] = None¶: The URL to access the Kubernetes API.

kubernetes_authorization_type: pulumi.Output[str] = None¶: The cluster authorization type. Valid values are rbac, abac, unknown_authorization. Defaults to rbac.

kubernetes_ca_cert: pulumi.Output[str] = None¶: TLS certificate (needed if API is using a self-signed TLS certificate).

kubernetes_token: pulumi.Output[str] = None¶: The token to authenticate against Kubernetes.

managed: pulumi.Output[bool] = None¶: Determines if cluster is managed by gitlab or not. Defaults to true. This attribute cannot be read.

name: pulumi.Output[str] = None¶: The name of cluster.

static get(resource_name, id, opts=None, cluster_type=None, created_at=None, domain=None, enabled=None, environment_scope=None, group=None, kubernetes_api_url=None, kubernetes_authorization_type=None, kubernetes_ca_cert=None, kubernetes_token=None, managed=None, management_project_id=None, name=None, platform_type=None, provider_type=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
domain (pulumi.Input[str]) – The base domain of the cluster.
enabled (pulumi.Input[bool]) – Determines if cluster is active or not. Defaults to true. This attribute cannot be read.
environment_scope (pulumi.Input[str]) – The associated environment to the cluster. Defaults to *.
group (pulumi.Input[str]) – The id of the group to add the cluster to.
kubernetes_api_url (pulumi.Input[str]) – The URL to access the Kubernetes API.
kubernetes_authorization_type (pulumi.Input[str]) – The cluster authorization type. Valid values are rbac, abac, unknown_authorization. Defaults to rbac.
kubernetes_ca_cert (pulumi.Input[str]) – TLS certificate (needed if API is using a self-signed TLS certificate).
kubernetes_token (pulumi.Input[str]) – The token to authenticate against Kubernetes.
managed (pulumi.Input[bool]) – Determines if cluster is managed by gitlab or not. Defaults to true. This attribute cannot be read.
name (pulumi.Input[str]) – The name of cluster.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gitlab.GroupLabel(resource_name, opts=None, color=None, description=None, group=None, name=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_gitlab as gitlab

fixme = gitlab.GroupLabel("fixme",
    color="#ffcc00",
    description="issue with failing tests",
    group="example")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
color (pulumi.Input[str]) – The color of the label given in 6-digit hex notation with leading ‘#’ sign (e.g. #FFAABB) or one of the CSS color names.
description (pulumi.Input[str]) – The description of the label.
group (pulumi.Input[str]) – The name or id of the group to add the label to.
name (pulumi.Input[str]) – The name of the label.

color: pulumi.Output[str] = None¶: The color of the label given in 6-digit hex notation with leading ‘#’ sign (e.g. #FFAABB) or one of the CSS color names.

description: pulumi.Output[str] = None¶: The description of the label.

group: pulumi.Output[str] = None¶: The name or id of the group to add the label to.

name: pulumi.Output[str] = None¶: The name of the label.

static get(resource_name, id, opts=None, color=None, description=None, group=None, name=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
color (pulumi.Input[str]) –
The color of the label given in 6-digit hex notation with leading ‘#’ sign (e.g. #FFAABB) or one of the CSS color names.
description (pulumi.Input[str]) – The description of the label.
group (pulumi.Input[str]) – The name or id of the group to add the label to.
name (pulumi.Input[str]) – The name of the label.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gitlab.GroupLdapLink(resource_name, opts=None, access_level=None, cn=None, force=None, group_id=None, ldap_provider=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_gitlab as gitlab

test = gitlab.GroupLdapLink("test",
    access_level="developer",
    cn="testuser",
    group_id="12345",
    ldap_provider="ldapmain")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
access_level (pulumi.Input[str]) – Acceptable values are: guest, reporter, developer, maintainer, owner.
cn (pulumi.Input[str]) – The CN of the LDAP group to link with.
group_id (pulumi.Input[str]) – The id of the GitLab group.
ldap_provider (pulumi.Input[str]) – The name of the LDAP provider as stored in the GitLab database.

access_level: pulumi.Output[str] = None¶: Acceptable values are: guest, reporter, developer, maintainer, owner.

cn: pulumi.Output[str] = None¶: The CN of the LDAP group to link with.

group_id: pulumi.Output[str] = None¶: The id of the GitLab group.

ldap_provider: pulumi.Output[str] = None¶: The name of the LDAP provider as stored in the GitLab database.

static get(resource_name, id, opts=None, access_level=None, cn=None, force=None, group_id=None, ldap_provider=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
access_level (pulumi.Input[str]) – Acceptable values are: guest, reporter, developer, maintainer, owner.
cn (pulumi.Input[str]) – The CN of the LDAP group to link with.
group_id (pulumi.Input[str]) – The id of the GitLab group.
ldap_provider (pulumi.Input[str]) – The name of the LDAP provider as stored in the GitLab database.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gitlab.GroupMembership(resource_name, opts=None, access_level=None, expires_at=None, group_id=None, user_id=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_gitlab as gitlab

test = gitlab.GroupMembership("test",
    access_level="guest",
    expires_at="2020-12-31",
    group_id="12345",
    user_id=1337)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
access_level (pulumi.Input[str]) – Acceptable values are: guest, reporter, developer, maintainer, owner.
expires_at (pulumi.Input[str]) – Expiration date for the group membership. Format: YYYY-MM-DD
group_id (pulumi.Input[str]) – The id of the group.
user_id (pulumi.Input[float]) – The id of the user.

access_level: pulumi.Output[str] = None¶: Acceptable values are: guest, reporter, developer, maintainer, owner.

expires_at: pulumi.Output[str] = None¶: Expiration date for the group membership. Format: YYYY-MM-DD

group_id: pulumi.Output[str] = None¶: The id of the group.

user_id: pulumi.Output[float] = None¶: The id of the user.

static get(resource_name, id, opts=None, access_level=None, expires_at=None, group_id=None, user_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
access_level (pulumi.Input[str]) – Acceptable values are: guest, reporter, developer, maintainer, owner.
expires_at (pulumi.Input[str]) – Expiration date for the group membership. Format: YYYY-MM-DD
group_id (pulumi.Input[str]) – The id of the group.
user_id (pulumi.Input[float]) – The id of the user.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gitlab.GroupVariable(resource_name, opts=None, group=None, key=None, masked=None, protected=None, value=None, variable_type=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_gitlab as gitlab

example = gitlab.GroupVariable("example",
    group="12345",
    key="group_variable_key",
    masked=False,
    protected=False,
    value="group_variable_value")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
group (pulumi.Input[str]) – The name or id of the group to add the hook to.
key (pulumi.Input[str]) – The name of the variable.
protected (pulumi.Input[bool]) – If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.
value (pulumi.Input[str]) – The value of the variable.
variable_type (pulumi.Input[str]) – The type of a variable. Available types are: env_var (default) and file.

group: pulumi.Output[str] = None¶: The name or id of the group to add the hook to.

key: pulumi.Output[str] = None¶: The name of the variable.

protected: pulumi.Output[bool] = None¶: If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.

value: pulumi.Output[str] = None¶: The value of the variable.

variable_type: pulumi.Output[str] = None¶: The type of a variable. Available types are: env_var (default) and file.

static get(resource_name, id, opts=None, group=None, key=None, masked=None, protected=None, value=None, variable_type=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
group (pulumi.Input[str]) – The name or id of the group to add the hook to.
key (pulumi.Input[str]) – The name of the variable.
protected (pulumi.Input[bool]) – If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.
value (pulumi.Input[str]) – The value of the variable.
variable_type (pulumi.Input[str]) – The type of a variable. Available types are: env_var (default) and file.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gitlab.Label(resource_name, opts=None, color=None, description=None, name=None, project=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_gitlab as gitlab

fixme = gitlab.Label("fixme",
    color="#ffcc00",
    description="issue with failing tests",
    project="example")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
color (pulumi.Input[str]) –
The color of the label given in 6-digit hex notation with leading ‘#’ sign (e.g. #FFAABB) or one of the CSS color names.
description (pulumi.Input[str]) – The description of the label.
name (pulumi.Input[str]) – The name of the label.
project (pulumi.Input[str]) – The name or id of the project to add the label to.

color: pulumi.Output[str] = None¶: The color of the label given in 6-digit hex notation with leading ‘#’ sign (e.g. #FFAABB) or one of the CSS color names.

description: pulumi.Output[str] = None¶: The description of the label.

name: pulumi.Output[str] = None¶: The name of the label.

project: pulumi.Output[str] = None¶: The name or id of the project to add the label to.

static get(resource_name, id, opts=None, color=None, description=None, name=None, project=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
color (pulumi.Input[str]) –
The color of the label given in 6-digit hex notation with leading ‘#’ sign (e.g. #FFAABB) or one of the CSS color names.
description (pulumi.Input[str]) – The description of the label.
name (pulumi.Input[str]) – The name of the label.
project (pulumi.Input[str]) – The name or id of the project to add the label to.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gitlab.PipelineSchedule(resource_name, opts=None, active=None, cron=None, cron_timezone=None, description=None, project=None, ref=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_gitlab as gitlab

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

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
active (pulumi.Input[bool]) – The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially.
cron (pulumi.Input[str]) – The cron (e.g. 0 1 * * *).
cron_timezone (pulumi.Input[str]) – The timezone.
description (pulumi.Input[str]) – The description of the pipeline schedule.
project (pulumi.Input[str]) – The name or id of the project to add the schedule to.
ref (pulumi.Input[str]) – The branch/tag name to be triggered.

active: pulumi.Output[bool] = None¶: The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially.

cron: pulumi.Output[str] = None¶: The cron (e.g. 0 1 * * *).

cron_timezone: pulumi.Output[str] = None¶: The timezone.

description: pulumi.Output[str] = None¶: The description of the pipeline schedule.

project: pulumi.Output[str] = None¶: The name or id of the project to add the schedule to.

ref: pulumi.Output[str] = None¶: The branch/tag name to be triggered.

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

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
active (pulumi.Input[bool]) – The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially.
cron (pulumi.Input[str]) – The cron (e.g. 0 1 * * *).
cron_timezone (pulumi.Input[str]) – The timezone.
description (pulumi.Input[str]) – The description of the pipeline schedule.
project (pulumi.Input[str]) – The name or id of the project to add the schedule to.
ref (pulumi.Input[str]) – The branch/tag name to be triggered.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gitlab.PipelineScheduleVariable(resource_name, opts=None, key=None, pipeline_schedule_id=None, project=None, value=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_gitlab as gitlab

example_pipeline_schedule = gitlab.PipelineSchedule("examplePipelineSchedule",
    project="12345",
    description="Used to schedule builds",
    ref="master",
    cron="0 1 * * *")
example_pipeline_schedule_variable = gitlab.PipelineScheduleVariable("examplePipelineScheduleVariable",
    project=gitlab_pipeline_schedule["project"],
    pipeline_schedule_id=gitlab_pipeline_schedule["id"],
    key="EXAMPLE_KEY",
    value="example")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
key (pulumi.Input[str]) – Name of the variable.
pipeline_schedule_id (pulumi.Input[float]) – The id of the pipeline schedule.
project (pulumi.Input[str]) – The id of the project to add the schedule to.
value (pulumi.Input[str]) – Value of the variable.

key: pulumi.Output[str] = None¶: Name of the variable.

pipeline_schedule_id: pulumi.Output[float] = None¶: The id of the pipeline schedule.

project: pulumi.Output[str] = None¶: The id of the project to add the schedule to.

value: pulumi.Output[str] = None¶: Value of the variable.

static get(resource_name, id, opts=None, key=None, pipeline_schedule_id=None, project=None, value=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
key (pulumi.Input[str]) – Name of the variable.
pipeline_schedule_id (pulumi.Input[float]) – The id of the pipeline schedule.
project (pulumi.Input[str]) – The id of the project to add the schedule to.
value (pulumi.Input[str]) – Value of the variable.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gitlab.PipelineTrigger(resource_name, opts=None, description=None, project=None, __props__=None, __name__=None, __opts__=None)¶

This resource allows you to create and manage pipeline triggers

import pulumi
import pulumi_gitlab as gitlab

example = gitlab.PipelineTrigger("example",
    description="Used to trigger builds",
    project="12345")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The description of the pipeline trigger.
project (pulumi.Input[str]) – The name or id of the project to add the trigger to.

description: pulumi.Output[str] = None¶: The description of the pipeline trigger.

project: pulumi.Output[str] = None¶: The name or id of the project to add the trigger to.

static get(resource_name, id, opts=None, description=None, project=None, token=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The description of the pipeline trigger.
project (pulumi.Input[str]) – The name or id of the project to add the trigger to.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gitlab.Project(resource_name, opts=None, approvals_before_merge=None, archived=None, container_registry_enabled=None, default_branch=None, description=None, initialize_with_readme=None, issues_enabled=None, lfs_enabled=None, merge_method=None, merge_requests_enabled=None, name=None, namespace_id=None, only_allow_merge_if_all_discussions_are_resolved=None, only_allow_merge_if_pipeline_succeeds=None, path=None, pipelines_enabled=None, remove_source_branch_after_merge=None, request_access_enabled=None, shared_runners_enabled=None, shared_with_groups=None, snippets_enabled=None, tags=None, visibility_level=None, wiki_enabled=None, __props__=None, __name__=None, __opts__=None)¶

Create a Project resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[float] approvals_before_merge: Number of merge request approvals required for merging. Default is 0. :param pulumi.Input[bool] archived: Whether the project is in read-only mode (archived). Repositories can be archived/unarchived by toggling this parameter. :param pulumi.Input[bool] container_registry_enabled: Enable container registry for the project. :param pulumi.Input[str] default_branch: The default branch for the project. :param pulumi.Input[str] description: A description of the project. :param pulumi.Input[bool] initialize_with_readme: Create master branch with first commit containing a README.md file. :param pulumi.Input[bool] issues_enabled: Enable issue tracking for the project. :param pulumi.Input[bool] lfs_enabled: Enable LFS for the project. :param pulumi.Input[str] merge_method: Set to ff to create fast-forward merges

Valid values are merge, rebase_merge, ff Repositories are created with merge by default

Parameters

merge_requests_enabled (pulumi.Input[bool]) – Enable merge requests for the project.
name (pulumi.Input[str]) – The name of the project.
namespace_id (pulumi.Input[float]) – The namespace (group or user) of the project. Defaults to your user. See .Group for an example.
only_allow_merge_if_all_discussions_are_resolved (pulumi.Input[bool]) – Set to true if you want allow merges only if all discussions are resolved.
only_allow_merge_if_pipeline_succeeds (pulumi.Input[bool]) – Set to true if you want allow merges only if a pipeline succeeds.
path (pulumi.Input[str]) – The path of the repository.
pipelines_enabled (pulumi.Input[bool]) – Enable pipelines for the project.
remove_source_branch_after_merge (pulumi.Input[bool]) – Enable Delete source branch option by default for all new merge requests.
request_access_enabled (pulumi.Input[bool]) – Allow users to request member access.
shared_runners_enabled (pulumi.Input[bool]) – Enable shared runners for this project.
shared_with_groups (pulumi.Input[list]) – Enable sharing the project with a list of groups (maps).
snippets_enabled (pulumi.Input[bool]) – Enable snippets for the project.
tags (pulumi.Input[list]) – Tags (topics) of the project.
visibility_level (pulumi.Input[str]) – Set to public to create a public project. Valid values are private, internal, public. Repositories are created as private by default.
wiki_enabled (pulumi.Input[bool]) – Enable wiki for the project.

The shared_with_groups object supports the following:

groupAccessLevel (pulumi.Input[str]) - Group’s sharing permissions. See [group members permission][group_members_permissions] for more info. Valid values are guest, reporter, developer, master.
group_id (pulumi.Input[float]) - Group id of the group you want to share the project with.
groupName (pulumi.Input[str]) - Group’s name.

approvals_before_merge: pulumi.Output[float] = None¶: Number of merge request approvals required for merging. Default is 0.

archived: pulumi.Output[bool] = None¶: Whether the project is in read-only mode (archived). Repositories can be archived/unarchived by toggling this parameter.

container_registry_enabled: pulumi.Output[bool] = None¶: Enable container registry for the project.

default_branch: pulumi.Output[str] = None¶: The default branch for the project.

description: pulumi.Output[str] = None¶: A description of the project.

http_url_to_repo: pulumi.Output[str] = None¶: URL that can be provided to git clone to clone the repository via HTTP.

initialize_with_readme: pulumi.Output[bool] = None¶: Create master branch with first commit containing a README.md file.

issues_enabled: pulumi.Output[bool] = None¶: Enable issue tracking for the project.

lfs_enabled: pulumi.Output[bool] = None¶: Enable LFS for the project.

merge_method: pulumi.Output[str] = None¶: Set to ff to create fast-forward merges Valid values are merge, rebase_merge, ff Repositories are created with merge by default

merge_requests_enabled: pulumi.Output[bool] = None¶: Enable merge requests for the project.

name: pulumi.Output[str] = None¶: The name of the project.

namespace_id: pulumi.Output[float] = None¶: The namespace (group or user) of the project. Defaults to your user. See .Group for an example.

only_allow_merge_if_all_discussions_are_resolved: pulumi.Output[bool] = None¶: Set to true if you want allow merges only if all discussions are resolved.

only_allow_merge_if_pipeline_succeeds: pulumi.Output[bool] = None¶: Set to true if you want allow merges only if a pipeline succeeds.

path: pulumi.Output[str] = None¶: The path of the repository.

pipelines_enabled: pulumi.Output[bool] = None¶: Enable pipelines for the project.

remove_source_branch_after_merge: pulumi.Output[bool] = None¶: Enable Delete source branch option by default for all new merge requests.

request_access_enabled: pulumi.Output[bool] = None¶: Allow users to request member access.

runners_token: pulumi.Output[str] = None¶: Registration token to use during runner setup.

shared_runners_enabled: pulumi.Output[bool] = None¶: Enable shared runners for this project.

shared_with_groups: pulumi.Output[list] = None¶

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

groupAccessLevel (str) - Group’s sharing permissions. See [group members permission][group_members_permissions] for more info. Valid values are guest, reporter, developer, master.
group_id (float) - Group id of the group you want to share the project with.
groupName (str) - Group’s name.

snippets_enabled: pulumi.Output[bool] = None¶: Enable snippets for the project.

ssh_url_to_repo: pulumi.Output[str] = None¶: URL that can be provided to git clone to clone the repository via SSH.

tags: pulumi.Output[list] = None¶: Tags (topics) of the project.

visibility_level: pulumi.Output[str] = None¶: Set to public to create a public project. Valid values are private, internal, public. Repositories are created as private by default.

web_url: pulumi.Output[str] = None¶: URL that can be used to find the project in a browser.

wiki_enabled: pulumi.Output[bool] = None¶: Enable wiki for the project.

static get(resource_name, id, opts=None, approvals_before_merge=None, archived=None, container_registry_enabled=None, default_branch=None, description=None, http_url_to_repo=None, initialize_with_readme=None, issues_enabled=None, lfs_enabled=None, merge_method=None, merge_requests_enabled=None, name=None, namespace_id=None, only_allow_merge_if_all_discussions_are_resolved=None, only_allow_merge_if_pipeline_succeeds=None, path=None, pipelines_enabled=None, remove_source_branch_after_merge=None, request_access_enabled=None, runners_token=None, shared_runners_enabled=None, shared_with_groups=None, snippets_enabled=None, ssh_url_to_repo=None, tags=None, visibility_level=None, web_url=None, wiki_enabled=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
approvals_before_merge (pulumi.Input[float]) – Number of merge request approvals required for merging. Default is 0.
archived (pulumi.Input[bool]) – Whether the project is in read-only mode (archived). Repositories can be archived/unarchived by toggling this parameter.
container_registry_enabled (pulumi.Input[bool]) – Enable container registry for the project.
default_branch (pulumi.Input[str]) – The default branch for the project.
description (pulumi.Input[str]) – A description of the project.
http_url_to_repo (pulumi.Input[str]) – URL that can be provided to git clone to clone the repository via HTTP.
initialize_with_readme (pulumi.Input[bool]) – Create master branch with first commit containing a README.md file.
issues_enabled (pulumi.Input[bool]) – Enable issue tracking for the project.
lfs_enabled (pulumi.Input[bool]) – Enable LFS for the project.
merge_method (pulumi.Input[str]) – Set to ff to create fast-forward merges Valid values are merge, rebase_merge, ff Repositories are created with merge by default
merge_requests_enabled (pulumi.Input[bool]) – Enable merge requests for the project.
name (pulumi.Input[str]) – The name of the project.
namespace_id (pulumi.Input[float]) – The namespace (group or user) of the project. Defaults to your user. See .Group for an example.
only_allow_merge_if_all_discussions_are_resolved (pulumi.Input[bool]) – Set to true if you want allow merges only if all discussions are resolved.
only_allow_merge_if_pipeline_succeeds (pulumi.Input[bool]) – Set to true if you want allow merges only if a pipeline succeeds.
path (pulumi.Input[str]) – The path of the repository.
pipelines_enabled (pulumi.Input[bool]) – Enable pipelines for the project.
remove_source_branch_after_merge (pulumi.Input[bool]) – Enable Delete source branch option by default for all new merge requests.
request_access_enabled (pulumi.Input[bool]) – Allow users to request member access.
runners_token (pulumi.Input[str]) – Registration token to use during runner setup.
shared_runners_enabled (pulumi.Input[bool]) – Enable shared runners for this project.
shared_with_groups (pulumi.Input[list]) – Enable sharing the project with a list of groups (maps).
snippets_enabled (pulumi.Input[bool]) – Enable snippets for the project.
ssh_url_to_repo (pulumi.Input[str]) – URL that can be provided to git clone to clone the repository via SSH.
tags (pulumi.Input[list]) – Tags (topics) of the project.
visibility_level (pulumi.Input[str]) – Set to public to create a public project. Valid values are private, internal, public. Repositories are created as private by default.
web_url (pulumi.Input[str]) – URL that can be used to find the project in a browser.
wiki_enabled (pulumi.Input[bool]) – Enable wiki for the project.

The shared_with_groups object supports the following:

groupAccessLevel (pulumi.Input[str]) - Group’s sharing permissions. See [group members permission][group_members_permissions] for more info. Valid values are guest, reporter, developer, master.
group_id (pulumi.Input[float]) - Group id of the group you want to share the project with.
groupName (pulumi.Input[str]) - Group’s name.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gitlab.ProjectCluster(resource_name, opts=None, domain=None, enabled=None, environment_scope=None, kubernetes_api_url=None, kubernetes_authorization_type=None, kubernetes_ca_cert=None, kubernetes_namespace=None, kubernetes_token=None, managed=None, management_project_id=None, name=None, project=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_gitlab as gitlab

foo = gitlab.Project("foo")
bar = gitlab.ProjectCluster("bar",
    domain="example.com",
    enabled=True,
    environment_scope="*",
    kubernetes_api_url="https://124.124.124",
    kubernetes_authorization_type="rbac",
    kubernetes_ca_cert="some-cert",
    kubernetes_namespace="namespace",
    kubernetes_token="some-token",
    management_cluster_id="123456",
    project=foo.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
domain (pulumi.Input[str]) – The base domain of the cluster.
enabled (pulumi.Input[bool]) – Determines if cluster is active or not. Defaults to true. This attribute cannot be read.
environment_scope (pulumi.Input[str]) – The associated environment to the cluster. Defaults to *.
kubernetes_api_url (pulumi.Input[str]) – The URL to access the Kubernetes API.
kubernetes_authorization_type (pulumi.Input[str]) – The cluster authorization type. Valid values are rbac, abac, unknown_authorization. Defaults to rbac.
kubernetes_ca_cert (pulumi.Input[str]) – TLS certificate (needed if API is using a self-signed TLS certificate).
kubernetes_namespace (pulumi.Input[str]) – The unique namespace related to the project.
kubernetes_token (pulumi.Input[str]) – The token to authenticate against Kubernetes.
managed (pulumi.Input[bool]) – Determines if cluster is managed by gitlab or not. Defaults to true. This attribute cannot be read.
name (pulumi.Input[str]) – The name of cluster.
project (pulumi.Input[str]) – The id of the project to add the cluster to.

domain: pulumi.Output[str] = None¶: The base domain of the cluster.

enabled: pulumi.Output[bool] = None¶: Determines if cluster is active or not. Defaults to true. This attribute cannot be read.

environment_scope: pulumi.Output[str] = None¶: The associated environment to the cluster. Defaults to *.

kubernetes_api_url: pulumi.Output[str] = None¶: The URL to access the Kubernetes API.

kubernetes_authorization_type: pulumi.Output[str] = None¶: The cluster authorization type. Valid values are rbac, abac, unknown_authorization. Defaults to rbac.

kubernetes_ca_cert: pulumi.Output[str] = None¶: TLS certificate (needed if API is using a self-signed TLS certificate).

kubernetes_namespace: pulumi.Output[str] = None¶: The unique namespace related to the project.

kubernetes_token: pulumi.Output[str] = None¶: The token to authenticate against Kubernetes.

managed: pulumi.Output[bool] = None¶: Determines if cluster is managed by gitlab or not. Defaults to true. This attribute cannot be read.

name: pulumi.Output[str] = None¶: The name of cluster.

project: pulumi.Output[str] = None¶: The id of the project to add the cluster to.

static get(resource_name, id, opts=None, cluster_type=None, created_at=None, domain=None, enabled=None, environment_scope=None, kubernetes_api_url=None, kubernetes_authorization_type=None, kubernetes_ca_cert=None, kubernetes_namespace=None, kubernetes_token=None, managed=None, management_project_id=None, name=None, platform_type=None, project=None, provider_type=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
domain (pulumi.Input[str]) – The base domain of the cluster.
enabled (pulumi.Input[bool]) – Determines if cluster is active or not. Defaults to true. This attribute cannot be read.
environment_scope (pulumi.Input[str]) – The associated environment to the cluster. Defaults to *.
kubernetes_api_url (pulumi.Input[str]) – The URL to access the Kubernetes API.
kubernetes_authorization_type (pulumi.Input[str]) – The cluster authorization type. Valid values are rbac, abac, unknown_authorization. Defaults to rbac.
kubernetes_ca_cert (pulumi.Input[str]) – TLS certificate (needed if API is using a self-signed TLS certificate).
kubernetes_namespace (pulumi.Input[str]) – The unique namespace related to the project.
kubernetes_token (pulumi.Input[str]) – The token to authenticate against Kubernetes.
managed (pulumi.Input[bool]) – Determines if cluster is managed by gitlab or not. Defaults to true. This attribute cannot be read.
name (pulumi.Input[str]) – The name of cluster.
project (pulumi.Input[str]) – The id of the project to add the cluster to.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gitlab.ProjectHook(resource_name, opts=None, enable_ssl_verification=None, issues_events=None, job_events=None, merge_requests_events=None, note_events=None, pipeline_events=None, project=None, push_events=None, tag_push_events=None, token=None, url=None, wiki_page_events=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_gitlab as gitlab

example = gitlab.ProjectHook("example",
    merge_requests_events=True,
    project="example/hooked",
    url="https://example.com/hook/example")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
enable_ssl_verification (pulumi.Input[bool]) – Enable ssl verification when invoking the hook.
issues_events (pulumi.Input[bool]) – Invoke the hook for issues events.
job_events (pulumi.Input[bool]) – Invoke the hook for job events.
merge_requests_events (pulumi.Input[bool]) – Invoke the hook for merge requests.
note_events (pulumi.Input[bool]) – Invoke the hook for notes events.
pipeline_events (pulumi.Input[bool]) – Invoke the hook for pipeline events.
project (pulumi.Input[str]) – The name or id of the project to add the hook to.
push_events (pulumi.Input[bool]) – Invoke the hook for push events.
tag_push_events (pulumi.Input[bool]) – Invoke the hook for tag push events.
token (pulumi.Input[str]) – A token to present when invoking the hook.
url (pulumi.Input[str]) – The url of the hook to invoke.
wiki_page_events (pulumi.Input[bool]) – Invoke the hook for wiki page events.

enable_ssl_verification: pulumi.Output[bool] = None¶: Enable ssl verification when invoking the hook.

issues_events: pulumi.Output[bool] = None¶: Invoke the hook for issues events.

job_events: pulumi.Output[bool] = None¶: Invoke the hook for job events.

merge_requests_events: pulumi.Output[bool] = None¶: Invoke the hook for merge requests.

note_events: pulumi.Output[bool] = None¶: Invoke the hook for notes events.

pipeline_events: pulumi.Output[bool] = None¶: Invoke the hook for pipeline events.

project: pulumi.Output[str] = None¶: The name or id of the project to add the hook to.

push_events: pulumi.Output[bool] = None¶: Invoke the hook for push events.

tag_push_events: pulumi.Output[bool] = None¶: Invoke the hook for tag push events.

token: pulumi.Output[str] = None¶: A token to present when invoking the hook.

url: pulumi.Output[str] = None¶: The url of the hook to invoke.

wiki_page_events: pulumi.Output[bool] = None¶: Invoke the hook for wiki page events.

static get(resource_name, id, opts=None, enable_ssl_verification=None, issues_events=None, job_events=None, merge_requests_events=None, note_events=None, pipeline_events=None, project=None, push_events=None, tag_push_events=None, token=None, url=None, wiki_page_events=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
enable_ssl_verification (pulumi.Input[bool]) – Enable ssl verification when invoking the hook.
issues_events (pulumi.Input[bool]) – Invoke the hook for issues events.
job_events (pulumi.Input[bool]) – Invoke the hook for job events.
merge_requests_events (pulumi.Input[bool]) – Invoke the hook for merge requests.
note_events (pulumi.Input[bool]) – Invoke the hook for notes events.
pipeline_events (pulumi.Input[bool]) – Invoke the hook for pipeline events.
project (pulumi.Input[str]) – The name or id of the project to add the hook to.
push_events (pulumi.Input[bool]) – Invoke the hook for push events.
tag_push_events (pulumi.Input[bool]) – Invoke the hook for tag push events.
token (pulumi.Input[str]) – A token to present when invoking the hook.
url (pulumi.Input[str]) – The url of the hook to invoke.
wiki_page_events (pulumi.Input[bool]) – Invoke the hook for wiki page events.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gitlab.ProjectMembership(resource_name, opts=None, access_level=None, project_id=None, user_id=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_gitlab as gitlab

test = gitlab.ProjectMembership("test",
    access_level="guest",
    project_id="12345",
    user_id=1337)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
access_level (pulumi.Input[str]) – One of five levels of access to the project.
project_id (pulumi.Input[str]) – The id of the project.
user_id (pulumi.Input[float]) – The id of the user.

access_level: pulumi.Output[str] = None¶: One of five levels of access to the project.

project_id: pulumi.Output[str] = None¶: The id of the project.

user_id: pulumi.Output[float] = None¶: The id of the user.

static get(resource_name, id, opts=None, access_level=None, project_id=None, user_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
access_level (pulumi.Input[str]) – One of five levels of access to the project.
project_id (pulumi.Input[str]) – The id of the project.
user_id (pulumi.Input[float]) – The id of the user.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gitlab.ProjectPushRules(resource_name, opts=None, author_email_regex=None, branch_name_regex=None, commit_message_regex=None, deny_delete_tag=None, file_name_regex=None, max_file_size=None, member_check=None, prevent_secrets=None, project=None, __props__=None, __name__=None, __opts__=None)¶

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

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
author_email_regex (pulumi.Input[str]) – All commit author emails must match this regex, e.g. “@my-company.com$”
branch_name_regex (pulumi.Input[str]) – All branch names must match this regex, e.g. “(feature|hotfix)/*”
commit_message_regex (pulumi.Input[str]) – All commit messages must match this regex, e.g. “Fixed d+..*”
deny_delete_tag (pulumi.Input[bool]) – Deny deleting a tag
file_name_regex (pulumi.Input[str]) – All commited filenames must not match this regex, e.g. “(jar|exe)$”
max_file_size (pulumi.Input[float]) – Maximum file size (MB)
member_check (pulumi.Input[bool]) – Restrict commits by author (email) to existing GitLab users
prevent_secrets (pulumi.Input[bool]) – GitLab will reject any files that are likely to contain secrets
project (pulumi.Input[str]) – The name or id of the project to add the push rules to.

author_email_regex: pulumi.Output[str] = None¶: All commit author emails must match this regex, e.g. “@my-company.com$”

branch_name_regex: pulumi.Output[str] = None¶: All branch names must match this regex, e.g. “(feature|hotfix)/*”

commit_message_regex: pulumi.Output[str] = None¶: All commit messages must match this regex, e.g. “Fixed d+..*”

deny_delete_tag: pulumi.Output[bool] = None¶: Deny deleting a tag

file_name_regex: pulumi.Output[str] = None¶: All commited filenames must not match this regex, e.g. “(jar|exe)$”

max_file_size: pulumi.Output[float] = None¶: Maximum file size (MB)

member_check: pulumi.Output[bool] = None¶: Restrict commits by author (email) to existing GitLab users

prevent_secrets: pulumi.Output[bool] = None¶: GitLab will reject any files that are likely to contain secrets

project: pulumi.Output[str] = None¶: The name or id of the project to add the push rules to.

static get(resource_name, id, opts=None, author_email_regex=None, branch_name_regex=None, commit_message_regex=None, deny_delete_tag=None, file_name_regex=None, max_file_size=None, member_check=None, prevent_secrets=None, project=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
author_email_regex (pulumi.Input[str]) – All commit author emails must match this regex, e.g. “@my-company.com$”
branch_name_regex (pulumi.Input[str]) – All branch names must match this regex, e.g. “(feature|hotfix)/*”
commit_message_regex (pulumi.Input[str]) – All commit messages must match this regex, e.g. “Fixed d+..*”
deny_delete_tag (pulumi.Input[bool]) – Deny deleting a tag
file_name_regex (pulumi.Input[str]) – All commited filenames must not match this regex, e.g. “(jar|exe)$”
max_file_size (pulumi.Input[float]) – Maximum file size (MB)
member_check (pulumi.Input[bool]) – Restrict commits by author (email) to existing GitLab users
prevent_secrets (pulumi.Input[bool]) – GitLab will reject any files that are likely to contain secrets
project (pulumi.Input[str]) – The name or id of the project to add the push rules to.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gitlab.ProjectShareGroup(resource_name, opts=None, access_level=None, group_id=None, project_id=None, __props__=None, __name__=None, __opts__=None)¶

This resource allows you to share a project with a group

import pulumi
import pulumi_gitlab as gitlab

test = gitlab.ProjectShareGroup("test",
    access_level="guest",
    group_id=1337,
    project_id="12345")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
access_level (pulumi.Input[str]) – One of five levels of access to the project.
group_id (pulumi.Input[float]) – The id of the group.
project_id (pulumi.Input[str]) – The id of the project.

access_level: pulumi.Output[str] = None¶: One of five levels of access to the project.

group_id: pulumi.Output[float] = None¶: The id of the group.

project_id: pulumi.Output[str] = None¶: The id of the project.

static get(resource_name, id, opts=None, access_level=None, group_id=None, project_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
access_level (pulumi.Input[str]) – One of five levels of access to the project.
group_id (pulumi.Input[float]) – The id of the group.
project_id (pulumi.Input[str]) – The id of the project.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gitlab.ProjectVariable(resource_name, opts=None, environment_scope=None, key=None, masked=None, project=None, protected=None, value=None, variable_type=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_gitlab as gitlab

example = gitlab.ProjectVariable("example",
    key="project_variable_key",
    project="12345",
    protected=False,
    value="project_variable_value")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
environment_scope (pulumi.Input[str]) – The environment_scope of the variable
key (pulumi.Input[str]) – The name of the variable.
masked (pulumi.Input[bool]) – If set to true, the variable will be masked if it would have been written to the logs. Defaults to false.
project (pulumi.Input[str]) – The name or id of the project to add the hook to.
protected (pulumi.Input[bool]) – If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.
value (pulumi.Input[str]) – The value of the variable.
variable_type (pulumi.Input[str]) – The type of a variable. Available types are: env_var (default) and file.

environment_scope: pulumi.Output[str] = None¶: The environment_scope of the variable

key: pulumi.Output[str] = None¶: The name of the variable.

masked: pulumi.Output[bool] = None¶: If set to true, the variable will be masked if it would have been written to the logs. Defaults to false.

project: pulumi.Output[str] = None¶: The name or id of the project to add the hook to.

protected: pulumi.Output[bool] = None¶: If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.

value: pulumi.Output[str] = None¶: The value of the variable.

variable_type: pulumi.Output[str] = None¶: The type of a variable. Available types are: env_var (default) and file.

static get(resource_name, id, opts=None, environment_scope=None, key=None, masked=None, project=None, protected=None, value=None, variable_type=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
environment_scope (pulumi.Input[str]) – The environment_scope of the variable
key (pulumi.Input[str]) – The name of the variable.
masked (pulumi.Input[bool]) – If set to true, the variable will be masked if it would have been written to the logs. Defaults to false.
project (pulumi.Input[str]) – The name or id of the project to add the hook to.
protected (pulumi.Input[bool]) – If set to true, the variable will be passed only to pipelines running on protected branches and tags. Defaults to false.
value (pulumi.Input[str]) – The value of the variable.
variable_type (pulumi.Input[str]) – The type of a variable. Available types are: env_var (default) and file.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gitlab.Provider(resource_name, opts=None, base_url=None, cacert_file=None, client_cert=None, client_key=None, insecure=None, token=None, __props__=None, __name__=None, __opts__=None)¶

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.

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
base_url (pulumi.Input[str]) – The GitLab Base API URL
cacert_file (pulumi.Input[str]) – A file containing the ca certificate to use in case ssl certificate is not from a standard chain
client_cert (pulumi.Input[str]) – File path to client certificate when GitLab instance is behind company proxy. File must contain PEM encoded data.
client_key (pulumi.Input[str]) – File path to client key when GitLab instance is behind company proxy. File must contain PEM encoded data.
insecure (pulumi.Input[bool]) – Disable SSL verification of API calls
token (pulumi.Input[str]) – The OAuth token used to connect to GitLab.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gitlab.ServiceGithub(resource_name, opts=None, project=None, repository_url=None, static_context=None, token=None, __props__=None, __name__=None, __opts__=None)¶

NOTE: requires either EE (self-hosted) or Silver and above (GitLab.com).

This resource manages a GitHub integration that updates pipeline statuses on a GitHub repo’s pull requests.

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
project (pulumi.Input[str]) – ID of the project you want to activate integration on.
static_context (pulumi.Input[bool]) – Append instance name instead of branch to the status. Must enable to set a GitLab status check as required in GitHub. See [Static / dynamic status check names] to learn more.
token (pulumi.Input[str]) – A GitHub personal access token with at least repo:status scope.

project: pulumi.Output[str] = None¶: ID of the project you want to activate integration on.

static_context: pulumi.Output[bool] = None¶: Append instance name instead of branch to the status. Must enable to set a GitLab status check as required in GitHub. See [Static / dynamic status check names] to learn more.

token: pulumi.Output[str] = None¶: A GitHub personal access token with at least repo:status scope.

static get(resource_name, id, opts=None, active=None, created_at=None, project=None, repository_url=None, static_context=None, title=None, token=None, updated_at=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
project (pulumi.Input[str]) – ID of the project you want to activate integration on.
static_context (pulumi.Input[bool]) – Append instance name instead of branch to the status. Must enable to set a GitLab status check as required in GitHub. See [Static / dynamic status check names] to learn more.
token (pulumi.Input[str]) – A GitHub personal access token with at least repo:status scope.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gitlab.ServiceJira(resource_name, opts=None, comment_on_event_enabled=None, commit_events=None, jira_issue_transition_id=None, merge_requests_events=None, password=None, project=None, project_key=None, url=None, username=None, __props__=None, __name__=None, __opts__=None)¶

This resource allows you to manage Jira integration.

import pulumi
import pulumi_gitlab as gitlab

awesome_project = gitlab.Project("awesomeProject",
    description="My awesome project.",
    visibility_level="public")
jira = gitlab.ServiceJira("jira",
    password="mypass",
    project=awesome_project.id,
    url="https://jira.example.com",
    username="user")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
comment_on_event_enabled (pulumi.Input[bool]) – Enable comments inside Jira issues on each GitLab event (commit / merge request)
commit_events (pulumi.Input[bool]) – Enable notifications for commit events
jira_issue_transition_id (pulumi.Input[str]) – 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.
merge_requests_events (pulumi.Input[bool]) – Enable notifications for merge request events
password (pulumi.Input[str]) – The password of the user created to be used with GitLab/JIRA.
project (pulumi.Input[str]) – ID of the project you want to activate integration on.
project_key (pulumi.Input[str]) – The short identifier for your JIRA project, all uppercase, e.g., PROJ.
url (pulumi.Input[str]) – The URL to the JIRA project which is being linked to this GitLab project. For example, https://jira.example.com.
username (pulumi.Input[str]) – The username of the user created to be used with GitLab/JIRA.

comment_on_event_enabled: pulumi.Output[bool] = None¶: Enable comments inside Jira issues on each GitLab event (commit / merge request)

commit_events: pulumi.Output[bool] = None¶: Enable notifications for commit events

jira_issue_transition_id: pulumi.Output[str] = None¶: 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.

merge_requests_events: pulumi.Output[bool] = None¶: Enable notifications for merge request events

password: pulumi.Output[str] = None¶: The password of the user created to be used with GitLab/JIRA.

project: pulumi.Output[str] = None¶: ID of the project you want to activate integration on.

project_key: pulumi.Output[str] = None¶: The short identifier for your JIRA project, all uppercase, e.g., PROJ.

url: pulumi.Output[str] = None¶: The URL to the JIRA project which is being linked to this GitLab project. For example, https://jira.example.com.

username: pulumi.Output[str] = None¶: The username of the user created to be used with GitLab/JIRA.

static get(resource_name, id, opts=None, active=None, comment_on_event_enabled=None, commit_events=None, created_at=None, jira_issue_transition_id=None, merge_requests_events=None, password=None, project=None, project_key=None, title=None, updated_at=None, url=None, username=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
comment_on_event_enabled (pulumi.Input[bool]) – Enable comments inside Jira issues on each GitLab event (commit / merge request)
commit_events (pulumi.Input[bool]) – Enable notifications for commit events
jira_issue_transition_id (pulumi.Input[str]) – 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.
merge_requests_events (pulumi.Input[bool]) – Enable notifications for merge request events
password (pulumi.Input[str]) – The password of the user created to be used with GitLab/JIRA.
project (pulumi.Input[str]) – ID of the project you want to activate integration on.
project_key (pulumi.Input[str]) – The short identifier for your JIRA project, all uppercase, e.g., PROJ.
url (pulumi.Input[str]) – The URL to the JIRA project which is being linked to this GitLab project. For example, https://jira.example.com.
username (pulumi.Input[str]) – The username of the user created to be used with GitLab/JIRA.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gitlab.ServiceSlack(resource_name, opts=None, branches_to_be_notified=None, confidential_issue_channel=None, confidential_issues_events=None, confidential_note_events=None, issue_channel=None, issues_events=None, merge_request_channel=None, merge_requests_events=None, note_channel=None, note_events=None, notify_only_broken_pipelines=None, notify_only_default_branch=None, pipeline_channel=None, pipeline_events=None, project=None, push_channel=None, push_events=None, tag_push_channel=None, tag_push_events=None, username=None, webhook=None, wiki_page_channel=None, wiki_page_events=None, __props__=None, __name__=None, __opts__=None)¶

This resource allows you to manage Slack notifications integration.

import pulumi
import pulumi_gitlab as gitlab

awesome_project = gitlab.Project("awesomeProject",
    description="My awesome project.",
    visibility_level="public")
slack = gitlab.ServiceSlack("slack",
    project=awesome_project.id,
    push_channel="push_chan",
    push_events=True,
    username="myuser",
    webhook="https://webhook.com")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
branches_to_be_notified (pulumi.Input[str]) – Branches to send notifications for. Valid options are “all”, “default”, “protected”, and “default_and_protected”.
confidential_issue_channel (pulumi.Input[str]) – The name of the channel to receive confidential issue events notifications.
confidential_issues_events (pulumi.Input[bool]) – Enable notifications for confidential issues events.
confidential_note_events (pulumi.Input[bool]) – Enable notifications for confidential note events.
issue_channel (pulumi.Input[str]) – The name of the channel to receive issue events notifications.
issues_events (pulumi.Input[bool]) – Enable notifications for issues events.
merge_request_channel (pulumi.Input[str]) – The name of the channel to receive merge request events notifications.
merge_requests_events (pulumi.Input[bool]) – Enable notifications for merge requests events.
note_channel (pulumi.Input[str]) – The name of the channel to receive note events notifications.
note_events (pulumi.Input[bool]) – Enable notifications for note events.
notify_only_broken_pipelines (pulumi.Input[bool]) – Send notifications for broken pipelines.
notify_only_default_branch (pulumi.Input[bool]) – DEPRECATED: This parameter has been replaced with branches_to_be_notified.
pipeline_channel (pulumi.Input[str]) – The name of the channel to receive pipeline events notifications.
pipeline_events (pulumi.Input[bool]) – Enable notifications for pipeline events.
project (pulumi.Input[str]) – ID of the project you want to activate integration on.
push_channel (pulumi.Input[str]) – The name of the channel to receive push events notifications.
push_events (pulumi.Input[bool]) – Enable notifications for push events.
tag_push_channel (pulumi.Input[str]) – The name of the channel to receive tag push events notifications.
tag_push_events (pulumi.Input[bool]) – Enable notifications for tag push events.
username (pulumi.Input[str]) – Username to use.
webhook (pulumi.Input[str]) – Webhook URL (ex.: https://hooks.slack.com/services/…)
wiki_page_channel (pulumi.Input[str]) – The name of the channel to receive wiki page events notifications.
wiki_page_events (pulumi.Input[bool]) – Enable notifications for wiki page events.

branches_to_be_notified: pulumi.Output[str] = None¶: Branches to send notifications for. Valid options are “all”, “default”, “protected”, and “default_and_protected”.

confidential_issue_channel: pulumi.Output[str] = None¶: The name of the channel to receive confidential issue events notifications.

confidential_issues_events: pulumi.Output[bool] = None¶: Enable notifications for confidential issues events.

confidential_note_events: pulumi.Output[bool] = None¶: Enable notifications for confidential note events.

issue_channel: pulumi.Output[str] = None¶: The name of the channel to receive issue events notifications.

issues_events: pulumi.Output[bool] = None¶: Enable notifications for issues events.

merge_request_channel: pulumi.Output[str] = None¶: The name of the channel to receive merge request events notifications.

merge_requests_events: pulumi.Output[bool] = None¶: Enable notifications for merge requests events.

note_channel: pulumi.Output[str] = None¶: The name of the channel to receive note events notifications.

note_events: pulumi.Output[bool] = None¶: Enable notifications for note events.

notify_only_broken_pipelines: pulumi.Output[bool] = None¶: Send notifications for broken pipelines.

notify_only_default_branch: pulumi.Output[bool] = None¶: DEPRECATED: This parameter has been replaced with branches_to_be_notified.

pipeline_channel: pulumi.Output[str] = None¶: The name of the channel to receive pipeline events notifications.

pipeline_events: pulumi.Output[bool] = None¶: Enable notifications for pipeline events.

project: pulumi.Output[str] = None¶: ID of the project you want to activate integration on.

push_channel: pulumi.Output[str] = None¶: The name of the channel to receive push events notifications.

push_events: pulumi.Output[bool] = None¶: Enable notifications for push events.

tag_push_channel: pulumi.Output[str] = None¶: The name of the channel to receive tag push events notifications.

tag_push_events: pulumi.Output[bool] = None¶: Enable notifications for tag push events.

username: pulumi.Output[str] = None¶: Username to use.

webhook: pulumi.Output[str] = None¶: Webhook URL (ex.: https://hooks.slack.com/services/…)

wiki_page_channel: pulumi.Output[str] = None¶: The name of the channel to receive wiki page events notifications.

wiki_page_events: pulumi.Output[bool] = None¶: Enable notifications for wiki page events.

static get(resource_name, id, opts=None, branches_to_be_notified=None, confidential_issue_channel=None, confidential_issues_events=None, confidential_note_events=None, issue_channel=None, issues_events=None, job_events=None, merge_request_channel=None, merge_requests_events=None, note_channel=None, note_events=None, notify_only_broken_pipelines=None, notify_only_default_branch=None, pipeline_channel=None, pipeline_events=None, project=None, push_channel=None, push_events=None, tag_push_channel=None, tag_push_events=None, username=None, webhook=None, wiki_page_channel=None, wiki_page_events=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
branches_to_be_notified (pulumi.Input[str]) – Branches to send notifications for. Valid options are “all”, “default”, “protected”, and “default_and_protected”.
confidential_issue_channel (pulumi.Input[str]) – The name of the channel to receive confidential issue events notifications.
confidential_issues_events (pulumi.Input[bool]) – Enable notifications for confidential issues events.
confidential_note_events (pulumi.Input[bool]) – Enable notifications for confidential note events.
issue_channel (pulumi.Input[str]) – The name of the channel to receive issue events notifications.
issues_events (pulumi.Input[bool]) – Enable notifications for issues events.
merge_request_channel (pulumi.Input[str]) – The name of the channel to receive merge request events notifications.
merge_requests_events (pulumi.Input[bool]) – Enable notifications for merge requests events.
note_channel (pulumi.Input[str]) – The name of the channel to receive note events notifications.
note_events (pulumi.Input[bool]) – Enable notifications for note events.
notify_only_broken_pipelines (pulumi.Input[bool]) – Send notifications for broken pipelines.
notify_only_default_branch (pulumi.Input[bool]) – DEPRECATED: This parameter has been replaced with branches_to_be_notified.
pipeline_channel (pulumi.Input[str]) – The name of the channel to receive pipeline events notifications.
pipeline_events (pulumi.Input[bool]) – Enable notifications for pipeline events.
project (pulumi.Input[str]) – ID of the project you want to activate integration on.
push_channel (pulumi.Input[str]) – The name of the channel to receive push events notifications.
push_events (pulumi.Input[bool]) – Enable notifications for push events.
tag_push_channel (pulumi.Input[str]) – The name of the channel to receive tag push events notifications.
tag_push_events (pulumi.Input[bool]) – Enable notifications for tag push events.
username (pulumi.Input[str]) – Username to use.
webhook (pulumi.Input[str]) – Webhook URL (ex.: https://hooks.slack.com/services/…)
wiki_page_channel (pulumi.Input[str]) – The name of the channel to receive wiki page events notifications.
wiki_page_events (pulumi.Input[bool]) – Enable notifications for wiki page events.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gitlab.TagProtection(resource_name, opts=None, create_access_level=None, project=None, tag=None, __props__=None, __name__=None, __opts__=None)¶

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.

import pulumi
import pulumi_gitlab as gitlab

tag_protect = gitlab.TagProtection("tagProtect",
    create_access_level="developer",
    project="12345",
    tag="TagProtected")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
create_access_level (pulumi.Input[str]) – One of five levels of access to the project.
project (pulumi.Input[str]) – The id of the project.
tag (pulumi.Input[str]) – Name of the tag or wildcard.

create_access_level: pulumi.Output[str] = None¶: One of five levels of access to the project.

project: pulumi.Output[str] = None¶: The id of the project.

tag: pulumi.Output[str] = None¶: Name of the tag or wildcard.

static get(resource_name, id, opts=None, create_access_level=None, project=None, tag=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
create_access_level (pulumi.Input[str]) – One of five levels of access to the project.
project (pulumi.Input[str]) – The id of the project.
tag (pulumi.Input[str]) – Name of the tag or wildcard.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gitlab.User(resource_name, opts=None, can_create_group=None, email=None, is_admin=None, is_external=None, name=None, password=None, projects_limit=None, reset_password=None, skip_confirmation=None, username=None, __props__=None, __name__=None, __opts__=None)¶

Create a User resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[bool] can_create_group: Boolean, defaults to false. Whether to allow the user to create groups. :param pulumi.Input[str] email: The e-mail address of the user. :param pulumi.Input[bool] is_admin: Boolean, defaults to false. Whether to enable administrative priviledges

for the user.

Parameters

is_external (pulumi.Input[bool]) – 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.
name (pulumi.Input[str]) – The name of the user.
password (pulumi.Input[str]) – The password of the user.
projects_limit (pulumi.Input[float]) – Integer, defaults to 0. Number of projects user can create.
reset_password (pulumi.Input[bool]) – Boolean, defaults to false. Send user password reset link.
skip_confirmation (pulumi.Input[bool]) – Boolean, defaults to true. Whether to skip confirmation.
username (pulumi.Input[str]) – The username of the user.

can_create_group: pulumi.Output[bool] = None¶: Boolean, defaults to false. Whether to allow the user to create groups.

email: pulumi.Output[str] = None¶: The e-mail address of the user.

is_admin: pulumi.Output[bool] = None¶: Boolean, defaults to false. Whether to enable administrative priviledges for the user.

is_external: pulumi.Output[bool] = None¶: 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.

name: pulumi.Output[str] = None¶: The name of the user.

password: pulumi.Output[str] = None¶: The password of the user.

projects_limit: pulumi.Output[float] = None¶: Integer, defaults to 0. Number of projects user can create.

reset_password: pulumi.Output[bool] = None¶: Boolean, defaults to false. Send user password reset link.

skip_confirmation: pulumi.Output[bool] = None¶: Boolean, defaults to true. Whether to skip confirmation.

username: pulumi.Output[str] = None¶: The username of the user.

static get(resource_name, id, opts=None, can_create_group=None, email=None, is_admin=None, is_external=None, name=None, password=None, projects_limit=None, reset_password=None, skip_confirmation=None, username=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
can_create_group (pulumi.Input[bool]) – Boolean, defaults to false. Whether to allow the user to create groups.
email (pulumi.Input[str]) – The e-mail address of the user.
is_admin (pulumi.Input[bool]) – Boolean, defaults to false. Whether to enable administrative priviledges for the user.
is_external (pulumi.Input[bool]) – 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.
name (pulumi.Input[str]) – The name of the user.
password (pulumi.Input[str]) – The password of the user.
projects_limit (pulumi.Input[float]) – Integer, defaults to 0. Number of projects user can create.
reset_password (pulumi.Input[bool]) – Boolean, defaults to false. Send user password reset link.
skip_confirmation (pulumi.Input[bool]) – Boolean, defaults to true. Whether to skip confirmation.
username (pulumi.Input[str]) – The username of the user.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

pulumi_gitlab.get_group(full_path=None, group_id=None, opts=None)¶

Provides details about a specific group in the gitlab provider.

import pulumi
import pulumi_gitlab as gitlab

foo = gitlab.get_group(group_id=123)

Parameters

full_path (str) – The full path of the group.
group_id (float) – The ID of the group.

pulumi_gitlab.get_project(archived=None, default_branch=None, description=None, http_url_to_repo=None, id=None, issues_enabled=None, lfs_enabled=None, merge_requests_enabled=None, name=None, namespace_id=None, path=None, pipelines_enabled=None, remove_source_branch_after_merge=None, request_access_enabled=None, runners_token=None, snippets_enabled=None, ssh_url_to_repo=None, visibility_level=None, web_url=None, wiki_enabled=None, opts=None)¶

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

import pulumi
import pulumi_gitlab as gitlab

example = gitlab.get_project(id=30)

Parameters

archived (bool) – Whether the project is in read-only mode (archived).
default_branch (str) – The default branch for the project.
description (str) – A description of the project.
http_url_to_repo (str) – URL that can be provided to git clone to clone the repository via HTTP.
id (float) – The integer that uniquely identifies the project within the gitlab install.
issues_enabled (bool) – Enable issue tracking for the project.
lfs_enabled (bool) – Enable LFS for the project.
merge_requests_enabled (bool) – Enable merge requests for the project.
namespace_id (float) – The namespace (group or user) of the project. Defaults to your user. See .Group for an example.
path (str) – The path of the repository.
pipelines_enabled (bool) – Enable pipelines for the project.
remove_source_branch_after_merge (bool) – Enable Delete source branch option by default for all new merge requests
request_access_enabled (bool) – Allow users to request member access.
runners_token (str) – Registration token to use during runner setup.
snippets_enabled (bool) – Enable snippets for the project.
ssh_url_to_repo (str) – URL that can be provided to git clone to clone the repository via SSH.
visibility_level (str) – Repositories are created as private by default.
web_url (str) – URL that can be used to find the project in a browser.
wiki_enabled (bool) – Enable wiki for the project.

pulumi_gitlab.get_projects(archived=None, group_id=None, include_subgroups=None, max_queryable_pages=None, membership=None, min_access_level=None, order_by=None, owned=None, page=None, per_page=None, search=None, simple=None, sort=None, starred=None, statistics=None, visibility=None, with_custom_attributes=None, with_issues_enabled=None, with_merge_requests_enabled=None, with_programming_language=None, with_shared=None, opts=None)¶

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.

import pulumi
import pulumi_gitlab as gitlab

mygroup = gitlab.get_group(full_path="mygroup")
group_projects = gitlab.get_projects(group_id=mygroup.id,
    order_by="name",
    include_subgroups=True,
    with_shared=False)

import pulumi
import pulumi_gitlab as gitlab

projects = gitlab.get_projects(search="postgresql",
    visibility="private")

Parameters

archived (bool) – Limit by archived status.
group_id (float) – The ID of the group owned by the authenticated user to look projects for within. Cannot be used with min_access_level, with_programming_language or statistics.
include_subgroups (bool) – Include projects in subgroups of this group. Default is false. Needs group_id.
max_queryable_pages (float) – Prevents overloading your Gitlab instance in case of a misconfiguration. Default is 10.
membership (bool) – Limit by projects that the current user is a member of.
min_access_level (float) – Limit to projects where current user has at least this access level, refer to the official documentation for values. Cannot be used with group_id.
order_by (str) – Return projects ordered by id, name, path, created_at, updated_at, or last_activity_at fields. Default is created_at.
owned (bool) – Limit by projects owned by the current user.
search (str) – Return list of authorized projects matching the search criteria.
simple (bool) – Return only the ID, URL, name, and path of each project.
sort (str) – Return projects sorted in asc or desc order. Default is desc.
starred (bool) – Limit by projects starred by the current user.
statistics (bool) – Include project statistics. Cannot be used with group_id.
visibility (str) – Limit by visibility public, internal, or private.
with_custom*attributes (bool) –
Include custom attributes in response *(admins only)_.
with_issues_enabled (bool) – Limit by projects with issues feature enabled. Default is false.
with_merge_requests_enabled (bool) – Limit by projects with merge requests feature enabled. Default is false.
with_programming_language (str) – Limit by projects which use the given programming language. Cannot be used with group_id.
with_shared (bool) – Include projects shared to this group. Default is true. Needs group_id.

pulumi_gitlab.get_user(email=None, user_id=None, username=None, opts=None)¶

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

import pulumi
import pulumi_gitlab as gitlab

example = gitlab.get_user(username="myuser")

Parameters

email (str) – The e-mail address of the user. (Requires administrator privileges)
user_id (float) – The ID of the user.
username (str) – The username of the user.

pulumi_gitlab.get_users(active=None, blocked=None, created_after=None, created_before=None, extern_provider=None, extern_uid=None, order_by=None, search=None, sort=None, opts=None)¶

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][users_for_admins] for more information.

import pulumi
import pulumi_gitlab as gitlab

example = gitlab.get_users(created_before="2019-01-01",
    order_by="name",
    sort="desc")

Parameters

active (bool) – Filter users that are active.
blocked (bool) – Filter users that are blocked.
created_after (str) – Search for users created after a specific date. (Requires administrator privileges)
created_before (str) – Search for users created before a specific date. (Requires administrator privileges)
extern_provider (str) – Lookup users by external provider. (Requires administrator privileges)
extern_uid (str) – Lookup users by external UID. (Requires administrator privileges)
order_by (str) – Order the users’ list by id, name, username, created_at or updated_at. (Requires administrator privileges)
search (str) – Search users by username, name or email.
sort (str) – Sort users’ list in asc or desc order. (Requires administrator privileges)

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Pulumi GitLab¶

On This Page