com.pulumi.gitlab.kotlin.GroupArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gitlab-kotlin Show documentation
Show all versions of pulumi-gitlab-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
The newest version!
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gitlab.kotlin
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.gitlab.GroupArgs.builder
import com.pulumi.gitlab.kotlin.inputs.GroupDefaultBranchProtectionDefaultsArgs
import com.pulumi.gitlab.kotlin.inputs.GroupDefaultBranchProtectionDefaultsArgsBuilder
import com.pulumi.gitlab.kotlin.inputs.GroupPushRulesArgs
import com.pulumi.gitlab.kotlin.inputs.GroupPushRulesArgsBuilder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Boolean
import kotlin.Deprecated
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName
/**
* 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](https://docs.gitlab.com/ee/api/groups.html)
* ## Example Usage
*
* ```typescript
* 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",
* });
* ```
* ```python
* 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")
* ```
* ```csharp
* 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",
* });
* });
* ```
* ```go
* 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
* })
* }
* ```
* ```java
* 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());
* }
* }
* ```
* ```yaml
* 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
* ```
*
* ## 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:
* ```sh
* $ pulumi import gitlab:index/group:Group You can import a group state using ` `. The
* ```
* `id` can be whatever the [details of a group][details_of_a_group] api takes for
* its `:id` value, so for example:
* ```sh
* $ pulumi import gitlab:index/group:Group example example
* ```
* @property allowedEmailDomainsLists A list of email address domains to allow group access. Will be concatenated together into a comma separated string.
* @property autoDevopsEnabled Default to Auto DevOps pipeline for all projects within this group.
* @property avatar A local path to the avatar image to upload. **Note**: not available for imported resources.
* @property avatarHash 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.
* @property defaultBranch Initial default branch name.
* @property defaultBranchProtection See https://docs.gitlab.com/ee/api/groups.html#options-for-default*branch*protection. Valid values are: `0`, `1`, `2`, `3`, `4`.
* @property defaultBranchProtectionDefaults The default branch protection defaults
* @property description The group's description.
* @property emailsEnabled Enable email notifications.
* @property extraSharedRunnersMinutesLimit Can be set by administrators only. Additional CI/CD minutes for this group.
* @property ipRestrictionRanges 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.
* @property lfsEnabled Enable/disable Large File Storage (LFS) for the projects in this group.
* @property membershipLock Users cannot be added to projects in this group.
* @property mentionsDisabled Disable the capability of a group from getting mentioned.
* @property name The name of the group.
* @property parentId Id of the parent group (creates a nested group).
* @property path The path of the group.
* @property permanentlyRemoveOnDelete 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.
* @property preventForkingOutsideGroup Defaults to false. When enabled, users can not fork projects from this group to external namespaces.
* @property projectCreationLevel Determine if developers can create projects in the group. Valid values are: `noone`, `maintainer`, `developer`
* @property pushRules Push rules for the group.
* @property requestAccessEnabled Allow users to request member access.
* @property requireTwoFactorAuthentication Require all users in this group to setup Two-factor authentication.
* @property shareWithGroupLock Prevent sharing a project with another group within this group.
* @property sharedRunnersMinutesLimit 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.
* @property sharedRunnersSetting 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`.
* @property subgroupCreationLevel Allowed to create subgroups. Valid values are: `owner`, `maintainer`.
* @property twoFactorGracePeriod Defaults to 48. Time before Two-factor authentication is enforced (in hours).
* @property visibilityLevel The group's visibility. Can be `private`, `internal`, or `public`. Valid values are: `private`, `internal`, `public`.
* @property wikiAccessLevel The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are `disabled`, `private`, `enabled`.
*/
public data class GroupArgs(
public val allowedEmailDomainsLists: Output>? = null,
public val autoDevopsEnabled: Output? = null,
public val avatar: Output? = null,
public val avatarHash: Output? = null,
public val defaultBranch: Output? = null,
@Deprecated(
message = """
Deprecated in GitLab 17.0. Use default_branch_protection_defaults instead.
""",
)
public val defaultBranchProtection: Output? = null,
public val defaultBranchProtectionDefaults: Output? =
null,
public val description: Output? = null,
public val emailsEnabled: Output? = null,
public val extraSharedRunnersMinutesLimit: Output? = null,
public val ipRestrictionRanges: Output>? = null,
public val lfsEnabled: Output? = null,
public val membershipLock: Output? = null,
public val mentionsDisabled: Output? = null,
public val name: Output? = null,
public val parentId: Output? = null,
public val path: Output? = null,
public val permanentlyRemoveOnDelete: Output? = null,
public val preventForkingOutsideGroup: Output? = null,
public val projectCreationLevel: Output? = null,
public val pushRules: Output? = null,
public val requestAccessEnabled: Output? = null,
public val requireTwoFactorAuthentication: Output? = null,
public val shareWithGroupLock: Output? = null,
public val sharedRunnersMinutesLimit: Output? = null,
public val sharedRunnersSetting: Output? = null,
public val subgroupCreationLevel: Output? = null,
public val twoFactorGracePeriod: Output? = null,
public val visibilityLevel: Output? = null,
public val wikiAccessLevel: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.gitlab.GroupArgs = com.pulumi.gitlab.GroupArgs.builder()
.allowedEmailDomainsLists(
allowedEmailDomainsLists?.applyValue({ args0 ->
args0.map({ args0 ->
args0
})
}),
)
.autoDevopsEnabled(autoDevopsEnabled?.applyValue({ args0 -> args0 }))
.avatar(avatar?.applyValue({ args0 -> args0 }))
.avatarHash(avatarHash?.applyValue({ args0 -> args0 }))
.defaultBranch(defaultBranch?.applyValue({ args0 -> args0 }))
.defaultBranchProtection(defaultBranchProtection?.applyValue({ args0 -> args0 }))
.defaultBranchProtectionDefaults(
defaultBranchProtectionDefaults?.applyValue({ args0 ->
args0.let({ args0 -> args0.toJava() })
}),
)
.description(description?.applyValue({ args0 -> args0 }))
.emailsEnabled(emailsEnabled?.applyValue({ args0 -> args0 }))
.extraSharedRunnersMinutesLimit(extraSharedRunnersMinutesLimit?.applyValue({ args0 -> args0 }))
.ipRestrictionRanges(ipRestrictionRanges?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.lfsEnabled(lfsEnabled?.applyValue({ args0 -> args0 }))
.membershipLock(membershipLock?.applyValue({ args0 -> args0 }))
.mentionsDisabled(mentionsDisabled?.applyValue({ args0 -> args0 }))
.name(name?.applyValue({ args0 -> args0 }))
.parentId(parentId?.applyValue({ args0 -> args0 }))
.path(path?.applyValue({ args0 -> args0 }))
.permanentlyRemoveOnDelete(permanentlyRemoveOnDelete?.applyValue({ args0 -> args0 }))
.preventForkingOutsideGroup(preventForkingOutsideGroup?.applyValue({ args0 -> args0 }))
.projectCreationLevel(projectCreationLevel?.applyValue({ args0 -> args0 }))
.pushRules(pushRules?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.requestAccessEnabled(requestAccessEnabled?.applyValue({ args0 -> args0 }))
.requireTwoFactorAuthentication(requireTwoFactorAuthentication?.applyValue({ args0 -> args0 }))
.shareWithGroupLock(shareWithGroupLock?.applyValue({ args0 -> args0 }))
.sharedRunnersMinutesLimit(sharedRunnersMinutesLimit?.applyValue({ args0 -> args0 }))
.sharedRunnersSetting(sharedRunnersSetting?.applyValue({ args0 -> args0 }))
.subgroupCreationLevel(subgroupCreationLevel?.applyValue({ args0 -> args0 }))
.twoFactorGracePeriod(twoFactorGracePeriod?.applyValue({ args0 -> args0 }))
.visibilityLevel(visibilityLevel?.applyValue({ args0 -> args0 }))
.wikiAccessLevel(wikiAccessLevel?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [GroupArgs].
*/
@PulumiTagMarker
public class GroupArgsBuilder internal constructor() {
private var allowedEmailDomainsLists: Output>? = null
private var autoDevopsEnabled: Output? = null
private var avatar: Output? = null
private var avatarHash: Output? = null
private var defaultBranch: Output? = null
private var defaultBranchProtection: Output? = null
private var defaultBranchProtectionDefaults: Output? =
null
private var description: Output? = null
private var emailsEnabled: Output? = null
private var extraSharedRunnersMinutesLimit: Output? = null
private var ipRestrictionRanges: Output>? = null
private var lfsEnabled: Output? = null
private var membershipLock: Output? = null
private var mentionsDisabled: Output? = null
private var name: Output? = null
private var parentId: Output? = null
private var path: Output? = null
private var permanentlyRemoveOnDelete: Output? = null
private var preventForkingOutsideGroup: Output? = null
private var projectCreationLevel: Output? = null
private var pushRules: Output? = null
private var requestAccessEnabled: Output? = null
private var requireTwoFactorAuthentication: Output? = null
private var shareWithGroupLock: Output? = null
private var sharedRunnersMinutesLimit: Output? = null
private var sharedRunnersSetting: Output? = null
private var subgroupCreationLevel: Output? = null
private var twoFactorGracePeriod: Output? = null
private var visibilityLevel: Output? = null
private var wikiAccessLevel: Output? = null
/**
* @param value A list of email address domains to allow group access. Will be concatenated together into a comma separated string.
*/
@JvmName("wgtlmllgtgwcpaei")
public suspend fun allowedEmailDomainsLists(`value`: Output>) {
this.allowedEmailDomainsLists = value
}
@JvmName("hkvwaygclqgtlqoe")
public suspend fun allowedEmailDomainsLists(vararg values: Output) {
this.allowedEmailDomainsLists = Output.all(values.asList())
}
/**
* @param values A list of email address domains to allow group access. Will be concatenated together into a comma separated string.
*/
@JvmName("rpsjprfjlwxtmrvi")
public suspend fun allowedEmailDomainsLists(values: List>) {
this.allowedEmailDomainsLists = Output.all(values)
}
/**
* @param value Default to Auto DevOps pipeline for all projects within this group.
*/
@JvmName("edcyrhtseiswhqxb")
public suspend fun autoDevopsEnabled(`value`: Output) {
this.autoDevopsEnabled = value
}
/**
* @param value A local path to the avatar image to upload. **Note**: not available for imported resources.
*/
@JvmName("arteyamnbuiymffj")
public suspend fun avatar(`value`: Output) {
this.avatar = value
}
/**
* @param value 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.
*/
@JvmName("rscsbmsdlkmepxxi")
public suspend fun avatarHash(`value`: Output) {
this.avatarHash = value
}
/**
* @param value Initial default branch name.
*/
@JvmName("uqfrgerrjyjcisae")
public suspend fun defaultBranch(`value`: Output) {
this.defaultBranch = value
}
/**
* @param value See https://docs.gitlab.com/ee/api/groups.html#options-for-default*branch*protection. Valid values are: `0`, `1`, `2`, `3`, `4`.
*/
@Deprecated(
message = """
Deprecated in GitLab 17.0. Use default_branch_protection_defaults instead.
""",
)
@JvmName("lqxdyxdlqawejicw")
public suspend fun defaultBranchProtection(`value`: Output) {
this.defaultBranchProtection = value
}
/**
* @param value The default branch protection defaults
*/
@JvmName("pdgoqtjsgysnugrw")
public suspend fun defaultBranchProtectionDefaults(`value`: Output) {
this.defaultBranchProtectionDefaults = value
}
/**
* @param value The group's description.
*/
@JvmName("ovjrvigdeejseepi")
public suspend fun description(`value`: Output) {
this.description = value
}
/**
* @param value Enable email notifications.
*/
@JvmName("kiuybnwlxkeepmqa")
public suspend fun emailsEnabled(`value`: Output) {
this.emailsEnabled = value
}
/**
* @param value Can be set by administrators only. Additional CI/CD minutes for this group.
*/
@JvmName("yfsftxyyxjkuhjgk")
public suspend fun extraSharedRunnersMinutesLimit(`value`: Output) {
this.extraSharedRunnersMinutesLimit = value
}
/**
* @param value 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.
*/
@JvmName("hxvodhdnpagnodwh")
public suspend fun ipRestrictionRanges(`value`: Output>) {
this.ipRestrictionRanges = value
}
@JvmName("akvchdnwucfyduco")
public suspend fun ipRestrictionRanges(vararg values: Output) {
this.ipRestrictionRanges = Output.all(values.asList())
}
/**
* @param values 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.
*/
@JvmName("vbnbymppysijxcgk")
public suspend fun ipRestrictionRanges(values: List>) {
this.ipRestrictionRanges = Output.all(values)
}
/**
* @param value Enable/disable Large File Storage (LFS) for the projects in this group.
*/
@JvmName("rtickxajbfwdulur")
public suspend fun lfsEnabled(`value`: Output) {
this.lfsEnabled = value
}
/**
* @param value Users cannot be added to projects in this group.
*/
@JvmName("fomqeehcwmefkbsa")
public suspend fun membershipLock(`value`: Output) {
this.membershipLock = value
}
/**
* @param value Disable the capability of a group from getting mentioned.
*/
@JvmName("xuglddlukpsthlko")
public suspend fun mentionsDisabled(`value`: Output) {
this.mentionsDisabled = value
}
/**
* @param value The name of the group.
*/
@JvmName("oeuhtlmltspxxhdu")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value Id of the parent group (creates a nested group).
*/
@JvmName("nuwnqtaiwdciclke")
public suspend fun parentId(`value`: Output) {
this.parentId = value
}
/**
* @param value The path of the group.
*/
@JvmName("wslnclwgfildjiwr")
public suspend fun path(`value`: Output) {
this.path = value
}
/**
* @param value 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.
*/
@JvmName("prvsfrssryfssvxx")
public suspend fun permanentlyRemoveOnDelete(`value`: Output) {
this.permanentlyRemoveOnDelete = value
}
/**
* @param value Defaults to false. When enabled, users can not fork projects from this group to external namespaces.
*/
@JvmName("mhsxqabiopudxpux")
public suspend fun preventForkingOutsideGroup(`value`: Output) {
this.preventForkingOutsideGroup = value
}
/**
* @param value Determine if developers can create projects in the group. Valid values are: `noone`, `maintainer`, `developer`
*/
@JvmName("psytuniysjfoapxc")
public suspend fun projectCreationLevel(`value`: Output) {
this.projectCreationLevel = value
}
/**
* @param value Push rules for the group.
*/
@JvmName("mhpfjgimfpiynwmg")
public suspend fun pushRules(`value`: Output) {
this.pushRules = value
}
/**
* @param value Allow users to request member access.
*/
@JvmName("rhcvffstktyankml")
public suspend fun requestAccessEnabled(`value`: Output) {
this.requestAccessEnabled = value
}
/**
* @param value Require all users in this group to setup Two-factor authentication.
*/
@JvmName("pfobdkmbbbxfrure")
public suspend fun requireTwoFactorAuthentication(`value`: Output) {
this.requireTwoFactorAuthentication = value
}
/**
* @param value Prevent sharing a project with another group within this group.
*/
@JvmName("agyyxamgaeigfvqq")
public suspend fun shareWithGroupLock(`value`: Output) {
this.shareWithGroupLock = value
}
/**
* @param value 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.
*/
@JvmName("vbkackrgspakpmjm")
public suspend fun sharedRunnersMinutesLimit(`value`: Output) {
this.sharedRunnersMinutesLimit = value
}
/**
* @param value 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`.
*/
@JvmName("kcwsvdcmrpuiugjk")
public suspend fun sharedRunnersSetting(`value`: Output) {
this.sharedRunnersSetting = value
}
/**
* @param value Allowed to create subgroups. Valid values are: `owner`, `maintainer`.
*/
@JvmName("tbpihshlpypkfhim")
public suspend fun subgroupCreationLevel(`value`: Output) {
this.subgroupCreationLevel = value
}
/**
* @param value Defaults to 48. Time before Two-factor authentication is enforced (in hours).
*/
@JvmName("wcilqmevgweuicpn")
public suspend fun twoFactorGracePeriod(`value`: Output) {
this.twoFactorGracePeriod = value
}
/**
* @param value The group's visibility. Can be `private`, `internal`, or `public`. Valid values are: `private`, `internal`, `public`.
*/
@JvmName("tvebtlnkrtvlgula")
public suspend fun visibilityLevel(`value`: Output) {
this.visibilityLevel = value
}
/**
* @param value The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are `disabled`, `private`, `enabled`.
*/
@JvmName("woawuqrtuyvfrxlf")
public suspend fun wikiAccessLevel(`value`: Output) {
this.wikiAccessLevel = value
}
/**
* @param value A list of email address domains to allow group access. Will be concatenated together into a comma separated string.
*/
@JvmName("uepjykforkcafbef")
public suspend fun allowedEmailDomainsLists(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.allowedEmailDomainsLists = mapped
}
/**
* @param values A list of email address domains to allow group access. Will be concatenated together into a comma separated string.
*/
@JvmName("dvuhqtedluwauiop")
public suspend fun allowedEmailDomainsLists(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.allowedEmailDomainsLists = mapped
}
/**
* @param value Default to Auto DevOps pipeline for all projects within this group.
*/
@JvmName("qpphkvdiykqhgorr")
public suspend fun autoDevopsEnabled(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.autoDevopsEnabled = mapped
}
/**
* @param value A local path to the avatar image to upload. **Note**: not available for imported resources.
*/
@JvmName("wkxtldsdfogrprng")
public suspend fun avatar(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.avatar = mapped
}
/**
* @param value 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.
*/
@JvmName("mhurduabedwldnxj")
public suspend fun avatarHash(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.avatarHash = mapped
}
/**
* @param value Initial default branch name.
*/
@JvmName("xrfvwbnxmjrdvvdd")
public suspend fun defaultBranch(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.defaultBranch = mapped
}
/**
* @param value See https://docs.gitlab.com/ee/api/groups.html#options-for-default*branch*protection. Valid values are: `0`, `1`, `2`, `3`, `4`.
*/
@Deprecated(
message = """
Deprecated in GitLab 17.0. Use default_branch_protection_defaults instead.
""",
)
@JvmName("dlwvdnutcwnbsnhd")
public suspend fun defaultBranchProtection(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.defaultBranchProtection = mapped
}
/**
* @param value The default branch protection defaults
*/
@JvmName("ykoqesmqpxawjsvs")
public suspend fun defaultBranchProtectionDefaults(`value`: GroupDefaultBranchProtectionDefaultsArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.defaultBranchProtectionDefaults = mapped
}
/**
* @param argument The default branch protection defaults
*/
@JvmName("rdbymnekbicaoykg")
public suspend fun defaultBranchProtectionDefaults(argument: suspend GroupDefaultBranchProtectionDefaultsArgsBuilder.() -> Unit) {
val toBeMapped = GroupDefaultBranchProtectionDefaultsArgsBuilder().applySuspend {
argument()
}.build()
val mapped = of(toBeMapped)
this.defaultBranchProtectionDefaults = mapped
}
/**
* @param value The group's description.
*/
@JvmName("fbhgooxuioqdhwgj")
public suspend fun description(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.description = mapped
}
/**
* @param value Enable email notifications.
*/
@JvmName("oiabjqygdhfvwnuv")
public suspend fun emailsEnabled(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.emailsEnabled = mapped
}
/**
* @param value Can be set by administrators only. Additional CI/CD minutes for this group.
*/
@JvmName("vohjqtmakbrctmvs")
public suspend fun extraSharedRunnersMinutesLimit(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.extraSharedRunnersMinutesLimit = mapped
}
/**
* @param value 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.
*/
@JvmName("vulvojvbcpljxuqa")
public suspend fun ipRestrictionRanges(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.ipRestrictionRanges = mapped
}
/**
* @param values 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.
*/
@JvmName("eektvramyhyleirv")
public suspend fun ipRestrictionRanges(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.ipRestrictionRanges = mapped
}
/**
* @param value Enable/disable Large File Storage (LFS) for the projects in this group.
*/
@JvmName("eudmawsvmlfvqejv")
public suspend fun lfsEnabled(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.lfsEnabled = mapped
}
/**
* @param value Users cannot be added to projects in this group.
*/
@JvmName("fgqdjwcxokhttffe")
public suspend fun membershipLock(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.membershipLock = mapped
}
/**
* @param value Disable the capability of a group from getting mentioned.
*/
@JvmName("tknksnovtidsswvo")
public suspend fun mentionsDisabled(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.mentionsDisabled = mapped
}
/**
* @param value The name of the group.
*/
@JvmName("ypyhuirbqvmvmrve")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value Id of the parent group (creates a nested group).
*/
@JvmName("ljvrjhoonmdfmoqf")
public suspend fun parentId(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.parentId = mapped
}
/**
* @param value The path of the group.
*/
@JvmName("yxfyodahacygolqe")
public suspend fun path(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.path = mapped
}
/**
* @param value 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.
*/
@JvmName("ctctpwcnrwslqjqp")
public suspend fun permanentlyRemoveOnDelete(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.permanentlyRemoveOnDelete = mapped
}
/**
* @param value Defaults to false. When enabled, users can not fork projects from this group to external namespaces.
*/
@JvmName("hssdcwdnyhkibvng")
public suspend fun preventForkingOutsideGroup(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.preventForkingOutsideGroup = mapped
}
/**
* @param value Determine if developers can create projects in the group. Valid values are: `noone`, `maintainer`, `developer`
*/
@JvmName("wtjyrgiwgolwrnko")
public suspend fun projectCreationLevel(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.projectCreationLevel = mapped
}
/**
* @param value Push rules for the group.
*/
@JvmName("gbjrmvjipsiflvte")
public suspend fun pushRules(`value`: GroupPushRulesArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.pushRules = mapped
}
/**
* @param argument Push rules for the group.
*/
@JvmName("rhcrqysvcpncsriv")
public suspend fun pushRules(argument: suspend GroupPushRulesArgsBuilder.() -> Unit) {
val toBeMapped = GroupPushRulesArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.pushRules = mapped
}
/**
* @param value Allow users to request member access.
*/
@JvmName("oirkhubdvrhdnyyt")
public suspend fun requestAccessEnabled(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.requestAccessEnabled = mapped
}
/**
* @param value Require all users in this group to setup Two-factor authentication.
*/
@JvmName("unjnxedwonahojrq")
public suspend fun requireTwoFactorAuthentication(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.requireTwoFactorAuthentication = mapped
}
/**
* @param value Prevent sharing a project with another group within this group.
*/
@JvmName("xxespeuwyxtjccvi")
public suspend fun shareWithGroupLock(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.shareWithGroupLock = mapped
}
/**
* @param value 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.
*/
@JvmName("uyvkfhjtxwatusfm")
public suspend fun sharedRunnersMinutesLimit(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.sharedRunnersMinutesLimit = mapped
}
/**
* @param value 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`.
*/
@JvmName("qlhpchmgmlpsxvqr")
public suspend fun sharedRunnersSetting(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.sharedRunnersSetting = mapped
}
/**
* @param value Allowed to create subgroups. Valid values are: `owner`, `maintainer`.
*/
@JvmName("nhdumbffnuqxeugn")
public suspend fun subgroupCreationLevel(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.subgroupCreationLevel = mapped
}
/**
* @param value Defaults to 48. Time before Two-factor authentication is enforced (in hours).
*/
@JvmName("hugmeampqaclsfpx")
public suspend fun twoFactorGracePeriod(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.twoFactorGracePeriod = mapped
}
/**
* @param value The group's visibility. Can be `private`, `internal`, or `public`. Valid values are: `private`, `internal`, `public`.
*/
@JvmName("sjualpcjtxxfuagi")
public suspend fun visibilityLevel(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.visibilityLevel = mapped
}
/**
* @param value The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are `disabled`, `private`, `enabled`.
*/
@JvmName("vkiqlyeygbccqixo")
public suspend fun wikiAccessLevel(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.wikiAccessLevel = mapped
}
internal fun build(): GroupArgs = GroupArgs(
allowedEmailDomainsLists = allowedEmailDomainsLists,
autoDevopsEnabled = autoDevopsEnabled,
avatar = avatar,
avatarHash = avatarHash,
defaultBranch = defaultBranch,
defaultBranchProtection = defaultBranchProtection,
defaultBranchProtectionDefaults = defaultBranchProtectionDefaults,
description = description,
emailsEnabled = emailsEnabled,
extraSharedRunnersMinutesLimit = extraSharedRunnersMinutesLimit,
ipRestrictionRanges = ipRestrictionRanges,
lfsEnabled = lfsEnabled,
membershipLock = membershipLock,
mentionsDisabled = mentionsDisabled,
name = name,
parentId = parentId,
path = path,
permanentlyRemoveOnDelete = permanentlyRemoveOnDelete,
preventForkingOutsideGroup = preventForkingOutsideGroup,
projectCreationLevel = projectCreationLevel,
pushRules = pushRules,
requestAccessEnabled = requestAccessEnabled,
requireTwoFactorAuthentication = requireTwoFactorAuthentication,
shareWithGroupLock = shareWithGroupLock,
sharedRunnersMinutesLimit = sharedRunnersMinutesLimit,
sharedRunnersSetting = sharedRunnersSetting,
subgroupCreationLevel = subgroupCreationLevel,
twoFactorGracePeriod = twoFactorGracePeriod,
visibilityLevel = visibilityLevel,
wikiAccessLevel = wikiAccessLevel,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy