Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Gitlab Provider
  3. API Docs
  4. Group
GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-gitlab

gitlab.Group

Explore with Pulumi AI

GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-gitlab

The gitlab.Group resource allows to manage the lifecycle of a group.

On GitLab SaaS, you must use the GitLab UI to create groups without a parent group. You cannot use this provider nor the API to do this.

Upstream API: GitLab REST API docs

Example Usage

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

const example = new gitlab.Group("example", {
    name: "example",
    path: "example",
    description: "An example group",
});
// Create a project in the example group
const exampleProject = new gitlab.Project("example", {
    name: "example",
    description: "An example project",
    namespaceId: example.id,
});
// Group with custom push rules
const example_two = new gitlab.Group("example-two", {
    name: "example-two",
    path: "example-two",
    description: "An example group with push rules",
    pushRules: {
        authorEmailRegex: "@example\\.com$",
        commitCommitterCheck: true,
        memberCheck: true,
        preventSecrets: true,
    },
});
// Group with custom default branch protection defaults
const example_three = new gitlab.Group("example-three", {
    name: "example-three",
    path: "example-three",
    description: "An example group with default branch protection defaults",
    defaultBranchProtectionDefaults: {
        allowedToPushes: ["developer"],
        allowForcePush: true,
        allowedToMerges: [
            "developer",
            "maintainer",
        ],
        developerCanInitialPush: true,
    },
});
// Group with custom default branch protection defaults
const example_four = new gitlab.Group("example-four", {
    name: "example-four",
    path: "example-four",
    description: "An example group with default branch protection defaults",
    defaultBranchProtectionDefaults: {
        allowedToPushes: ["no one"],
        allowForcePush: true,
        allowedToMerges: ["no one"],
        developerCanInitialPush: true,
    },
});
// Group with a default branch name specified
const example_five = new gitlab.Group("example-five", {
    name: "example",
    path: "example",
    defaultBranch: "develop",
    description: "An example group with a default branch name",
});
Copy
import pulumi
import pulumi_gitlab as gitlab

example = gitlab.Group("example",
    name="example",
    path="example",
    description="An example group")
# Create a project in the example group
example_project = gitlab.Project("example",
    name="example",
    description="An example project",
    namespace_id=example.id)
# Group with custom push rules
example_two = gitlab.Group("example-two",
    name="example-two",
    path="example-two",
    description="An example group with push rules",
    push_rules={
        "author_email_regex": "@example\\.com$",
        "commit_committer_check": True,
        "member_check": True,
        "prevent_secrets": True,
    })
# Group with custom default branch protection defaults
example_three = gitlab.Group("example-three",
    name="example-three",
    path="example-three",
    description="An example group with default branch protection defaults",
    default_branch_protection_defaults={
        "allowed_to_pushes": ["developer"],
        "allow_force_push": True,
        "allowed_to_merges": [
            "developer",
            "maintainer",
        ],
        "developer_can_initial_push": True,
    })
# Group with custom default branch protection defaults
example_four = gitlab.Group("example-four",
    name="example-four",
    path="example-four",
    description="An example group with default branch protection defaults",
    default_branch_protection_defaults={
        "allowed_to_pushes": ["no one"],
        "allow_force_push": True,
        "allowed_to_merges": ["no one"],
        "developer_can_initial_push": True,
    })
# Group with a default branch name specified
example_five = gitlab.Group("example-five",
    name="example",
    path="example",
    default_branch="develop",
    description="An example group with a default branch name")
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 {
		example, err := gitlab.NewGroup(ctx, "example", &gitlab.GroupArgs{
			Name:        pulumi.String("example"),
			Path:        pulumi.String("example"),
			Description: pulumi.String("An example group"),
		})
		if err != nil {
			return err
		}
		// Create a project in the example group
		_, err = gitlab.NewProject(ctx, "example", &gitlab.ProjectArgs{
			Name:        pulumi.String("example"),
			Description: pulumi.String("An example project"),
			NamespaceId: example.ID(),
		})
		if err != nil {
			return err
		}
		// Group with custom push rules
		_, err = gitlab.NewGroup(ctx, "example-two", &gitlab.GroupArgs{
			Name:        pulumi.String("example-two"),
			Path:        pulumi.String("example-two"),
			Description: pulumi.String("An example group with push rules"),
			PushRules: &gitlab.GroupPushRulesArgs{
				AuthorEmailRegex:     pulumi.String("@example\\.com$"),
				CommitCommitterCheck: pulumi.Bool(true),
				MemberCheck:          pulumi.Bool(true),
				PreventSecrets:       pulumi.Bool(true),
			},
		})
		if err != nil {
			return err
		}
		// Group with custom default branch protection defaults
		_, err = gitlab.NewGroup(ctx, "example-three", &gitlab.GroupArgs{
			Name:        pulumi.String("example-three"),
			Path:        pulumi.String("example-three"),
			Description: pulumi.String("An example group with default branch protection defaults"),
			DefaultBranchProtectionDefaults: &gitlab.GroupDefaultBranchProtectionDefaultsArgs{
				AllowedToPushes: pulumi.StringArray{
					pulumi.String("developer"),
				},
				AllowForcePush: pulumi.Bool(true),
				AllowedToMerges: pulumi.StringArray{
					pulumi.String("developer"),
					pulumi.String("maintainer"),
				},
				DeveloperCanInitialPush: pulumi.Bool(true),
			},
		})
		if err != nil {
			return err
		}
		// Group with custom default branch protection defaults
		_, err = gitlab.NewGroup(ctx, "example-four", &gitlab.GroupArgs{
			Name:        pulumi.String("example-four"),
			Path:        pulumi.String("example-four"),
			Description: pulumi.String("An example group with default branch protection defaults"),
			DefaultBranchProtectionDefaults: &gitlab.GroupDefaultBranchProtectionDefaultsArgs{
				AllowedToPushes: pulumi.StringArray{
					pulumi.String("no one"),
				},
				AllowForcePush: pulumi.Bool(true),
				AllowedToMerges: pulumi.StringArray{
					pulumi.String("no one"),
				},
				DeveloperCanInitialPush: pulumi.Bool(true),
			},
		})
		if err != nil {
			return err
		}
		// Group with a default branch name specified
		_, err = gitlab.NewGroup(ctx, "example-five", &gitlab.GroupArgs{
			Name:          pulumi.String("example"),
			Path:          pulumi.String("example"),
			DefaultBranch: pulumi.String("develop"),
			Description:   pulumi.String("An example group with a default branch name"),
		})
		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 example = new GitLab.Group("example", new()
    {
        Name = "example",
        Path = "example",
        Description = "An example group",
    });

    // Create a project in the example group
    var exampleProject = new GitLab.Project("example", new()
    {
        Name = "example",
        Description = "An example project",
        NamespaceId = example.Id,
    });

    // Group with custom push rules
    var example_two = new GitLab.Group("example-two", new()
    {
        Name = "example-two",
        Path = "example-two",
        Description = "An example group with push rules",
        PushRules = new GitLab.Inputs.GroupPushRulesArgs
        {
            AuthorEmailRegex = "@example\\.com$",
            CommitCommitterCheck = true,
            MemberCheck = true,
            PreventSecrets = true,
        },
    });

    // Group with custom default branch protection defaults
    var example_three = new GitLab.Group("example-three", new()
    {
        Name = "example-three",
        Path = "example-three",
        Description = "An example group with default branch protection defaults",
        DefaultBranchProtectionDefaults = new GitLab.Inputs.GroupDefaultBranchProtectionDefaultsArgs
        {
            AllowedToPushes = new[]
            {
                "developer",
            },
            AllowForcePush = true,
            AllowedToMerges = new[]
            {
                "developer",
                "maintainer",
            },
            DeveloperCanInitialPush = true,
        },
    });

    // Group with custom default branch protection defaults
    var example_four = new GitLab.Group("example-four", new()
    {
        Name = "example-four",
        Path = "example-four",
        Description = "An example group with default branch protection defaults",
        DefaultBranchProtectionDefaults = new GitLab.Inputs.GroupDefaultBranchProtectionDefaultsArgs
        {
            AllowedToPushes = new[]
            {
                "no one",
            },
            AllowForcePush = true,
            AllowedToMerges = new[]
            {
                "no one",
            },
            DeveloperCanInitialPush = true,
        },
    });

    // Group with a default branch name specified
    var example_five = new GitLab.Group("example-five", new()
    {
        Name = "example",
        Path = "example",
        DefaultBranch = "develop",
        Description = "An example group with a default branch name",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.Group;
import com.pulumi.gitlab.GroupArgs;
import com.pulumi.gitlab.Project;
import com.pulumi.gitlab.ProjectArgs;
import com.pulumi.gitlab.inputs.GroupPushRulesArgs;
import com.pulumi.gitlab.inputs.GroupDefaultBranchProtectionDefaultsArgs;
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 example = new Group("example", GroupArgs.builder()
            .name("example")
            .path("example")
            .description("An example group")
            .build());

        // Create a project in the example group
        var exampleProject = new Project("exampleProject", ProjectArgs.builder()
            .name("example")
            .description("An example project")
            .namespaceId(example.id())
            .build());

        // Group with custom push rules
        var example_two = new Group("example-two", GroupArgs.builder()
            .name("example-two")
            .path("example-two")
            .description("An example group with push rules")
            .pushRules(GroupPushRulesArgs.builder()
                .authorEmailRegex("@example\\.com$")
                .commitCommitterCheck(true)
                .memberCheck(true)
                .preventSecrets(true)
                .build())
            .build());

        // Group with custom default branch protection defaults
        var example_three = new Group("example-three", GroupArgs.builder()
            .name("example-three")
            .path("example-three")
            .description("An example group with default branch protection defaults")
            .defaultBranchProtectionDefaults(GroupDefaultBranchProtectionDefaultsArgs.builder()
                .allowedToPushes("developer")
                .allowForcePush(true)
                .allowedToMerges(                
                    "developer",
                    "maintainer")
                .developerCanInitialPush(true)
                .build())
            .build());

        // Group with custom default branch protection defaults
        var example_four = new Group("example-four", GroupArgs.builder()
            .name("example-four")
            .path("example-four")
            .description("An example group with default branch protection defaults")
            .defaultBranchProtectionDefaults(GroupDefaultBranchProtectionDefaultsArgs.builder()
                .allowedToPushes("no one")
                .allowForcePush(true)
                .allowedToMerges("no one")
                .developerCanInitialPush(true)
                .build())
            .build());

        // Group with a default branch name specified
        var example_five = new Group("example-five", GroupArgs.builder()
            .name("example")
            .path("example")
            .defaultBranch("develop")
            .description("An example group with a default branch name")
            .build());

    }
}
Copy
resources:
  example:
    type: gitlab:Group
    properties:
      name: example
      path: example
      description: An example group
  # Create a project in the example group
  exampleProject:
    type: gitlab:Project
    name: example
    properties:
      name: example
      description: An example project
      namespaceId: ${example.id}
  # Group with custom push rules
  example-two:
    type: gitlab:Group
    properties:
      name: example-two
      path: example-two
      description: An example group with push rules
      pushRules:
        authorEmailRegex: '@example\.com$'
        commitCommitterCheck: true
        memberCheck: true
        preventSecrets: true
  # Group with custom default branch protection defaults
  example-three:
    type: gitlab:Group
    properties:
      name: example-three
      path: example-three
      description: An example group with default branch protection defaults
      defaultBranchProtectionDefaults:
        allowedToPushes:
          - developer
        allowForcePush: true
        allowedToMerges:
          - developer
          - maintainer
        developerCanInitialPush: true
  # Group with custom default branch protection defaults
  example-four:
    type: gitlab:Group
    properties:
      name: example-four
      path: example-four
      description: An example group with default branch protection defaults
      defaultBranchProtectionDefaults:
        allowedToPushes:
          - no one
        allowForcePush: true
        allowedToMerges:
          - no one
        developerCanInitialPush: true
  # Group with a default branch name specified
  example-five:
    type: gitlab:Group
    properties:
      name: example
      path: example
      defaultBranch: develop
      description: An example group with a default branch name
Copy

Create Group Resource

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

Constructor syntax

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

@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          path: Optional[str] = None,
          name: Optional[str] = None,
          default_branch_protection: Optional[int] = None,
          parent_id: Optional[int] = None,
          default_branch: Optional[str] = None,
          auto_devops_enabled: Optional[bool] = None,
          default_branch_protection_defaults: Optional[GroupDefaultBranchProtectionDefaultsArgs] = None,
          description: Optional[str] = None,
          emails_enabled: Optional[bool] = None,
          extra_shared_runners_minutes_limit: Optional[int] = None,
          ip_restriction_ranges: Optional[Sequence[str]] = None,
          lfs_enabled: Optional[bool] = None,
          permanently_remove_on_delete: Optional[bool] = None,
          mentions_disabled: Optional[bool] = None,
          allowed_email_domains_lists: Optional[Sequence[str]] = None,
          avatar_hash: Optional[str] = None,
          avatar: Optional[str] = None,
          membership_lock: Optional[bool] = None,
          prevent_forking_outside_group: Optional[bool] = None,
          project_creation_level: Optional[str] = None,
          push_rules: Optional[GroupPushRulesArgs] = None,
          request_access_enabled: Optional[bool] = None,
          require_two_factor_authentication: Optional[bool] = None,
          share_with_group_lock: Optional[bool] = None,
          shared_runners_minutes_limit: Optional[int] = None,
          shared_runners_setting: Optional[str] = None,
          subgroup_creation_level: Optional[str] = None,
          two_factor_grace_period: Optional[int] = None,
          visibility_level: Optional[str] = None,
          wiki_access_level: Optional[str] = None)
func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)
public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)
public Group(String name, GroupArgs args)
public Group(String name, GroupArgs args, CustomResourceOptions options)

type: gitlab:Group
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. GroupArgs
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. GroupArgs
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. GroupArgs
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. GroupArgs
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. GroupArgs
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 groupResource = new GitLab.Group("groupResource", new()
{
    Path = "string",
    Name = "string",
    ParentId = 0,
    DefaultBranch = "string",
    AutoDevopsEnabled = false,
    DefaultBranchProtectionDefaults = new GitLab.Inputs.GroupDefaultBranchProtectionDefaultsArgs
    {
        AllowForcePush = false,
        AllowedToMerges = new[]
        {
            "string",
        },
        AllowedToPushes = new[]
        {
            "string",
        },
        DeveloperCanInitialPush = false,
    },
    Description = "string",
    EmailsEnabled = false,
    ExtraSharedRunnersMinutesLimit = 0,
    IpRestrictionRanges = new[]
    {
        "string",
    },
    LfsEnabled = false,
    PermanentlyRemoveOnDelete = false,
    MentionsDisabled = false,
    AllowedEmailDomainsLists = new[]
    {
        "string",
    },
    AvatarHash = "string",
    Avatar = "string",
    MembershipLock = false,
    PreventForkingOutsideGroup = false,
    ProjectCreationLevel = "string",
    PushRules = new GitLab.Inputs.GroupPushRulesArgs
    {
        AuthorEmailRegex = "string",
        BranchNameRegex = "string",
        CommitCommitterCheck = false,
        CommitCommitterNameCheck = false,
        CommitMessageNegativeRegex = "string",
        CommitMessageRegex = "string",
        DenyDeleteTag = false,
        FileNameRegex = "string",
        MaxFileSize = 0,
        MemberCheck = false,
        PreventSecrets = false,
        RejectNonDcoCommits = false,
        RejectUnsignedCommits = false,
    },
    RequestAccessEnabled = false,
    RequireTwoFactorAuthentication = false,
    ShareWithGroupLock = false,
    SharedRunnersMinutesLimit = 0,
    SharedRunnersSetting = "string",
    SubgroupCreationLevel = "string",
    TwoFactorGracePeriod = 0,
    VisibilityLevel = "string",
    WikiAccessLevel = "string",
});
Copy
example, err := gitlab.NewGroup(ctx, "groupResource", &gitlab.GroupArgs{
	Path:              pulumi.String("string"),
	Name:              pulumi.String("string"),
	ParentId:          pulumi.Int(0),
	DefaultBranch:     pulumi.String("string"),
	AutoDevopsEnabled: pulumi.Bool(false),
	DefaultBranchProtectionDefaults: &gitlab.GroupDefaultBranchProtectionDefaultsArgs{
		AllowForcePush: pulumi.Bool(false),
		AllowedToMerges: pulumi.StringArray{
			pulumi.String("string"),
		},
		AllowedToPushes: pulumi.StringArray{
			pulumi.String("string"),
		},
		DeveloperCanInitialPush: pulumi.Bool(false),
	},
	Description:                    pulumi.String("string"),
	EmailsEnabled:                  pulumi.Bool(false),
	ExtraSharedRunnersMinutesLimit: pulumi.Int(0),
	IpRestrictionRanges: pulumi.StringArray{
		pulumi.String("string"),
	},
	LfsEnabled:                pulumi.Bool(false),
	PermanentlyRemoveOnDelete: pulumi.Bool(false),
	MentionsDisabled:          pulumi.Bool(false),
	AllowedEmailDomainsLists: pulumi.StringArray{
		pulumi.String("string"),
	},
	AvatarHash:                 pulumi.String("string"),
	Avatar:                     pulumi.String("string"),
	MembershipLock:             pulumi.Bool(false),
	PreventForkingOutsideGroup: pulumi.Bool(false),
	ProjectCreationLevel:       pulumi.String("string"),
	PushRules: &gitlab.GroupPushRulesArgs{
		AuthorEmailRegex:           pulumi.String("string"),
		BranchNameRegex:            pulumi.String("string"),
		CommitCommitterCheck:       pulumi.Bool(false),
		CommitCommitterNameCheck:   pulumi.Bool(false),
		CommitMessageNegativeRegex: pulumi.String("string"),
		CommitMessageRegex:         pulumi.String("string"),
		DenyDeleteTag:              pulumi.Bool(false),
		FileNameRegex:              pulumi.String("string"),
		MaxFileSize:                pulumi.Int(0),
		MemberCheck:                pulumi.Bool(false),
		PreventSecrets:             pulumi.Bool(false),
		RejectNonDcoCommits:        pulumi.Bool(false),
		RejectUnsignedCommits:      pulumi.Bool(false),
	},
	RequestAccessEnabled:           pulumi.Bool(false),
	RequireTwoFactorAuthentication: pulumi.Bool(false),
	ShareWithGroupLock:             pulumi.Bool(false),
	SharedRunnersMinutesLimit:      pulumi.Int(0),
	SharedRunnersSetting:           pulumi.String("string"),
	SubgroupCreationLevel:          pulumi.String("string"),
	TwoFactorGracePeriod:           pulumi.Int(0),
	VisibilityLevel:                pulumi.String("string"),
	WikiAccessLevel:                pulumi.String("string"),
})
Copy
var groupResource = new Group("groupResource", GroupArgs.builder()
    .path("string")
    .name("string")
    .parentId(0)
    .defaultBranch("string")
    .autoDevopsEnabled(false)
    .defaultBranchProtectionDefaults(GroupDefaultBranchProtectionDefaultsArgs.builder()
        .allowForcePush(false)
        .allowedToMerges("string")
        .allowedToPushes("string")
        .developerCanInitialPush(false)
        .build())
    .description("string")
    .emailsEnabled(false)
    .extraSharedRunnersMinutesLimit(0)
    .ipRestrictionRanges("string")
    .lfsEnabled(false)
    .permanentlyRemoveOnDelete(false)
    .mentionsDisabled(false)
    .allowedEmailDomainsLists("string")
    .avatarHash("string")
    .avatar("string")
    .membershipLock(false)
    .preventForkingOutsideGroup(false)
    .projectCreationLevel("string")
    .pushRules(GroupPushRulesArgs.builder()
        .authorEmailRegex("string")
        .branchNameRegex("string")
        .commitCommitterCheck(false)
        .commitCommitterNameCheck(false)
        .commitMessageNegativeRegex("string")
        .commitMessageRegex("string")
        .denyDeleteTag(false)
        .fileNameRegex("string")
        .maxFileSize(0)
        .memberCheck(false)
        .preventSecrets(false)
        .rejectNonDcoCommits(false)
        .rejectUnsignedCommits(false)
        .build())
    .requestAccessEnabled(false)
    .requireTwoFactorAuthentication(false)
    .shareWithGroupLock(false)
    .sharedRunnersMinutesLimit(0)
    .sharedRunnersSetting("string")
    .subgroupCreationLevel("string")
    .twoFactorGracePeriod(0)
    .visibilityLevel("string")
    .wikiAccessLevel("string")
    .build());
Copy
group_resource = gitlab.Group("groupResource",
    path="string",
    name="string",
    parent_id=0,
    default_branch="string",
    auto_devops_enabled=False,
    default_branch_protection_defaults={
        "allow_force_push": False,
        "allowed_to_merges": ["string"],
        "allowed_to_pushes": ["string"],
        "developer_can_initial_push": False,
    },
    description="string",
    emails_enabled=False,
    extra_shared_runners_minutes_limit=0,
    ip_restriction_ranges=["string"],
    lfs_enabled=False,
    permanently_remove_on_delete=False,
    mentions_disabled=False,
    allowed_email_domains_lists=["string"],
    avatar_hash="string",
    avatar="string",
    membership_lock=False,
    prevent_forking_outside_group=False,
    project_creation_level="string",
    push_rules={
        "author_email_regex": "string",
        "branch_name_regex": "string",
        "commit_committer_check": False,
        "commit_committer_name_check": False,
        "commit_message_negative_regex": "string",
        "commit_message_regex": "string",
        "deny_delete_tag": False,
        "file_name_regex": "string",
        "max_file_size": 0,
        "member_check": False,
        "prevent_secrets": False,
        "reject_non_dco_commits": False,
        "reject_unsigned_commits": False,
    },
    request_access_enabled=False,
    require_two_factor_authentication=False,
    share_with_group_lock=False,
    shared_runners_minutes_limit=0,
    shared_runners_setting="string",
    subgroup_creation_level="string",
    two_factor_grace_period=0,
    visibility_level="string",
    wiki_access_level="string")
Copy
const groupResource = new gitlab.Group("groupResource", {
    path: "string",
    name: "string",
    parentId: 0,
    defaultBranch: "string",
    autoDevopsEnabled: false,
    defaultBranchProtectionDefaults: {
        allowForcePush: false,
        allowedToMerges: ["string"],
        allowedToPushes: ["string"],
        developerCanInitialPush: false,
    },
    description: "string",
    emailsEnabled: false,
    extraSharedRunnersMinutesLimit: 0,
    ipRestrictionRanges: ["string"],
    lfsEnabled: false,
    permanentlyRemoveOnDelete: false,
    mentionsDisabled: false,
    allowedEmailDomainsLists: ["string"],
    avatarHash: "string",
    avatar: "string",
    membershipLock: false,
    preventForkingOutsideGroup: false,
    projectCreationLevel: "string",
    pushRules: {
        authorEmailRegex: "string",
        branchNameRegex: "string",
        commitCommitterCheck: false,
        commitCommitterNameCheck: false,
        commitMessageNegativeRegex: "string",
        commitMessageRegex: "string",
        denyDeleteTag: false,
        fileNameRegex: "string",
        maxFileSize: 0,
        memberCheck: false,
        preventSecrets: false,
        rejectNonDcoCommits: false,
        rejectUnsignedCommits: false,
    },
    requestAccessEnabled: false,
    requireTwoFactorAuthentication: false,
    shareWithGroupLock: false,
    sharedRunnersMinutesLimit: 0,
    sharedRunnersSetting: "string",
    subgroupCreationLevel: "string",
    twoFactorGracePeriod: 0,
    visibilityLevel: "string",
    wikiAccessLevel: "string",
});
Copy
type: gitlab:Group
properties:
    allowedEmailDomainsLists:
        - string
    autoDevopsEnabled: false
    avatar: string
    avatarHash: string
    defaultBranch: string
    defaultBranchProtectionDefaults:
        allowForcePush: false
        allowedToMerges:
            - string
        allowedToPushes:
            - string
        developerCanInitialPush: false
    description: string
    emailsEnabled: false
    extraSharedRunnersMinutesLimit: 0
    ipRestrictionRanges:
        - string
    lfsEnabled: false
    membershipLock: false
    mentionsDisabled: false
    name: string
    parentId: 0
    path: string
    permanentlyRemoveOnDelete: false
    preventForkingOutsideGroup: false
    projectCreationLevel: string
    pushRules:
        authorEmailRegex: string
        branchNameRegex: string
        commitCommitterCheck: false
        commitCommitterNameCheck: false
        commitMessageNegativeRegex: string
        commitMessageRegex: string
        denyDeleteTag: false
        fileNameRegex: string
        maxFileSize: 0
        memberCheck: false
        preventSecrets: false
        rejectNonDcoCommits: false
        rejectUnsignedCommits: false
    requestAccessEnabled: false
    requireTwoFactorAuthentication: false
    shareWithGroupLock: false
    sharedRunnersMinutesLimit: 0
    sharedRunnersSetting: string
    subgroupCreationLevel: string
    twoFactorGracePeriod: 0
    visibilityLevel: string
    wikiAccessLevel: string
Copy

Group 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 Group resource accepts the following input properties:

Path This property is required. string
The path of the group.
AllowedEmailDomainsLists List<string>
A list of email address domains to allow group access. Will be concatenated together into a comma separated string.
AutoDevopsEnabled bool
Default to Auto DevOps pipeline for all projects within this group.
Avatar string
A local path to the avatar image to upload. Note: not available for imported resources.
AvatarHash string
The hash of the avatar image. Use filesha256("path/to/avatar.png") whenever possible. Note: this is used to trigger an update of the avatar. If it's not given, but an avatar is given, the avatar will be updated each time.
DefaultBranch string
Initial default branch name.
DefaultBranchProtection int
See https://docs.gitlab.com/api/groups/#options-for-defaultbranchprotection. Valid values are: 0, 1, 2, 3, 4.

Deprecated: Deprecated in GitLab 17.0. Use default_branch_protection_defaults instead.

DefaultBranchProtectionDefaults Pulumi.GitLab.Inputs.GroupDefaultBranchProtectionDefaults
The default branch protection defaults
Description string
The group's description.
EmailsEnabled bool
Enable email notifications.
ExtraSharedRunnersMinutesLimit int
Can be set by administrators only. Additional CI/CD minutes for this group.
IpRestrictionRanges List<string>
A list of IP addresses or subnet masks to restrict group access. Will be concatenated together into a comma separated string. Only allowed on top level groups.
LfsEnabled bool
Enable/disable Large File Storage (LFS) for the projects in this group.
MembershipLock bool
Users cannot be added to projects in this group.
MentionsDisabled bool
Disable the capability of a group from getting mentioned.
Name string
The name of the group.
ParentId int
Id of the parent group (creates a nested group).
PermanentlyRemoveOnDelete bool
Whether the group should be permanently removed during a delete operation. This only works with subgroups. Must be configured via an apply before the destroy is run.
PreventForkingOutsideGroup bool
Defaults to false. When enabled, users can not fork projects from this group to external namespaces.
ProjectCreationLevel string
Determine if developers can create projects in the group. Valid values are: noone, owner, maintainer, developer
PushRules Pulumi.GitLab.Inputs.GroupPushRules
Push rules for the group.
RequestAccessEnabled bool
Allow users to request member access.
RequireTwoFactorAuthentication bool
Require all users in this group to setup Two-factor authentication.
ShareWithGroupLock bool
Prevent sharing a project with another group within this group.
SharedRunnersMinutesLimit int
Can be set by administrators only. Maximum number of monthly CI/CD minutes for this group. Can be nil (default; inherit system default), 0 (unlimited), or > 0.
SharedRunnersSetting string
Enable or disable shared runners for a group’s subgroups and projects. Valid values are: enabled, disabled_and_overridable, disabled_and_unoverridable, disabled_with_override.
SubgroupCreationLevel string
Allowed to create subgroups. Valid values are: owner, maintainer.
TwoFactorGracePeriod int
Defaults to 48. Time before Two-factor authentication is enforced (in hours).
VisibilityLevel string
The group's visibility. Can be private, internal, or public. Valid values are: private, internal, public.
WikiAccessLevel string
The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are disabled, private, enabled.
Path This property is required. string
The path of the group.
AllowedEmailDomainsLists []string
A list of email address domains to allow group access. Will be concatenated together into a comma separated string.
AutoDevopsEnabled bool
Default to Auto DevOps pipeline for all projects within this group.
Avatar string
A local path to the avatar image to upload. Note: not available for imported resources.
AvatarHash string
The hash of the avatar image. Use filesha256("path/to/avatar.png") whenever possible. Note: this is used to trigger an update of the avatar. If it's not given, but an avatar is given, the avatar will be updated each time.
DefaultBranch string
Initial default branch name.
DefaultBranchProtection int
See https://docs.gitlab.com/api/groups/#options-for-defaultbranchprotection. Valid values are: 0, 1, 2, 3, 4.

Deprecated: Deprecated in GitLab 17.0. Use default_branch_protection_defaults instead.

DefaultBranchProtectionDefaults GroupDefaultBranchProtectionDefaultsArgs
The default branch protection defaults
Description string
The group's description.
EmailsEnabled bool
Enable email notifications.
ExtraSharedRunnersMinutesLimit int
Can be set by administrators only. Additional CI/CD minutes for this group.
IpRestrictionRanges []string
A list of IP addresses or subnet masks to restrict group access. Will be concatenated together into a comma separated string. Only allowed on top level groups.
LfsEnabled bool
Enable/disable Large File Storage (LFS) for the projects in this group.
MembershipLock bool
Users cannot be added to projects in this group.
MentionsDisabled bool
Disable the capability of a group from getting mentioned.
Name string
The name of the group.
ParentId int
Id of the parent group (creates a nested group).
PermanentlyRemoveOnDelete bool
Whether the group should be permanently removed during a delete operation. This only works with subgroups. Must be configured via an apply before the destroy is run.
PreventForkingOutsideGroup bool
Defaults to false. When enabled, users can not fork projects from this group to external namespaces.
ProjectCreationLevel string
Determine if developers can create projects in the group. Valid values are: noone, owner, maintainer, developer
PushRules GroupPushRulesArgs
Push rules for the group.
RequestAccessEnabled bool
Allow users to request member access.
RequireTwoFactorAuthentication bool
Require all users in this group to setup Two-factor authentication.
ShareWithGroupLock bool
Prevent sharing a project with another group within this group.
SharedRunnersMinutesLimit int
Can be set by administrators only. Maximum number of monthly CI/CD minutes for this group. Can be nil (default; inherit system default), 0 (unlimited), or > 0.
SharedRunnersSetting string
Enable or disable shared runners for a group’s subgroups and projects. Valid values are: enabled, disabled_and_overridable, disabled_and_unoverridable, disabled_with_override.
SubgroupCreationLevel string
Allowed to create subgroups. Valid values are: owner, maintainer.
TwoFactorGracePeriod int
Defaults to 48. Time before Two-factor authentication is enforced (in hours).
VisibilityLevel string
The group's visibility. Can be private, internal, or public. Valid values are: private, internal, public.
WikiAccessLevel string
The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are disabled, private, enabled.
path This property is required. String
The path of the group.
allowedEmailDomainsLists List<String>
A list of email address domains to allow group access. Will be concatenated together into a comma separated string.
autoDevopsEnabled Boolean
Default to Auto DevOps pipeline for all projects within this group.
avatar String
A local path to the avatar image to upload. Note: not available for imported resources.
avatarHash String
The hash of the avatar image. Use filesha256("path/to/avatar.png") whenever possible. Note: this is used to trigger an update of the avatar. If it's not given, but an avatar is given, the avatar will be updated each time.
defaultBranch String
Initial default branch name.
defaultBranchProtection Integer
See https://docs.gitlab.com/api/groups/#options-for-defaultbranchprotection. Valid values are: 0, 1, 2, 3, 4.

Deprecated: Deprecated in GitLab 17.0. Use default_branch_protection_defaults instead.

defaultBranchProtectionDefaults GroupDefaultBranchProtectionDefaults
The default branch protection defaults
description String
The group's description.
emailsEnabled Boolean
Enable email notifications.
extraSharedRunnersMinutesLimit Integer
Can be set by administrators only. Additional CI/CD minutes for this group.
ipRestrictionRanges List<String>
A list of IP addresses or subnet masks to restrict group access. Will be concatenated together into a comma separated string. Only allowed on top level groups.
lfsEnabled Boolean
Enable/disable Large File Storage (LFS) for the projects in this group.
membershipLock Boolean
Users cannot be added to projects in this group.
mentionsDisabled Boolean
Disable the capability of a group from getting mentioned.
name String
The name of the group.
parentId Integer
Id of the parent group (creates a nested group).
permanentlyRemoveOnDelete Boolean
Whether the group should be permanently removed during a delete operation. This only works with subgroups. Must be configured via an apply before the destroy is run.
preventForkingOutsideGroup Boolean
Defaults to false. When enabled, users can not fork projects from this group to external namespaces.
projectCreationLevel String
Determine if developers can create projects in the group. Valid values are: noone, owner, maintainer, developer
pushRules GroupPushRules
Push rules for the group.
requestAccessEnabled Boolean
Allow users to request member access.
requireTwoFactorAuthentication Boolean
Require all users in this group to setup Two-factor authentication.
shareWithGroupLock Boolean
Prevent sharing a project with another group within this group.
sharedRunnersMinutesLimit Integer
Can be set by administrators only. Maximum number of monthly CI/CD minutes for this group. Can be nil (default; inherit system default), 0 (unlimited), or > 0.
sharedRunnersSetting String
Enable or disable shared runners for a group’s subgroups and projects. Valid values are: enabled, disabled_and_overridable, disabled_and_unoverridable, disabled_with_override.
subgroupCreationLevel String
Allowed to create subgroups. Valid values are: owner, maintainer.
twoFactorGracePeriod Integer
Defaults to 48. Time before Two-factor authentication is enforced (in hours).
visibilityLevel String
The group's visibility. Can be private, internal, or public. Valid values are: private, internal, public.
wikiAccessLevel String
The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are disabled, private, enabled.
path This property is required. string
The path of the group.
allowedEmailDomainsLists string[]
A list of email address domains to allow group access. Will be concatenated together into a comma separated string.
autoDevopsEnabled boolean
Default to Auto DevOps pipeline for all projects within this group.
avatar string
A local path to the avatar image to upload. Note: not available for imported resources.
avatarHash string
The hash of the avatar image. Use filesha256("path/to/avatar.png") whenever possible. Note: this is used to trigger an update of the avatar. If it's not given, but an avatar is given, the avatar will be updated each time.
defaultBranch string
Initial default branch name.
defaultBranchProtection number
See https://docs.gitlab.com/api/groups/#options-for-defaultbranchprotection. Valid values are: 0, 1, 2, 3, 4.

Deprecated: Deprecated in GitLab 17.0. Use default_branch_protection_defaults instead.

defaultBranchProtectionDefaults GroupDefaultBranchProtectionDefaults
The default branch protection defaults
description string
The group's description.
emailsEnabled boolean
Enable email notifications.
extraSharedRunnersMinutesLimit number
Can be set by administrators only. Additional CI/CD minutes for this group.
ipRestrictionRanges string[]
A list of IP addresses or subnet masks to restrict group access. Will be concatenated together into a comma separated string. Only allowed on top level groups.
lfsEnabled boolean
Enable/disable Large File Storage (LFS) for the projects in this group.
membershipLock boolean
Users cannot be added to projects in this group.
mentionsDisabled boolean
Disable the capability of a group from getting mentioned.
name string
The name of the group.
parentId number
Id of the parent group (creates a nested group).
permanentlyRemoveOnDelete boolean
Whether the group should be permanently removed during a delete operation. This only works with subgroups. Must be configured via an apply before the destroy is run.
preventForkingOutsideGroup boolean
Defaults to false. When enabled, users can not fork projects from this group to external namespaces.
projectCreationLevel string
Determine if developers can create projects in the group. Valid values are: noone, owner, maintainer, developer
pushRules GroupPushRules
Push rules for the group.
requestAccessEnabled boolean
Allow users to request member access.
requireTwoFactorAuthentication boolean
Require all users in this group to setup Two-factor authentication.
shareWithGroupLock boolean
Prevent sharing a project with another group within this group.
sharedRunnersMinutesLimit number
Can be set by administrators only. Maximum number of monthly CI/CD minutes for this group. Can be nil (default; inherit system default), 0 (unlimited), or > 0.
sharedRunnersSetting string
Enable or disable shared runners for a group’s subgroups and projects. Valid values are: enabled, disabled_and_overridable, disabled_and_unoverridable, disabled_with_override.
subgroupCreationLevel string
Allowed to create subgroups. Valid values are: owner, maintainer.
twoFactorGracePeriod number
Defaults to 48. Time before Two-factor authentication is enforced (in hours).
visibilityLevel string
The group's visibility. Can be private, internal, or public. Valid values are: private, internal, public.
wikiAccessLevel string
The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are disabled, private, enabled.
path This property is required. str
The path of the group.
allowed_email_domains_lists Sequence[str]
A list of email address domains to allow group access. Will be concatenated together into a comma separated string.
auto_devops_enabled bool
Default to Auto DevOps pipeline for all projects within this group.
avatar str
A local path to the avatar image to upload. Note: not available for imported resources.
avatar_hash str
The hash of the avatar image. Use filesha256("path/to/avatar.png") whenever possible. Note: this is used to trigger an update of the avatar. If it's not given, but an avatar is given, the avatar will be updated each time.
default_branch str
Initial default branch name.
default_branch_protection int
See https://docs.gitlab.com/api/groups/#options-for-defaultbranchprotection. Valid values are: 0, 1, 2, 3, 4.

Deprecated: Deprecated in GitLab 17.0. Use default_branch_protection_defaults instead.

default_branch_protection_defaults GroupDefaultBranchProtectionDefaultsArgs
The default branch protection defaults
description str
The group's description.
emails_enabled bool
Enable email notifications.
extra_shared_runners_minutes_limit int
Can be set by administrators only. Additional CI/CD minutes for this group.
ip_restriction_ranges Sequence[str]
A list of IP addresses or subnet masks to restrict group access. Will be concatenated together into a comma separated string. Only allowed on top level groups.
lfs_enabled bool
Enable/disable Large File Storage (LFS) for the projects in this group.
membership_lock bool
Users cannot be added to projects in this group.
mentions_disabled bool
Disable the capability of a group from getting mentioned.
name str
The name of the group.
parent_id int
Id of the parent group (creates a nested group).
permanently_remove_on_delete bool
Whether the group should be permanently removed during a delete operation. This only works with subgroups. Must be configured via an apply before the destroy is run.
prevent_forking_outside_group bool
Defaults to false. When enabled, users can not fork projects from this group to external namespaces.
project_creation_level str
Determine if developers can create projects in the group. Valid values are: noone, owner, maintainer, developer
push_rules GroupPushRulesArgs
Push rules for the group.
request_access_enabled bool
Allow users to request member access.
require_two_factor_authentication bool
Require all users in this group to setup Two-factor authentication.
share_with_group_lock bool
Prevent sharing a project with another group within this group.
shared_runners_minutes_limit int
Can be set by administrators only. Maximum number of monthly CI/CD minutes for this group. Can be nil (default; inherit system default), 0 (unlimited), or > 0.
shared_runners_setting str
Enable or disable shared runners for a group’s subgroups and projects. Valid values are: enabled, disabled_and_overridable, disabled_and_unoverridable, disabled_with_override.
subgroup_creation_level str
Allowed to create subgroups. Valid values are: owner, maintainer.
two_factor_grace_period int
Defaults to 48. Time before Two-factor authentication is enforced (in hours).
visibility_level str
The group's visibility. Can be private, internal, or public. Valid values are: private, internal, public.
wiki_access_level str
The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are disabled, private, enabled.
path This property is required. String
The path of the group.
allowedEmailDomainsLists List<String>
A list of email address domains to allow group access. Will be concatenated together into a comma separated string.
autoDevopsEnabled Boolean
Default to Auto DevOps pipeline for all projects within this group.
avatar String
A local path to the avatar image to upload. Note: not available for imported resources.
avatarHash String
The hash of the avatar image. Use filesha256("path/to/avatar.png") whenever possible. Note: this is used to trigger an update of the avatar. If it's not given, but an avatar is given, the avatar will be updated each time.
defaultBranch String
Initial default branch name.
defaultBranchProtection Number
See https://docs.gitlab.com/api/groups/#options-for-defaultbranchprotection. Valid values are: 0, 1, 2, 3, 4.

Deprecated: Deprecated in GitLab 17.0. Use default_branch_protection_defaults instead.

defaultBranchProtectionDefaults Property Map
The default branch protection defaults
description String
The group's description.
emailsEnabled Boolean
Enable email notifications.
extraSharedRunnersMinutesLimit Number
Can be set by administrators only. Additional CI/CD minutes for this group.
ipRestrictionRanges List<String>
A list of IP addresses or subnet masks to restrict group access. Will be concatenated together into a comma separated string. Only allowed on top level groups.
lfsEnabled Boolean
Enable/disable Large File Storage (LFS) for the projects in this group.
membershipLock Boolean
Users cannot be added to projects in this group.
mentionsDisabled Boolean
Disable the capability of a group from getting mentioned.
name String
The name of the group.
parentId Number
Id of the parent group (creates a nested group).
permanentlyRemoveOnDelete Boolean
Whether the group should be permanently removed during a delete operation. This only works with subgroups. Must be configured via an apply before the destroy is run.
preventForkingOutsideGroup Boolean
Defaults to false. When enabled, users can not fork projects from this group to external namespaces.
projectCreationLevel String
Determine if developers can create projects in the group. Valid values are: noone, owner, maintainer, developer
pushRules Property Map
Push rules for the group.
requestAccessEnabled Boolean
Allow users to request member access.
requireTwoFactorAuthentication Boolean
Require all users in this group to setup Two-factor authentication.
shareWithGroupLock Boolean
Prevent sharing a project with another group within this group.
sharedRunnersMinutesLimit Number
Can be set by administrators only. Maximum number of monthly CI/CD minutes for this group. Can be nil (default; inherit system default), 0 (unlimited), or > 0.
sharedRunnersSetting String
Enable or disable shared runners for a group’s subgroups and projects. Valid values are: enabled, disabled_and_overridable, disabled_and_unoverridable, disabled_with_override.
subgroupCreationLevel String
Allowed to create subgroups. Valid values are: owner, maintainer.
twoFactorGracePeriod Number
Defaults to 48. Time before Two-factor authentication is enforced (in hours).
visibilityLevel String
The group's visibility. Can be private, internal, or public. Valid values are: private, internal, public.
wikiAccessLevel String
The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are disabled, private, enabled.

Outputs

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

AvatarUrl string
The URL of the avatar image.
FullName string
The full name of the group.
FullPath string
The full path of the group.
Id string
The provider-assigned unique ID for this managed resource.
RunnersToken string
The group level registration token to use during runner setup.
WebUrl string
Web URL of the group.
AvatarUrl string
The URL of the avatar image.
FullName string
The full name of the group.
FullPath string
The full path of the group.
Id string
The provider-assigned unique ID for this managed resource.
RunnersToken string
The group level registration token to use during runner setup.
WebUrl string
Web URL of the group.
avatarUrl String
The URL of the avatar image.
fullName String
The full name of the group.
fullPath String
The full path of the group.
id String
The provider-assigned unique ID for this managed resource.
runnersToken String
The group level registration token to use during runner setup.
webUrl String
Web URL of the group.
avatarUrl string
The URL of the avatar image.
fullName string
The full name of the group.
fullPath string
The full path of the group.
id string
The provider-assigned unique ID for this managed resource.
runnersToken string
The group level registration token to use during runner setup.
webUrl string
Web URL of the group.
avatar_url str
The URL of the avatar image.
full_name str
The full name of the group.
full_path str
The full path of the group.
id str
The provider-assigned unique ID for this managed resource.
runners_token str
The group level registration token to use during runner setup.
web_url str
Web URL of the group.
avatarUrl String
The URL of the avatar image.
fullName String
The full name of the group.
fullPath String
The full path of the group.
id String
The provider-assigned unique ID for this managed resource.
runnersToken String
The group level registration token to use during runner setup.
webUrl String
Web URL of the group.

Look up Existing Group Resource

Get an existing Group 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?: GroupState, opts?: CustomResourceOptions): Group
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allowed_email_domains_lists: Optional[Sequence[str]] = None,
        auto_devops_enabled: Optional[bool] = None,
        avatar: Optional[str] = None,
        avatar_hash: Optional[str] = None,
        avatar_url: Optional[str] = None,
        default_branch: Optional[str] = None,
        default_branch_protection: Optional[int] = None,
        default_branch_protection_defaults: Optional[GroupDefaultBranchProtectionDefaultsArgs] = None,
        description: Optional[str] = None,
        emails_enabled: Optional[bool] = None,
        extra_shared_runners_minutes_limit: Optional[int] = None,
        full_name: Optional[str] = None,
        full_path: Optional[str] = None,
        ip_restriction_ranges: Optional[Sequence[str]] = None,
        lfs_enabled: Optional[bool] = None,
        membership_lock: Optional[bool] = None,
        mentions_disabled: Optional[bool] = None,
        name: Optional[str] = None,
        parent_id: Optional[int] = None,
        path: Optional[str] = None,
        permanently_remove_on_delete: Optional[bool] = None,
        prevent_forking_outside_group: Optional[bool] = None,
        project_creation_level: Optional[str] = None,
        push_rules: Optional[GroupPushRulesArgs] = None,
        request_access_enabled: Optional[bool] = None,
        require_two_factor_authentication: Optional[bool] = None,
        runners_token: Optional[str] = None,
        share_with_group_lock: Optional[bool] = None,
        shared_runners_minutes_limit: Optional[int] = None,
        shared_runners_setting: Optional[str] = None,
        subgroup_creation_level: Optional[str] = None,
        two_factor_grace_period: Optional[int] = None,
        visibility_level: Optional[str] = None,
        web_url: Optional[str] = None,
        wiki_access_level: Optional[str] = None) -> Group
func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)
public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)
public static Group get(String name, Output<String> id, GroupState state, CustomResourceOptions options)
resources:  _:    type: gitlab:Group    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:
AllowedEmailDomainsLists List<string>
A list of email address domains to allow group access. Will be concatenated together into a comma separated string.
AutoDevopsEnabled bool
Default to Auto DevOps pipeline for all projects within this group.
Avatar string
A local path to the avatar image to upload. Note: not available for imported resources.
AvatarHash string
The hash of the avatar image. Use filesha256("path/to/avatar.png") whenever possible. Note: this is used to trigger an update of the avatar. If it's not given, but an avatar is given, the avatar will be updated each time.
AvatarUrl string
The URL of the avatar image.
DefaultBranch string
Initial default branch name.
DefaultBranchProtection int
See https://docs.gitlab.com/api/groups/#options-for-defaultbranchprotection. Valid values are: 0, 1, 2, 3, 4.

Deprecated: Deprecated in GitLab 17.0. Use default_branch_protection_defaults instead.

DefaultBranchProtectionDefaults Pulumi.GitLab.Inputs.GroupDefaultBranchProtectionDefaults
The default branch protection defaults
Description string
The group's description.
EmailsEnabled bool
Enable email notifications.
ExtraSharedRunnersMinutesLimit int
Can be set by administrators only. Additional CI/CD minutes for this group.
FullName string
The full name of the group.
FullPath string
The full path of the group.
IpRestrictionRanges List<string>
A list of IP addresses or subnet masks to restrict group access. Will be concatenated together into a comma separated string. Only allowed on top level groups.
LfsEnabled bool
Enable/disable Large File Storage (LFS) for the projects in this group.
MembershipLock bool
Users cannot be added to projects in this group.
MentionsDisabled bool
Disable the capability of a group from getting mentioned.
Name string
The name of the group.
ParentId int
Id of the parent group (creates a nested group).
Path string
The path of the group.
PermanentlyRemoveOnDelete bool
Whether the group should be permanently removed during a delete operation. This only works with subgroups. Must be configured via an apply before the destroy is run.
PreventForkingOutsideGroup bool
Defaults to false. When enabled, users can not fork projects from this group to external namespaces.
ProjectCreationLevel string
Determine if developers can create projects in the group. Valid values are: noone, owner, maintainer, developer
PushRules Pulumi.GitLab.Inputs.GroupPushRules
Push rules for the group.
RequestAccessEnabled bool
Allow users to request member access.
RequireTwoFactorAuthentication bool
Require all users in this group to setup Two-factor authentication.
RunnersToken string
The group level registration token to use during runner setup.
ShareWithGroupLock bool
Prevent sharing a project with another group within this group.
SharedRunnersMinutesLimit int
Can be set by administrators only. Maximum number of monthly CI/CD minutes for this group. Can be nil (default; inherit system default), 0 (unlimited), or > 0.
SharedRunnersSetting string
Enable or disable shared runners for a group’s subgroups and projects. Valid values are: enabled, disabled_and_overridable, disabled_and_unoverridable, disabled_with_override.
SubgroupCreationLevel string
Allowed to create subgroups. Valid values are: owner, maintainer.
TwoFactorGracePeriod int
Defaults to 48. Time before Two-factor authentication is enforced (in hours).
VisibilityLevel string
The group's visibility. Can be private, internal, or public. Valid values are: private, internal, public.
WebUrl string
Web URL of the group.
WikiAccessLevel string
The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are disabled, private, enabled.
AllowedEmailDomainsLists []string
A list of email address domains to allow group access. Will be concatenated together into a comma separated string.
AutoDevopsEnabled bool
Default to Auto DevOps pipeline for all projects within this group.
Avatar string
A local path to the avatar image to upload. Note: not available for imported resources.
AvatarHash string
The hash of the avatar image. Use filesha256("path/to/avatar.png") whenever possible. Note: this is used to trigger an update of the avatar. If it's not given, but an avatar is given, the avatar will be updated each time.
AvatarUrl string
The URL of the avatar image.
DefaultBranch string
Initial default branch name.
DefaultBranchProtection int
See https://docs.gitlab.com/api/groups/#options-for-defaultbranchprotection. Valid values are: 0, 1, 2, 3, 4.

Deprecated: Deprecated in GitLab 17.0. Use default_branch_protection_defaults instead.

DefaultBranchProtectionDefaults GroupDefaultBranchProtectionDefaultsArgs
The default branch protection defaults
Description string
The group's description.
EmailsEnabled bool
Enable email notifications.
ExtraSharedRunnersMinutesLimit int
Can be set by administrators only. Additional CI/CD minutes for this group.
FullName string
The full name of the group.
FullPath string
The full path of the group.
IpRestrictionRanges []string
A list of IP addresses or subnet masks to restrict group access. Will be concatenated together into a comma separated string. Only allowed on top level groups.
LfsEnabled bool
Enable/disable Large File Storage (LFS) for the projects in this group.
MembershipLock bool
Users cannot be added to projects in this group.
MentionsDisabled bool
Disable the capability of a group from getting mentioned.
Name string
The name of the group.
ParentId int
Id of the parent group (creates a nested group).
Path string
The path of the group.
PermanentlyRemoveOnDelete bool
Whether the group should be permanently removed during a delete operation. This only works with subgroups. Must be configured via an apply before the destroy is run.
PreventForkingOutsideGroup bool
Defaults to false. When enabled, users can not fork projects from this group to external namespaces.
ProjectCreationLevel string
Determine if developers can create projects in the group. Valid values are: noone, owner, maintainer, developer
PushRules GroupPushRulesArgs
Push rules for the group.
RequestAccessEnabled bool
Allow users to request member access.
RequireTwoFactorAuthentication bool
Require all users in this group to setup Two-factor authentication.
RunnersToken string
The group level registration token to use during runner setup.
ShareWithGroupLock bool
Prevent sharing a project with another group within this group.
SharedRunnersMinutesLimit int
Can be set by administrators only. Maximum number of monthly CI/CD minutes for this group. Can be nil (default; inherit system default), 0 (unlimited), or > 0.
SharedRunnersSetting string
Enable or disable shared runners for a group’s subgroups and projects. Valid values are: enabled, disabled_and_overridable, disabled_and_unoverridable, disabled_with_override.
SubgroupCreationLevel string
Allowed to create subgroups. Valid values are: owner, maintainer.
TwoFactorGracePeriod int
Defaults to 48. Time before Two-factor authentication is enforced (in hours).
VisibilityLevel string
The group's visibility. Can be private, internal, or public. Valid values are: private, internal, public.
WebUrl string
Web URL of the group.
WikiAccessLevel string
The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are disabled, private, enabled.
allowedEmailDomainsLists List<String>
A list of email address domains to allow group access. Will be concatenated together into a comma separated string.
autoDevopsEnabled Boolean
Default to Auto DevOps pipeline for all projects within this group.
avatar String
A local path to the avatar image to upload. Note: not available for imported resources.
avatarHash String
The hash of the avatar image. Use filesha256("path/to/avatar.png") whenever possible. Note: this is used to trigger an update of the avatar. If it's not given, but an avatar is given, the avatar will be updated each time.
avatarUrl String
The URL of the avatar image.
defaultBranch String
Initial default branch name.
defaultBranchProtection Integer
See https://docs.gitlab.com/api/groups/#options-for-defaultbranchprotection. Valid values are: 0, 1, 2, 3, 4.

Deprecated: Deprecated in GitLab 17.0. Use default_branch_protection_defaults instead.

defaultBranchProtectionDefaults GroupDefaultBranchProtectionDefaults
The default branch protection defaults
description String
The group's description.
emailsEnabled Boolean
Enable email notifications.
extraSharedRunnersMinutesLimit Integer
Can be set by administrators only. Additional CI/CD minutes for this group.
fullName String
The full name of the group.
fullPath String
The full path of the group.
ipRestrictionRanges List<String>
A list of IP addresses or subnet masks to restrict group access. Will be concatenated together into a comma separated string. Only allowed on top level groups.
lfsEnabled Boolean
Enable/disable Large File Storage (LFS) for the projects in this group.
membershipLock Boolean
Users cannot be added to projects in this group.
mentionsDisabled Boolean
Disable the capability of a group from getting mentioned.
name String
The name of the group.
parentId Integer
Id of the parent group (creates a nested group).
path String
The path of the group.
permanentlyRemoveOnDelete Boolean
Whether the group should be permanently removed during a delete operation. This only works with subgroups. Must be configured via an apply before the destroy is run.
preventForkingOutsideGroup Boolean
Defaults to false. When enabled, users can not fork projects from this group to external namespaces.
projectCreationLevel String
Determine if developers can create projects in the group. Valid values are: noone, owner, maintainer, developer
pushRules GroupPushRules
Push rules for the group.
requestAccessEnabled Boolean
Allow users to request member access.
requireTwoFactorAuthentication Boolean
Require all users in this group to setup Two-factor authentication.
runnersToken String
The group level registration token to use during runner setup.
shareWithGroupLock Boolean
Prevent sharing a project with another group within this group.
sharedRunnersMinutesLimit Integer
Can be set by administrators only. Maximum number of monthly CI/CD minutes for this group. Can be nil (default; inherit system default), 0 (unlimited), or > 0.
sharedRunnersSetting String
Enable or disable shared runners for a group’s subgroups and projects. Valid values are: enabled, disabled_and_overridable, disabled_and_unoverridable, disabled_with_override.
subgroupCreationLevel String
Allowed to create subgroups. Valid values are: owner, maintainer.
twoFactorGracePeriod Integer
Defaults to 48. Time before Two-factor authentication is enforced (in hours).
visibilityLevel String
The group's visibility. Can be private, internal, or public. Valid values are: private, internal, public.
webUrl String
Web URL of the group.
wikiAccessLevel String
The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are disabled, private, enabled.
allowedEmailDomainsLists string[]
A list of email address domains to allow group access. Will be concatenated together into a comma separated string.
autoDevopsEnabled boolean
Default to Auto DevOps pipeline for all projects within this group.
avatar string
A local path to the avatar image to upload. Note: not available for imported resources.
avatarHash string
The hash of the avatar image. Use filesha256("path/to/avatar.png") whenever possible. Note: this is used to trigger an update of the avatar. If it's not given, but an avatar is given, the avatar will be updated each time.
avatarUrl string
The URL of the avatar image.
defaultBranch string
Initial default branch name.
defaultBranchProtection number
See https://docs.gitlab.com/api/groups/#options-for-defaultbranchprotection. Valid values are: 0, 1, 2, 3, 4.

Deprecated: Deprecated in GitLab 17.0. Use default_branch_protection_defaults instead.

defaultBranchProtectionDefaults GroupDefaultBranchProtectionDefaults
The default branch protection defaults
description string
The group's description.
emailsEnabled boolean
Enable email notifications.
extraSharedRunnersMinutesLimit number
Can be set by administrators only. Additional CI/CD minutes for this group.
fullName string
The full name of the group.
fullPath string
The full path of the group.
ipRestrictionRanges string[]
A list of IP addresses or subnet masks to restrict group access. Will be concatenated together into a comma separated string. Only allowed on top level groups.
lfsEnabled boolean
Enable/disable Large File Storage (LFS) for the projects in this group.
membershipLock boolean
Users cannot be added to projects in this group.
mentionsDisabled boolean
Disable the capability of a group from getting mentioned.
name string
The name of the group.
parentId number
Id of the parent group (creates a nested group).
path string
The path of the group.
permanentlyRemoveOnDelete boolean
Whether the group should be permanently removed during a delete operation. This only works with subgroups. Must be configured via an apply before the destroy is run.
preventForkingOutsideGroup boolean
Defaults to false. When enabled, users can not fork projects from this group to external namespaces.
projectCreationLevel string
Determine if developers can create projects in the group. Valid values are: noone, owner, maintainer, developer
pushRules GroupPushRules
Push rules for the group.
requestAccessEnabled boolean
Allow users to request member access.
requireTwoFactorAuthentication boolean
Require all users in this group to setup Two-factor authentication.
runnersToken string
The group level registration token to use during runner setup.
shareWithGroupLock boolean
Prevent sharing a project with another group within this group.
sharedRunnersMinutesLimit number
Can be set by administrators only. Maximum number of monthly CI/CD minutes for this group. Can be nil (default; inherit system default), 0 (unlimited), or > 0.
sharedRunnersSetting string
Enable or disable shared runners for a group’s subgroups and projects. Valid values are: enabled, disabled_and_overridable, disabled_and_unoverridable, disabled_with_override.
subgroupCreationLevel string
Allowed to create subgroups. Valid values are: owner, maintainer.
twoFactorGracePeriod number
Defaults to 48. Time before Two-factor authentication is enforced (in hours).
visibilityLevel string
The group's visibility. Can be private, internal, or public. Valid values are: private, internal, public.
webUrl string
Web URL of the group.
wikiAccessLevel string
The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are disabled, private, enabled.
allowed_email_domains_lists Sequence[str]
A list of email address domains to allow group access. Will be concatenated together into a comma separated string.
auto_devops_enabled bool
Default to Auto DevOps pipeline for all projects within this group.
avatar str
A local path to the avatar image to upload. Note: not available for imported resources.
avatar_hash str
The hash of the avatar image. Use filesha256("path/to/avatar.png") whenever possible. Note: this is used to trigger an update of the avatar. If it's not given, but an avatar is given, the avatar will be updated each time.
avatar_url str
The URL of the avatar image.
default_branch str
Initial default branch name.
default_branch_protection int
See https://docs.gitlab.com/api/groups/#options-for-defaultbranchprotection. Valid values are: 0, 1, 2, 3, 4.

Deprecated: Deprecated in GitLab 17.0. Use default_branch_protection_defaults instead.

default_branch_protection_defaults GroupDefaultBranchProtectionDefaultsArgs
The default branch protection defaults
description str
The group's description.
emails_enabled bool
Enable email notifications.
extra_shared_runners_minutes_limit int
Can be set by administrators only. Additional CI/CD minutes for this group.
full_name str
The full name of the group.
full_path str
The full path of the group.
ip_restriction_ranges Sequence[str]
A list of IP addresses or subnet masks to restrict group access. Will be concatenated together into a comma separated string. Only allowed on top level groups.
lfs_enabled bool
Enable/disable Large File Storage (LFS) for the projects in this group.
membership_lock bool
Users cannot be added to projects in this group.
mentions_disabled bool
Disable the capability of a group from getting mentioned.
name str
The name of the group.
parent_id int
Id of the parent group (creates a nested group).
path str
The path of the group.
permanently_remove_on_delete bool
Whether the group should be permanently removed during a delete operation. This only works with subgroups. Must be configured via an apply before the destroy is run.
prevent_forking_outside_group bool
Defaults to false. When enabled, users can not fork projects from this group to external namespaces.
project_creation_level str
Determine if developers can create projects in the group. Valid values are: noone, owner, maintainer, developer
push_rules GroupPushRulesArgs
Push rules for the group.
request_access_enabled bool
Allow users to request member access.
require_two_factor_authentication bool
Require all users in this group to setup Two-factor authentication.
runners_token str
The group level registration token to use during runner setup.
share_with_group_lock bool
Prevent sharing a project with another group within this group.
shared_runners_minutes_limit int
Can be set by administrators only. Maximum number of monthly CI/CD minutes for this group. Can be nil (default; inherit system default), 0 (unlimited), or > 0.
shared_runners_setting str
Enable or disable shared runners for a group’s subgroups and projects. Valid values are: enabled, disabled_and_overridable, disabled_and_unoverridable, disabled_with_override.
subgroup_creation_level str
Allowed to create subgroups. Valid values are: owner, maintainer.
two_factor_grace_period int
Defaults to 48. Time before Two-factor authentication is enforced (in hours).
visibility_level str
The group's visibility. Can be private, internal, or public. Valid values are: private, internal, public.
web_url str
Web URL of the group.
wiki_access_level str
The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are disabled, private, enabled.
allowedEmailDomainsLists List<String>
A list of email address domains to allow group access. Will be concatenated together into a comma separated string.
autoDevopsEnabled Boolean
Default to Auto DevOps pipeline for all projects within this group.
avatar String
A local path to the avatar image to upload. Note: not available for imported resources.
avatarHash String
The hash of the avatar image. Use filesha256("path/to/avatar.png") whenever possible. Note: this is used to trigger an update of the avatar. If it's not given, but an avatar is given, the avatar will be updated each time.
avatarUrl String
The URL of the avatar image.
defaultBranch String
Initial default branch name.
defaultBranchProtection Number
See https://docs.gitlab.com/api/groups/#options-for-defaultbranchprotection. Valid values are: 0, 1, 2, 3, 4.

Deprecated: Deprecated in GitLab 17.0. Use default_branch_protection_defaults instead.

defaultBranchProtectionDefaults Property Map
The default branch protection defaults
description String
The group's description.
emailsEnabled Boolean
Enable email notifications.
extraSharedRunnersMinutesLimit Number
Can be set by administrators only. Additional CI/CD minutes for this group.
fullName String
The full name of the group.
fullPath String
The full path of the group.
ipRestrictionRanges List<String>
A list of IP addresses or subnet masks to restrict group access. Will be concatenated together into a comma separated string. Only allowed on top level groups.
lfsEnabled Boolean
Enable/disable Large File Storage (LFS) for the projects in this group.
membershipLock Boolean
Users cannot be added to projects in this group.
mentionsDisabled Boolean
Disable the capability of a group from getting mentioned.
name String
The name of the group.
parentId Number
Id of the parent group (creates a nested group).
path String
The path of the group.
permanentlyRemoveOnDelete Boolean
Whether the group should be permanently removed during a delete operation. This only works with subgroups. Must be configured via an apply before the destroy is run.
preventForkingOutsideGroup Boolean
Defaults to false. When enabled, users can not fork projects from this group to external namespaces.
projectCreationLevel String
Determine if developers can create projects in the group. Valid values are: noone, owner, maintainer, developer
pushRules Property Map
Push rules for the group.
requestAccessEnabled Boolean
Allow users to request member access.
requireTwoFactorAuthentication Boolean
Require all users in this group to setup Two-factor authentication.
runnersToken String
The group level registration token to use during runner setup.
shareWithGroupLock Boolean
Prevent sharing a project with another group within this group.
sharedRunnersMinutesLimit Number
Can be set by administrators only. Maximum number of monthly CI/CD minutes for this group. Can be nil (default; inherit system default), 0 (unlimited), or > 0.
sharedRunnersSetting String
Enable or disable shared runners for a group’s subgroups and projects. Valid values are: enabled, disabled_and_overridable, disabled_and_unoverridable, disabled_with_override.
subgroupCreationLevel String
Allowed to create subgroups. Valid values are: owner, maintainer.
twoFactorGracePeriod Number
Defaults to 48. Time before Two-factor authentication is enforced (in hours).
visibilityLevel String
The group's visibility. Can be private, internal, or public. Valid values are: private, internal, public.
webUrl String
Web URL of the group.
wikiAccessLevel String
The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are disabled, private, enabled.

Supporting Types

GroupDefaultBranchProtectionDefaults
, GroupDefaultBranchProtectionDefaultsArgs

AllowForcePush bool
Allow force push for all users with push access.
AllowedToMerges List<string>
An array of access levels allowed to merge. Valid values are: developer, maintainer, no one.
AllowedToPushes List<string>
An array of access levels allowed to push. Valid values are: developer, maintainer, no one.
DeveloperCanInitialPush bool
Allow developers to initial push.
AllowForcePush bool
Allow force push for all users with push access.
AllowedToMerges []string
An array of access levels allowed to merge. Valid values are: developer, maintainer, no one.
AllowedToPushes []string
An array of access levels allowed to push. Valid values are: developer, maintainer, no one.
DeveloperCanInitialPush bool
Allow developers to initial push.
allowForcePush Boolean
Allow force push for all users with push access.
allowedToMerges List<String>
An array of access levels allowed to merge. Valid values are: developer, maintainer, no one.
allowedToPushes List<String>
An array of access levels allowed to push. Valid values are: developer, maintainer, no one.
developerCanInitialPush Boolean
Allow developers to initial push.
allowForcePush boolean
Allow force push for all users with push access.
allowedToMerges string[]
An array of access levels allowed to merge. Valid values are: developer, maintainer, no one.
allowedToPushes string[]
An array of access levels allowed to push. Valid values are: developer, maintainer, no one.
developerCanInitialPush boolean
Allow developers to initial push.
allow_force_push bool
Allow force push for all users with push access.
allowed_to_merges Sequence[str]
An array of access levels allowed to merge. Valid values are: developer, maintainer, no one.
allowed_to_pushes Sequence[str]
An array of access levels allowed to push. Valid values are: developer, maintainer, no one.
developer_can_initial_push bool
Allow developers to initial push.
allowForcePush Boolean
Allow force push for all users with push access.
allowedToMerges List<String>
An array of access levels allowed to merge. Valid values are: developer, maintainer, no one.
allowedToPushes List<String>
An array of access levels allowed to push. Valid values are: developer, maintainer, no one.
developerCanInitialPush Boolean
Allow developers to initial push.

GroupPushRules
, GroupPushRulesArgs

AuthorEmailRegex string
All commit author emails must match this regex, e.g. @my-company.com$.
BranchNameRegex string
All branch names must match this regex, e.g. (feature|hotfix)\/*.
CommitCommitterCheck bool
Only commits pushed using verified emails are allowed.
CommitCommitterNameCheck bool
Users can only push commits to this repository if the commit author name is consistent with their GitLab account name.
CommitMessageNegativeRegex string
No commit message is allowed to match this regex, for example ssh\:\/\/.
CommitMessageRegex string
All commit messages must match this regex, e.g. Fixed \d+\..*.
DenyDeleteTag bool
Deny deleting a tag.
FileNameRegex string
Filenames matching the regular expression provided in this attribute are not allowed, for example, (jar|exe)$.
MaxFileSize int
Maximum file size (MB) allowed.
MemberCheck bool
Allows only GitLab users to author commits.
PreventSecrets bool
GitLab will reject any files that are likely to contain secrets.
RejectNonDcoCommits bool
Reject commit when it’s not DCO certified.
RejectUnsignedCommits bool
Only commits signed through GPG are allowed.
AuthorEmailRegex string
All commit author emails must match this regex, e.g. @my-company.com$.
BranchNameRegex string
All branch names must match this regex, e.g. (feature|hotfix)\/*.
CommitCommitterCheck bool
Only commits pushed using verified emails are allowed.
CommitCommitterNameCheck bool
Users can only push commits to this repository if the commit author name is consistent with their GitLab account name.
CommitMessageNegativeRegex string
No commit message is allowed to match this regex, for example ssh\:\/\/.
CommitMessageRegex string
All commit messages must match this regex, e.g. Fixed \d+\..*.
DenyDeleteTag bool
Deny deleting a tag.
FileNameRegex string
Filenames matching the regular expression provided in this attribute are not allowed, for example, (jar|exe)$.
MaxFileSize int
Maximum file size (MB) allowed.
MemberCheck bool
Allows only GitLab users to author commits.
PreventSecrets bool
GitLab will reject any files that are likely to contain secrets.
RejectNonDcoCommits bool
Reject commit when it’s not DCO certified.
RejectUnsignedCommits bool
Only commits signed through GPG are allowed.
authorEmailRegex String
All commit author emails must match this regex, e.g. @my-company.com$.
branchNameRegex String
All branch names must match this regex, e.g. (feature|hotfix)\/*.
commitCommitterCheck Boolean
Only commits pushed using verified emails are allowed.
commitCommitterNameCheck Boolean
Users can only push commits to this repository if the commit author name is consistent with their GitLab account name.
commitMessageNegativeRegex String
No commit message is allowed to match this regex, for example ssh\:\/\/.
commitMessageRegex String
All commit messages must match this regex, e.g. Fixed \d+\..*.
denyDeleteTag Boolean
Deny deleting a tag.
fileNameRegex String
Filenames matching the regular expression provided in this attribute are not allowed, for example, (jar|exe)$.
maxFileSize Integer
Maximum file size (MB) allowed.
memberCheck Boolean
Allows only GitLab users to author commits.
preventSecrets Boolean
GitLab will reject any files that are likely to contain secrets.
rejectNonDcoCommits Boolean
Reject commit when it’s not DCO certified.
rejectUnsignedCommits Boolean
Only commits signed through GPG are allowed.
authorEmailRegex string
All commit author emails must match this regex, e.g. @my-company.com$.
branchNameRegex string
All branch names must match this regex, e.g. (feature|hotfix)\/*.
commitCommitterCheck boolean
Only commits pushed using verified emails are allowed.
commitCommitterNameCheck boolean
Users can only push commits to this repository if the commit author name is consistent with their GitLab account name.
commitMessageNegativeRegex string
No commit message is allowed to match this regex, for example ssh\:\/\/.
commitMessageRegex string
All commit messages must match this regex, e.g. Fixed \d+\..*.
denyDeleteTag boolean
Deny deleting a tag.
fileNameRegex string
Filenames matching the regular expression provided in this attribute are not allowed, for example, (jar|exe)$.
maxFileSize number
Maximum file size (MB) allowed.
memberCheck boolean
Allows only GitLab users to author commits.
preventSecrets boolean
GitLab will reject any files that are likely to contain secrets.
rejectNonDcoCommits boolean
Reject commit when it’s not DCO certified.
rejectUnsignedCommits boolean
Only commits signed through GPG are allowed.
author_email_regex str
All commit author emails must match this regex, e.g. @my-company.com$.
branch_name_regex str
All branch names must match this regex, e.g. (feature|hotfix)\/*.
commit_committer_check bool
Only commits pushed using verified emails are allowed.
commit_committer_name_check bool
Users can only push commits to this repository if the commit author name is consistent with their GitLab account name.
commit_message_negative_regex str
No commit message is allowed to match this regex, for example ssh\:\/\/.
commit_message_regex str
All commit messages must match this regex, e.g. Fixed \d+\..*.
deny_delete_tag bool
Deny deleting a tag.
file_name_regex str
Filenames matching the regular expression provided in this attribute are not allowed, for example, (jar|exe)$.
max_file_size int
Maximum file size (MB) allowed.
member_check bool
Allows only GitLab users to author commits.
prevent_secrets bool
GitLab will reject any files that are likely to contain secrets.
reject_non_dco_commits bool
Reject commit when it’s not DCO certified.
reject_unsigned_commits bool
Only commits signed through GPG are allowed.
authorEmailRegex String
All commit author emails must match this regex, e.g. @my-company.com$.
branchNameRegex String
All branch names must match this regex, e.g. (feature|hotfix)\/*.
commitCommitterCheck Boolean
Only commits pushed using verified emails are allowed.
commitCommitterNameCheck Boolean
Users can only push commits to this repository if the commit author name is consistent with their GitLab account name.
commitMessageNegativeRegex String
No commit message is allowed to match this regex, for example ssh\:\/\/.
commitMessageRegex String
All commit messages must match this regex, e.g. Fixed \d+\..*.
denyDeleteTag Boolean
Deny deleting a tag.
fileNameRegex String
Filenames matching the regular expression provided in this attribute are not allowed, for example, (jar|exe)$.
maxFileSize Number
Maximum file size (MB) allowed.
memberCheck Boolean
Allows only GitLab users to author commits.
preventSecrets Boolean
GitLab will reject any files that are likely to contain secrets.
rejectNonDcoCommits Boolean
Reject commit when it’s not DCO certified.
rejectUnsignedCommits Boolean
Only commits signed through GPG are allowed.

Import

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

terraform

import {

to = gitlab_group.example

id = “see CLI command below for ID”

}

Import using the CLI is supported using the following syntax:

$ pulumi import gitlab:index/group:Group You can import a group state using `<resource> <id>`. The
Copy

id can be whatever the [details of a group][details_of_a_group] api takes for

its :id value, so for example:

$ pulumi import gitlab:index/group:Group example example
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.
GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-gitlab