Label

# gitlab_label

This resource allows you to create and manage labels for your GitLab projects. For further information on labels, consult the gitlab documentation.

Example Usage

using Pulumi;
using GitLab = Pulumi.GitLab;

class MyStack : Stack
{
    public MyStack()
    {
        var fixme = new GitLab.Label("fixme", new GitLab.LabelArgs
        {
            Color = "#ffcc00",
            Description = "issue with failing tests",
            Project = "example",
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gitlab.NewLabel(ctx, "fixme", &gitlab.LabelArgs{
			Color:       pulumi.String("#ffcc00"),
			Description: pulumi.String("issue with failing tests"),
			Project:     pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_gitlab as gitlab

fixme = gitlab.Label("fixme",
    color="#ffcc00",
    description="issue with failing tests",
    project="example")
import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

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

Create a Label Resource

new Label(name: string, args: LabelArgs, opts?: CustomResourceOptions);
@overload
def Label(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          color: Optional[str] = None,
          description: Optional[str] = None,
          name: Optional[str] = None,
          project: Optional[str] = None)
@overload
def Label(resource_name: str,
          args: LabelArgs,
          opts: Optional[ResourceOptions] = None)
func NewLabel(ctx *Context, name string, args LabelArgs, opts ...ResourceOption) (*Label, error)
public Label(string name, LabelArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args LabelArgs
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 LabelArgs
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 LabelArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args LabelArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Label Resource Properties

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

Inputs

The Label 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.
Project string
The name or id of the project 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.
Project string
The name or id of the project 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.
project string
The name or id of the project 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.
project str
The name or id of the project to add the label to.
description str
The description of the label.
name str
The name of the label.

Outputs

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

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

Look up an Existing Label Resource

Get an existing Label 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?: LabelState, opts?: CustomResourceOptions): Label
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        color: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None) -> Label
func GetLabel(ctx *Context, name string, id IDInput, state *LabelState, opts ...ResourceOption) (*Label, error)
public static Label Get(string name, Input<string> id, LabelState? state, CustomResourceOptions? opts = null)
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.

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.
Name string
The name of the label.
Project string
The name or id of the project to add the label to.
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.
Name string
The name of the label.
Project string
The name or id of the project to add the label to.
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.
name string
The name of the label.
project string
The name or id of the project to add the label to.
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.
name str
The name of the label.
project str
The name or id of the project to add the label to.

Package Details

Repository
https://github.com/pulumi/pulumi-gitlab
License
Apache-2.0
Notes
This Pulumi package is based on the gitlab Terraform Provider.