1. Packages
  2. Gitlab Provider
  3. API Docs
  4. ProjectShareGroup
GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi

gitlab.ProjectShareGroup

Explore with Pulumi AI

The gitlab.ProjectShareGroup resource allows to manage the lifecycle of project shared with a group.

Upstream API: GitLab REST API docs

Example Usage

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

const test = new gitlab.ProjectShareGroup("test", {
    project: "12345",
    groupId: 1337,
    groupAccess: "guest",
});
Copy
import pulumi
import pulumi_gitlab as gitlab

test = gitlab.ProjectShareGroup("test",
    project="12345",
    group_id=1337,
    group_access="guest")
Copy
package main

import (
	"github.com/pulumi/pulumi-gitlab/sdk/v8/go/gitlab"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gitlab.NewProjectShareGroup(ctx, "test", &gitlab.ProjectShareGroupArgs{
			Project:     pulumi.String("12345"),
			GroupId:     pulumi.Int(1337),
			GroupAccess: pulumi.String("guest"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;

return await Deployment.RunAsync(() => 
{
    var test = new GitLab.ProjectShareGroup("test", new()
    {
        Project = "12345",
        GroupId = 1337,
        GroupAccess = "guest",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.ProjectShareGroup;
import com.pulumi.gitlab.ProjectShareGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new ProjectShareGroup("test", ProjectShareGroupArgs.builder()
            .project("12345")
            .groupId(1337)
            .groupAccess("guest")
            .build());

    }
}
Copy
resources:
  test:
    type: gitlab:ProjectShareGroup
    properties:
      project: '12345'
      groupId: 1337
      groupAccess: guest
Copy

Create ProjectShareGroup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ProjectShareGroup(name: string, args: ProjectShareGroupArgs, opts?: CustomResourceOptions);
@overload
def ProjectShareGroup(resource_name: str,
                      args: ProjectShareGroupArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def ProjectShareGroup(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      group_id: Optional[int] = None,
                      project: Optional[str] = None,
                      access_level: Optional[str] = None,
                      group_access: Optional[str] = None)
func NewProjectShareGroup(ctx *Context, name string, args ProjectShareGroupArgs, opts ...ResourceOption) (*ProjectShareGroup, error)
public ProjectShareGroup(string name, ProjectShareGroupArgs args, CustomResourceOptions? opts = null)
public ProjectShareGroup(String name, ProjectShareGroupArgs args)
public ProjectShareGroup(String name, ProjectShareGroupArgs args, CustomResourceOptions options)
type: gitlab:ProjectShareGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ProjectShareGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ProjectShareGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ProjectShareGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ProjectShareGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ProjectShareGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var projectShareGroupResource = new GitLab.ProjectShareGroup("projectShareGroupResource", new()
{
    GroupId = 0,
    Project = "string",
    GroupAccess = "string",
});
Copy
example, err := gitlab.NewProjectShareGroup(ctx, "projectShareGroupResource", &gitlab.ProjectShareGroupArgs{
	GroupId:     pulumi.Int(0),
	Project:     pulumi.String("string"),
	GroupAccess: pulumi.String("string"),
})
Copy
var projectShareGroupResource = new ProjectShareGroup("projectShareGroupResource", ProjectShareGroupArgs.builder()
    .groupId(0)
    .project("string")
    .groupAccess("string")
    .build());
Copy
project_share_group_resource = gitlab.ProjectShareGroup("projectShareGroupResource",
    group_id=0,
    project="string",
    group_access="string")
Copy
const projectShareGroupResource = new gitlab.ProjectShareGroup("projectShareGroupResource", {
    groupId: 0,
    project: "string",
    groupAccess: "string",
});
Copy
type: gitlab:ProjectShareGroup
properties:
    groupAccess: string
    groupId: 0
    project: string
Copy

ProjectShareGroup Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ProjectShareGroup resource accepts the following input properties:

GroupId
This property is required.
Changes to this property will trigger replacement.
int
The id of the group.
Project
This property is required.
Changes to this property will trigger replacement.
string
The ID or URL-encoded path of the project.
AccessLevel Changes to this property will trigger replacement. string
The access level to grant the group for the project. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner

Deprecated: Use group_access instead of the access_level attribute.

GroupAccess Changes to this property will trigger replacement. string
The access level to grant the group for the project. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner
GroupId
This property is required.
Changes to this property will trigger replacement.
int
The id of the group.
Project
This property is required.
Changes to this property will trigger replacement.
string
The ID or URL-encoded path of the project.
AccessLevel Changes to this property will trigger replacement. string
The access level to grant the group for the project. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner

Deprecated: Use group_access instead of the access_level attribute.

GroupAccess Changes to this property will trigger replacement. string
The access level to grant the group for the project. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner
groupId
This property is required.
Changes to this property will trigger replacement.
Integer
The id of the group.
project
This property is required.
Changes to this property will trigger replacement.
String
The ID or URL-encoded path of the project.
accessLevel Changes to this property will trigger replacement. String
The access level to grant the group for the project. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner

Deprecated: Use group_access instead of the access_level attribute.

groupAccess Changes to this property will trigger replacement. String
The access level to grant the group for the project. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner
groupId
This property is required.
Changes to this property will trigger replacement.
number
The id of the group.
project
This property is required.
Changes to this property will trigger replacement.
string
The ID or URL-encoded path of the project.
accessLevel Changes to this property will trigger replacement. string
The access level to grant the group for the project. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner

Deprecated: Use group_access instead of the access_level attribute.

groupAccess Changes to this property will trigger replacement. string
The access level to grant the group for the project. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner
group_id
This property is required.
Changes to this property will trigger replacement.
int
The id of the group.
project
This property is required.
Changes to this property will trigger replacement.
str
The ID or URL-encoded path of the project.
access_level Changes to this property will trigger replacement. str
The access level to grant the group for the project. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner

Deprecated: Use group_access instead of the access_level attribute.

group_access Changes to this property will trigger replacement. str
The access level to grant the group for the project. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner
groupId
This property is required.
Changes to this property will trigger replacement.
Number
The id of the group.
project
This property is required.
Changes to this property will trigger replacement.
String
The ID or URL-encoded path of the project.
accessLevel Changes to this property will trigger replacement. String
The access level to grant the group for the project. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner

Deprecated: Use group_access instead of the access_level attribute.

groupAccess Changes to this property will trigger replacement. String
The access level to grant the group for the project. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing ProjectShareGroup Resource

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

public static get(name: string, id: Input<ID>, state?: ProjectShareGroupState, opts?: CustomResourceOptions): ProjectShareGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_level: Optional[str] = None,
        group_access: Optional[str] = None,
        group_id: Optional[int] = None,
        project: Optional[str] = None) -> ProjectShareGroup
func GetProjectShareGroup(ctx *Context, name string, id IDInput, state *ProjectShareGroupState, opts ...ResourceOption) (*ProjectShareGroup, error)
public static ProjectShareGroup Get(string name, Input<string> id, ProjectShareGroupState? state, CustomResourceOptions? opts = null)
public static ProjectShareGroup get(String name, Output<String> id, ProjectShareGroupState state, CustomResourceOptions options)
resources:  _:    type: gitlab:ProjectShareGroup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AccessLevel Changes to this property will trigger replacement. string
The access level to grant the group for the project. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner

Deprecated: Use group_access instead of the access_level attribute.

GroupAccess Changes to this property will trigger replacement. string
The access level to grant the group for the project. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner
GroupId Changes to this property will trigger replacement. int
The id of the group.
Project Changes to this property will trigger replacement. string
The ID or URL-encoded path of the project.
AccessLevel Changes to this property will trigger replacement. string
The access level to grant the group for the project. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner

Deprecated: Use group_access instead of the access_level attribute.

GroupAccess Changes to this property will trigger replacement. string
The access level to grant the group for the project. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner
GroupId Changes to this property will trigger replacement. int
The id of the group.
Project Changes to this property will trigger replacement. string
The ID or URL-encoded path of the project.
accessLevel Changes to this property will trigger replacement. String
The access level to grant the group for the project. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner

Deprecated: Use group_access instead of the access_level attribute.

groupAccess Changes to this property will trigger replacement. String
The access level to grant the group for the project. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner
groupId Changes to this property will trigger replacement. Integer
The id of the group.
project Changes to this property will trigger replacement. String
The ID or URL-encoded path of the project.
accessLevel Changes to this property will trigger replacement. string
The access level to grant the group for the project. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner

Deprecated: Use group_access instead of the access_level attribute.

groupAccess Changes to this property will trigger replacement. string
The access level to grant the group for the project. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner
groupId Changes to this property will trigger replacement. number
The id of the group.
project Changes to this property will trigger replacement. string
The ID or URL-encoded path of the project.
access_level Changes to this property will trigger replacement. str
The access level to grant the group for the project. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner

Deprecated: Use group_access instead of the access_level attribute.

group_access Changes to this property will trigger replacement. str
The access level to grant the group for the project. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner
group_id Changes to this property will trigger replacement. int
The id of the group.
project Changes to this property will trigger replacement. str
The ID or URL-encoded path of the project.
accessLevel Changes to this property will trigger replacement. String
The access level to grant the group for the project. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner

Deprecated: Use group_access instead of the access_level attribute.

groupAccess Changes to this property will trigger replacement. String
The access level to grant the group for the project. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner
groupId Changes to this property will trigger replacement. Number
The id of the group.
project Changes to this property will trigger replacement. String
The ID or URL-encoded path of the project.

Import

Starting in Terraform v1.5.0 you can use an import block to import gitlab_project_share_group. For example:

terraform

import {

to = gitlab_project_share_group.example

id = “see CLI command below for ID”

}

Import using the CLI is supported using the following syntax:

GitLab project group shares can be imported using an id made up of projectid:groupid, e.g.

$ pulumi import gitlab:index/projectShareGroup:ProjectShareGroup test 12345:1337
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
GitLab pulumi/pulumi-gitlab
License
Apache-2.0
Notes
This Pulumi package is based on the gitlab Terraform Provider.