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

gitlab.Label

Explore with Pulumi AI

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

The gitlab.Label resource allows to manage the lifecycle of a project label.

This resource is deprecated. use gitlab.ProjectLabelinstead!

Upstream API: GitLab REST API docs

Create Label Resource

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

Constructor syntax

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

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

type: gitlab:Label
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. LabelArgs
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. 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 This property is required. string
The unique name of the resource.
args This property is required. LabelArgs
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. LabelArgs
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. LabelArgs
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 labelResource = new GitLab.Label("labelResource", new()
{
    Color = "string",
    Project = "string",
    Description = "string",
    Name = "string",
});
Copy
example, err := gitlab.NewLabel(ctx, "labelResource", &gitlab.LabelArgs{
	Color:       pulumi.String("string"),
	Project:     pulumi.String("string"),
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
})
Copy
var labelResource = new Label("labelResource", LabelArgs.builder()
    .color("string")
    .project("string")
    .description("string")
    .name("string")
    .build());
Copy
label_resource = gitlab.Label("labelResource",
    color="string",
    project="string",
    description="string",
    name="string")
Copy
const labelResource = new gitlab.Label("labelResource", {
    color: "string",
    project: "string",
    description: "string",
    name: "string",
});
Copy
type: gitlab:Label
properties:
    color: string
    description: string
    name: string
    project: string
Copy

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

Color This property is required. 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 This property is required. string
The name or id of the project to add the label to.
Description string
The description of the label.
Name Changes to this property will trigger replacement. string
The name of the label.
Color This property is required. 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 This property is required. string
The name or id of the project to add the label to.
Description string
The description of the label.
Name Changes to this property will trigger replacement. string
The name of the label.
color This property is required. 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 This property is required. String
The name or id of the project to add the label to.
description String
The description of the label.
name Changes to this property will trigger replacement. String
The name of the label.
color This property is required. 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 This property is required. string
The name or id of the project to add the label to.
description string
The description of the label.
name Changes to this property will trigger replacement. string
The name of the label.
color This property is required. 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 This property is required. str
The name or id of the project to add the label to.
description str
The description of the label.
name Changes to this property will trigger replacement. str
The name of the label.
color This property is required. 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 This property is required. String
The name or id of the project to add the label to.
description String
The description of the label.
name Changes to this property will trigger replacement. String
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.
LabelId int
The id of the project label.
Id string
The provider-assigned unique ID for this managed resource.
LabelId int
The id of the project label.
id String
The provider-assigned unique ID for this managed resource.
labelId Integer
The id of the project label.
id string
The provider-assigned unique ID for this managed resource.
labelId number
The id of the project label.
id str
The provider-assigned unique ID for this managed resource.
label_id int
The id of the project label.
id String
The provider-assigned unique ID for this managed resource.
labelId Number
The id of the project label.

Look up 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,
        label_id: Optional[int] = 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)
public static Label get(String name, Output<String> id, LabelState state, CustomResourceOptions options)
resources:  _:    type: gitlab:Label    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:
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.
LabelId int
The id of the project label.
Name Changes to this property will trigger replacement. 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.
LabelId int
The id of the project label.
Name Changes to this property will trigger replacement. 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.
labelId Integer
The id of the project label.
name Changes to this property will trigger replacement. 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.
labelId number
The id of the project label.
name Changes to this property will trigger replacement. 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.
label_id int
The id of the project label.
name Changes to this property will trigger replacement. str
The name of the label.
project str
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.
labelId Number
The id of the project label.
name Changes to this property will trigger replacement. String
The name of the label.
project String
The name or id of the project to add the label to.

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