Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Harbor
  3. API Docs
  4. Label
Harbor v3.10.19 published on Monday, Feb 10, 2025 by Pulumiverse
pulumiverse/pulumi-harbor

harbor.Label

Explore with Pulumi AI

harbor logo
Harbor v3.10.19 published on Monday, Feb 10, 2025 by Pulumiverse
pulumiverse/pulumi-harbor

    Example Usage

    Global

    resource "harbor_label" "main" {
  name      = "accTest"
  color     = "#FF0000"
  description   = "Description to for acceptance test"
}

    Project

    resource "harbor_project" "main" {
  name = "acctest"
}

resource "harbor_label" "main" {
  name      = "accTest"
  color     = "#FFFFFF"
  description = "Description for acceptance test"
  project_id  = harbor_project.main.id
}

    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: Optional[LabelArgs] = None,
          opts: Optional[ResourceOptions] = None)

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

    type: harbor:Label
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 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.
    name String
    The unique name of the resource.
    args 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 Harbor.Label("labelResource", new()
{
    Color = "string",
    Description = "string",
    Name = "string",
    ProjectId = "string",
});

    example, err := harbor.NewLabel(ctx, "labelResource", &harbor.LabelArgs{
	Color:       pulumi.String("string"),
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	ProjectId:   pulumi.String("string"),
})

    var labelResource = new Label("labelResource", LabelArgs.builder()
    .color("string")
    .description("string")
    .name("string")
    .projectId("string")
    .build());

    label_resource = harbor.Label("labelResource",
    color="string",
    description="string",
    name="string",
    project_id="string")

    const labelResource = new harbor.Label("labelResource", {
    color: "string",
    description: "string",
    name: "string",
    projectId: "string",
});

    type: harbor:Label
properties:
    color: string
    description: string
    name: string
    projectId: string

    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 string
    The color of the label within harbor (Default: #FFFFF)
    Description string
    The Description of the label within harbor
    Name string
    The of name of the label within harbor.
    ProjectId string
    The id of the project with harbor.
    Color string
    The color of the label within harbor (Default: #FFFFF)
    Description string
    The Description of the label within harbor
    Name string
    The of name of the label within harbor.
    ProjectId string
    The id of the project with harbor.
    color String
    The color of the label within harbor (Default: #FFFFF)
    description String
    The Description of the label within harbor
    name String
    The of name of the label within harbor.
    projectId String
    The id of the project with harbor.
    color string
    The color of the label within harbor (Default: #FFFFF)
    description string
    The Description of the label within harbor
    name string
    The of name of the label within harbor.
    projectId string
    The id of the project with harbor.
    color str
    The color of the label within harbor (Default: #FFFFF)
    description str
    The Description of the label within harbor
    name str
    The of name of the label within harbor.
    project_id str
    The id of the project with harbor.
    color String
    The color of the label within harbor (Default: #FFFFF)
    description String
    The Description of the label within harbor
    name String
    The of name of the label within harbor.
    projectId String
    The id of the project with harbor.

    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.
    Scope string
    Id string
    The provider-assigned unique ID for this managed resource.
    Scope string
    id String
    The provider-assigned unique ID for this managed resource.
    scope String
    id string
    The provider-assigned unique ID for this managed resource.
    scope string
    id str
    The provider-assigned unique ID for this managed resource.
    scope str
    id String
    The provider-assigned unique ID for this managed resource.
    scope String

    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,
        name: Optional[str] = None,
        project_id: Optional[str] = None,
        scope: 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: harbor:Label    get:      id: ${id}
    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 within harbor (Default: #FFFFF)
    Description string
    The Description of the label within harbor
    Name string
    The of name of the label within harbor.
    ProjectId string
    The id of the project with harbor.
    Scope string
    Color string
    The color of the label within harbor (Default: #FFFFF)
    Description string
    The Description of the label within harbor
    Name string
    The of name of the label within harbor.
    ProjectId string
    The id of the project with harbor.
    Scope string
    color String
    The color of the label within harbor (Default: #FFFFF)
    description String
    The Description of the label within harbor
    name String
    The of name of the label within harbor.
    projectId String
    The id of the project with harbor.
    scope String
    color string
    The color of the label within harbor (Default: #FFFFF)
    description string
    The Description of the label within harbor
    name string
    The of name of the label within harbor.
    projectId string
    The id of the project with harbor.
    scope string
    color str
    The color of the label within harbor (Default: #FFFFF)
    description str
    The Description of the label within harbor
    name str
    The of name of the label within harbor.
    project_id str
    The id of the project with harbor.
    scope str
    color String
    The color of the label within harbor (Default: #FFFFF)
    description String
    The Description of the label within harbor
    name String
    The of name of the label within harbor.
    projectId String
    The id of the project with harbor.
    scope String

    Import

    $ pulumi import harbor:index/label:Label main /labels/1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    harbor pulumiverse/pulumi-harbor
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harbor Terraform Provider.
    harbor logo
    Harbor v3.10.19 published on Monday, Feb 10, 2025 by Pulumiverse
    pulumiverse/pulumi-harbor