1. Packages
  2. Harbor
  3. API Docs
  4. Label
Harbor v3.10.4 published on Sunday, Oct 22, 2023 by Pulumiverse

harbor.Label

Explore with Pulumi AI

harbor logo
Harbor v3.10.4 published on Sunday, Oct 22, 2023 by Pulumiverse

    Example Usage

    • Create a global label within harbor
    	resource "harbor_label" "main" {
    		name  		= "accTest"
    		color 		= "#FF0000"
    		description 	= "Description to for acceptance test"
    	}
    
    • Creates a label for 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

    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_id: Optional[str] = None)
    @overload
    def Label(resource_name: str,
              args: Optional[LabelArgs] = None,
              opts: Optional[ResourceOptions] = 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.
    
    
    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.

    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

    The Label resource accepts the following input properties:

    Color string
    Description string
    Name string
    ProjectId string
    Color string
    Description string
    Name string
    ProjectId string
    color String
    description String
    name String
    projectId String
    color string
    description string
    name string
    projectId string
    color String
    description String
    name String
    projectId String

    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)
    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
    Description string
    Name string
    ProjectId string
    Scope string
    Color string
    Description string
    Name string
    ProjectId string
    Scope string
    color String
    description String
    name String
    projectId String
    scope String
    color string
    description string
    name string
    projectId string
    scope string
    color String
    description String
    name String
    projectId String
    scope String

    Import

    Harbor label can be imported using the label id eg, <break><break>```sh<break> $ pulumi import harbor:index/label:Label main /labels/1 <break>```<break><break>

    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.4 published on Sunday, Oct 22, 2023 by Pulumiverse