Docs Packages
  1. Packages
  2. GitLab
  3. API Docs
  4. GroupLabel
GitLab v8.1.0 published on Friday, Jun 21, 2024 by Pulumi
pulumi/pulumi-gitlab

gitlab.GroupLabel

Explore with Pulumi AI

gitlab logo
GitLab v8.1.0 published on Friday, Jun 21, 2024 by Pulumi
pulumi/pulumi-gitlab

    The gitlab.GroupLabel resource allows to manage the lifecycle of labels within a group.

    Upstream API: GitLab REST API docs

    Example Usage

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

const fixme = new gitlab.GroupLabel("fixme", {
    group: "example",
    name: "fixme",
    description: "issue with failing tests",
    color: "#ffcc00",
});

    import pulumi
import pulumi_gitlab as gitlab

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

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gitlab.NewGroupLabel(ctx, "fixme", &gitlab.GroupLabelArgs{
			Group:       pulumi.String("example"),
			Name:        pulumi.String("fixme"),
			Description: pulumi.String("issue with failing tests"),
			Color:       pulumi.String("#ffcc00"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;

return await Deployment.RunAsync(() => 
{
    var fixme = new GitLab.GroupLabel("fixme", new()
    {
        Group = "example",
        Name = "fixme",
        Description = "issue with failing tests",
        Color = "#ffcc00",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.GroupLabel;
import com.pulumi.gitlab.GroupLabelArgs;
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 fixme = new GroupLabel("fixme", GroupLabelArgs.builder()
            .group("example")
            .name("fixme")
            .description("issue with failing tests")
            .color("#ffcc00")
            .build());

    }
}

    resources:
  fixme:
    type: gitlab:GroupLabel
    properties:
      group: example
      name: fixme
      description: issue with failing tests
      color: '#ffcc00'

    Create GroupLabel Resource

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

    Constructor syntax

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

@overload
def GroupLabel(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               color: Optional[str] = None,
               group: Optional[str] = None,
               description: Optional[str] = None,
               name: Optional[str] = None)
    func NewGroupLabel(ctx *Context, name string, args GroupLabelArgs, opts ...ResourceOption) (*GroupLabel, error)
    public GroupLabel(string name, GroupLabelArgs args, CustomResourceOptions? opts = null)
    public GroupLabel(String name, GroupLabelArgs args)
public GroupLabel(String name, GroupLabelArgs args, CustomResourceOptions options)

    type: gitlab:GroupLabel
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args GroupLabelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GroupLabelArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GroupLabelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GroupLabelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GroupLabelArgs
    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 groupLabelResource = new GitLab.GroupLabel("groupLabelResource", new()
{
    Color = "string",
    Group = "string",
    Description = "string",
    Name = "string",
});

    example, err := gitlab.NewGroupLabel(ctx, "groupLabelResource", &gitlab.GroupLabelArgs{
	Color:       pulumi.String("string"),
	Group:       pulumi.String("string"),
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
})

    var groupLabelResource = new GroupLabel("groupLabelResource", GroupLabelArgs.builder()
    .color("string")
    .group("string")
    .description("string")
    .name("string")
    .build());

    group_label_resource = gitlab.GroupLabel("groupLabelResource",
    color="string",
    group="string",
    description="string",
    name="string")

    const groupLabelResource = new gitlab.GroupLabel("groupLabelResource", {
    color: "string",
    group: "string",
    description: "string",
    name: "string",
});

    type: gitlab:GroupLabel
properties:
    color: string
    description: string
    group: string
    name: string

    GroupLabel Resource Properties

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

    Inputs

    The GroupLabel resource accepts the following input properties:

    Color string
    The color of the label given in 6-digit hex notation with leading '#' sign (e.g. #FFAABB) or one of the CSS color names.
    Group string
    The name or id of the group to add the label to.
    Description string
    The description of the label.
    Name string
    The name of the label.
    Color string
    The color of the label given in 6-digit hex notation with leading '#' sign (e.g. #FFAABB) or one of the CSS color names.
    Group string
    The name or id of the group to add the label to.
    Description string
    The description of the label.
    Name string
    The name of the label.
    color String
    The color of the label given in 6-digit hex notation with leading '#' sign (e.g. #FFAABB) or one of the CSS color names.
    group String
    The name or id of the group to add the label to.
    description String
    The description of the label.
    name String
    The name of the label.
    color string
    The color of the label given in 6-digit hex notation with leading '#' sign (e.g. #FFAABB) or one of the CSS color names.
    group string
    The name or id of the group to add the label to.
    description string
    The description of the label.
    name string
    The name of the label.
    color str
    The color of the label given in 6-digit hex notation with leading '#' sign (e.g. #FFAABB) or one of the CSS color names.
    group str
    The name or id of the group to add the label to.
    description str
    The description of the label.
    name str
    The name of the label.
    color String
    The color of the label given in 6-digit hex notation with leading '#' sign (e.g. #FFAABB) or one of the CSS color names.
    group String
    The name or id of the group to add the label to.
    description String
    The description of the label.
    name String
    The name of the label.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    LabelId int
    The id of the group label.
    Id string
    The provider-assigned unique ID for this managed resource.
    LabelId int
    The id of the group label.
    id String
    The provider-assigned unique ID for this managed resource.
    labelId Integer
    The id of the group label.
    id string
    The provider-assigned unique ID for this managed resource.
    labelId number
    The id of the group label.
    id str
    The provider-assigned unique ID for this managed resource.
    label_id int
    The id of the group label.
    id String
    The provider-assigned unique ID for this managed resource.
    labelId Number
    The id of the group label.

    Look up Existing GroupLabel Resource

    Get an existing GroupLabel 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?: GroupLabelState, opts?: CustomResourceOptions): GroupLabel
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        color: Optional[str] = None,
        description: Optional[str] = None,
        group: Optional[str] = None,
        label_id: Optional[int] = None,
        name: Optional[str] = None) -> GroupLabel
    func GetGroupLabel(ctx *Context, name string, id IDInput, state *GroupLabelState, opts ...ResourceOption) (*GroupLabel, error)
    public static GroupLabel Get(string name, Input<string> id, GroupLabelState? state, CustomResourceOptions? opts = null)
    public static GroupLabel get(String name, Output<String> id, GroupLabelState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    Color string
    The color of the label given in 6-digit hex notation with leading '#' sign (e.g. #FFAABB) or one of the CSS color names.
    Description string
    The description of the label.
    Group string
    The name or id of the group to add the label to.
    LabelId int
    The id of the group label.
    Name string
    The name of the label.
    Color string
    The color of the label given in 6-digit hex notation with leading '#' sign (e.g. #FFAABB) or one of the CSS color names.
    Description string
    The description of the label.
    Group string
    The name or id of the group to add the label to.
    LabelId int
    The id of the group label.
    Name string
    The name of the label.
    color String
    The color of the label given in 6-digit hex notation with leading '#' sign (e.g. #FFAABB) or one of the CSS color names.
    description String
    The description of the label.
    group String
    The name or id of the group to add the label to.
    labelId Integer
    The id of the group label.
    name String
    The name of the label.
    color string
    The color of the label given in 6-digit hex notation with leading '#' sign (e.g. #FFAABB) or one of the CSS color names.
    description string
    The description of the label.
    group string
    The name or id of the group to add the label to.
    labelId number
    The id of the group label.
    name string
    The name of the label.
    color str
    The color of the label given in 6-digit hex notation with leading '#' sign (e.g. #FFAABB) or one of the CSS color names.
    description str
    The description of the label.
    group str
    The name or id of the group to add the label to.
    label_id int
    The id of the group label.
    name str
    The name of the label.
    color String
    The color of the label given in 6-digit hex notation with leading '#' sign (e.g. #FFAABB) or one of the CSS color names.
    description String
    The description of the label.
    group String
    The name or id of the group to add the label to.
    labelId Number
    The id of the group label.
    name String
    The name of the label.

    Import

    Gitlab group labels can be imported using an id made up of {group_id}:{group_label_id}, e.g.

    $ pulumi import gitlab:index/groupLabel:GroupLabel example 12345:fixme

    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 logo
    GitLab v8.1.0 published on Friday, Jun 21, 2024 by Pulumi
    pulumi/pulumi-gitlab