All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.gitlab.kotlin.Group.kt Maven / Gradle / Ivy

Go to download

Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.

There is a newer version: 8.4.2.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.gitlab.kotlin

import com.pulumi.core.Output
import com.pulumi.gitlab.kotlin.outputs.GroupPushRules
import com.pulumi.gitlab.kotlin.outputs.GroupPushRules.Companion.toKotlin
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List

/**
 * Builder for [Group].
 */
@PulumiTagMarker
public class GroupResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: GroupArgs = GroupArgs()

    public var opts: CustomResourceOptions = CustomResourceOptions()

    /**
     * @param name The _unique_ name of the resulting resource.
     */
    public fun name(`value`: String) {
        this.name = value
    }

    /**
     * @param block The arguments to use to populate this resource's properties.
     */
    public suspend fun args(block: suspend GroupArgsBuilder.() -> Unit) {
        val builder = GroupArgsBuilder()
        block(builder)
        this.args = builder.build()
    }

    /**
     * @param block A bag of options that control this resource's behavior.
     */
    public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
        this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
    }

    internal fun build(): Group {
        val builtJavaResource = com.pulumi.gitlab.Group(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return Group(builtJavaResource)
    }
}

/**
 * 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,
 *     },
 * });
 * ```
 * ```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=gitlab.GroupPushRulesArgs(
 *         author_email_regex="@example\\.com$",
 *         commit_committer_check=True,
 *         member_check=True,
 *         prevent_secrets=True,
 *     ))
 * ```
 * ```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,
 *         },
 *     });
 * });
 * ```
 * ```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
 * 		}
 * 		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 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());
 *     }
 * }
 * ```
 * ```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
 * ```
 * 
 * ## Import
 * ```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
 * ```
 */
public class Group internal constructor(
    override val javaResource: com.pulumi.gitlab.Group,
) : KotlinCustomResource(javaResource, GroupMapper) {
    /**
     * Default to Auto DevOps pipeline for all projects within this group.
     */
    public val autoDevopsEnabled: Output
        get() = javaResource.autoDevopsEnabled().applyValue({ args0 -> args0 })

    /**
     * A local path to the avatar image to upload. **Note**: not available for imported resources.
     */
    public val avatar: Output?
        get() = javaResource.avatar().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * 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.
     */
    public val avatarHash: Output
        get() = javaResource.avatarHash().applyValue({ args0 -> args0 })

    /**
     * The URL of the avatar image.
     */
    public val avatarUrl: Output
        get() = javaResource.avatarUrl().applyValue({ args0 -> args0 })

    /**
     * See https://docs.gitlab.com/ee/api/groups.html#options-for-default*branch*protection. Valid values are: `0`, `1`, `2`, `3`, `4`.
     */
    public val defaultBranchProtection: Output
        get() = javaResource.defaultBranchProtection().applyValue({ args0 -> args0 })

    /**
     * The group's description.
     */
    public val description: Output?
        get() = javaResource.description().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * Enable email notifications.
     */
    public val emailsEnabled: Output
        get() = javaResource.emailsEnabled().applyValue({ args0 -> args0 })

    /**
     * Can be set by administrators only. Additional CI/CD minutes for this group.
     */
    public val extraSharedRunnersMinutesLimit: Output
        get() = javaResource.extraSharedRunnersMinutesLimit().applyValue({ args0 -> args0 })

    /**
     * The full name of the group.
     */
    public val fullName: Output
        get() = javaResource.fullName().applyValue({ args0 -> args0 })

    /**
     * The full path of the group.
     */
    public val fullPath: Output
        get() = javaResource.fullPath().applyValue({ args0 -> args0 })

    /**
     * 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.
     */
    public val ipRestrictionRanges: Output>?
        get() = javaResource.ipRestrictionRanges().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 -> args0 })
            }).orElse(null)
        })

    /**
     * Enable/disable Large File Storage (LFS) for the projects in this group.
     */
    public val lfsEnabled: Output
        get() = javaResource.lfsEnabled().applyValue({ args0 -> args0 })

    /**
     * Users cannot be added to projects in this group.
     */
    public val membershipLock: Output?
        get() = javaResource.membershipLock().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * Disable the capability of a group from getting mentioned.
     */
    public val mentionsDisabled: Output
        get() = javaResource.mentionsDisabled().applyValue({ args0 -> args0 })

    /**
     * The name of the group.
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * Id of the parent group (creates a nested group).
     */
    public val parentId: Output
        get() = javaResource.parentId().applyValue({ args0 -> args0 })

    /**
     * The path of the group.
     */
    public val path: Output
        get() = javaResource.path().applyValue({ args0 -> args0 })

    /**
     * Defaults to false. When enabled, users can not fork projects from this group to external namespaces.
     */
    public val preventForkingOutsideGroup: Output
        get() = javaResource.preventForkingOutsideGroup().applyValue({ args0 -> args0 })

    /**
     * Determine if developers can create projects in the group. Valid values are: `noone`, `maintainer`, `developer`
     */
    public val projectCreationLevel: Output
        get() = javaResource.projectCreationLevel().applyValue({ args0 -> args0 })

    /**
     * Push rules for the group.
     */
    public val pushRules: Output
        get() = javaResource.pushRules().applyValue({ args0 -> args0.let({ args0 -> toKotlin(args0) }) })

    /**
     * Allow users to request member access.
     */
    public val requestAccessEnabled: Output
        get() = javaResource.requestAccessEnabled().applyValue({ args0 -> args0 })

    /**
     * Require all users in this group to setup Two-factor authentication.
     */
    public val requireTwoFactorAuthentication: Output
        get() = javaResource.requireTwoFactorAuthentication().applyValue({ args0 -> args0 })

    /**
     * The group level registration token to use during runner setup.
     */
    public val runnersToken: Output
        get() = javaResource.runnersToken().applyValue({ args0 -> args0 })

    /**
     * Prevent sharing a project with another group within this group.
     */
    public val shareWithGroupLock: Output
        get() = javaResource.shareWithGroupLock().applyValue({ args0 -> args0 })

    /**
     * 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.
     */
    public val sharedRunnersMinutesLimit: Output
        get() = javaResource.sharedRunnersMinutesLimit().applyValue({ args0 -> args0 })

    /**
     * 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`.
     */
    public val sharedRunnersSetting: Output
        get() = javaResource.sharedRunnersSetting().applyValue({ args0 -> args0 })

    /**
     * Allowed to create subgroups. Valid values are: `owner`, `maintainer`.
     */
    public val subgroupCreationLevel: Output
        get() = javaResource.subgroupCreationLevel().applyValue({ args0 -> args0 })

    /**
     * Defaults to 48. Time before Two-factor authentication is enforced (in hours).
     */
    public val twoFactorGracePeriod: Output
        get() = javaResource.twoFactorGracePeriod().applyValue({ args0 -> args0 })

    /**
     * The group's visibility. Can be `private`, `internal`, or `public`. Valid values are: `private`, `internal`, `public`.
     */
    public val visibilityLevel: Output
        get() = javaResource.visibilityLevel().applyValue({ args0 -> args0 })

    /**
     * Web URL of the group.
     */
    public val webUrl: Output
        get() = javaResource.webUrl().applyValue({ args0 -> args0 })

    /**
     * The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are `disabled`, `private`, `enabled`.
     */
    public val wikiAccessLevel: Output
        get() = javaResource.wikiAccessLevel().applyValue({ args0 -> args0 })
}

public object GroupMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.gitlab.Group::class == javaResource::class

    override fun map(javaResource: Resource): Group = Group(javaResource as com.pulumi.gitlab.Group)
}

/**
 * @see [Group].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [Group].
 */
public suspend fun group(name: String, block: suspend GroupResourceBuilder.() -> Unit): Group {
    val builder = GroupResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [Group].
 * @param name The _unique_ name of the resulting resource.
 */
public fun group(name: String): Group {
    val builder = GroupResourceBuilder()
    builder.name(name)
    return builder.build()
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy