1. Registry
  2. Packages
  3. Dokploy
  4. API Docs
  5. Tag
Viewing docs for Dokploy v0.4.4
published on Thursday, Nov 5, 2026 by dimeskigj
dokploy logo Dokploy
Viewing docs for Dokploy v0.4.4
published on Thursday, Nov 5, 2026 by dimeskigj

    A reusable Dokploy project tag.

    Create Tag Resource

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

    Constructor syntax

    new Tag(name: string, args: TagArgs, opts?: CustomResourceOptions);
    @overload
    def Tag(resource_name: str,
            args: TagArgs,
            opts: Optional[ResourceOptions] = None)
    
    @overload
    def Tag(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            name: Optional[str] = None,
            color: Optional[str] = None)
    func NewTag(ctx *Context, name string, args TagArgs, opts ...ResourceOption) (*Tag, error)
    public Tag(string name, TagArgs args, CustomResourceOptions? opts = null)
    public Tag(String name, TagArgs args)
    public Tag(String name, TagArgs args, CustomResourceOptions options)
    
    type: dokploy:Tag
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "dokploy_tag" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args TagArgs
    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 TagArgs
    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 TagArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TagArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TagArgs
    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 tagResource = new Dokploy.Tag("tagResource", new()
    {
        Name = "string",
        Color = "string",
    });
    
    example, err := dokploy.NewTag(ctx, "tagResource", &dokploy.TagArgs{
    	Name:  pulumi.String("string"),
    	Color: pulumi.String("string"),
    })
    
    resource "dokploy_tag" "tagResource" {
      lifecycle {
        create_before_destroy = true
      }
      name  = "string"
      color = "string"
    }
    
    var tagResource = new Tag("tagResource", TagArgs.builder()
        .name("string")
        .color("string")
        .build());
    
    tag_resource = dokploy.Tag("tagResource",
        name="string",
        color="string")
    
    const tagResource = new dokploy.Tag("tagResource", {
        name: "string",
        color: "string",
    });
    
    type: dokploy:Tag
    properties:
        color: string
        name: string
    

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

    Name string
    The tag name.
    Color string
    The optional opaque tag color.
    Name string
    The tag name.
    Color string
    The optional opaque tag color.
    name string
    The tag name.
    color string
    The optional opaque tag color.
    name String
    The tag name.
    color String
    The optional opaque tag color.
    name string
    The tag name.
    color string
    The optional opaque tag color.
    name str
    The tag name.
    color str
    The optional opaque tag color.
    name String
    The tag name.
    color String
    The optional opaque tag color.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    TagId string
    The stable Dokploy tag ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagId string
    The stable Dokploy tag ID.
    id string
    The provider-assigned unique ID for this managed resource.
    tag_id string
    The stable Dokploy tag ID.
    id String
    The provider-assigned unique ID for this managed resource.
    tagId String
    The stable Dokploy tag ID.
    id string
    The provider-assigned unique ID for this managed resource.
    tagId string
    The stable Dokploy tag ID.
    id str
    The provider-assigned unique ID for this managed resource.
    tag_id str
    The stable Dokploy tag ID.
    id String
    The provider-assigned unique ID for this managed resource.
    tagId String
    The stable Dokploy tag ID.

    Look up Existing Tag Resource

    Get an existing Tag 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>, opts?: CustomResourceOptions): Tag
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> Tag
    func GetTag(ctx *Context, name string, id IDInput, state *TagState, opts ...ResourceOption) (*Tag, error)
    public static Tag Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static Tag get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingTag:    type: dokploy:Tag    get:      id: ${id}
    import {
      to = dokploy_tag.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    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 resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state TagState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Package Details

    Repository
    dokploy dimeskigj/pulumi-dokploy
    License
    Apache-2.0
    dokploy logo Dokploy
    Viewing docs for Dokploy v0.4.4
    published on Thursday, Nov 5, 2026 by dimeskigj

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial