Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Scm Provider
  3. API Docs
  4. Tag
Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi
pulumi/pulumi-scm

scm.Tag

Explore with Pulumi AI

scm logo
Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi
pulumi/pulumi-scm

    Retrieves a config item.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as scm from "@pulumi/scm";

const example = new scm.Tag("example", {
    folder: "Shared",
    name: "myColor",
    color: "Green",
    comments: "Made by Pulumi",
});

    import pulumi
import pulumi_scm as scm

example = scm.Tag("example",
    folder="Shared",
    name="myColor",
    color="Green",
    comments="Made by Pulumi")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := scm.NewTag(ctx, "example", &scm.TagArgs{
			Folder:   pulumi.String("Shared"),
			Name:     pulumi.String("myColor"),
			Color:    pulumi.String("Green"),
			Comments: pulumi.String("Made by Pulumi"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scm = Pulumi.Scm;

return await Deployment.RunAsync(() => 
{
    var example = new Scm.Tag("example", new()
    {
        Folder = "Shared",
        Name = "myColor",
        Color = "Green",
        Comments = "Made by Pulumi",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.Tag;
import com.pulumi.scm.TagArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Tag("example", TagArgs.builder()
            .folder("Shared")
            .name("myColor")
            .color("Green")
            .comments("Made by Pulumi")
            .build());

    }
}

    resources:
  example:
    type: scm:Tag
    properties:
      folder: Shared
      name: myColor
      color: Green
      comments: Made by Pulumi

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

@overload
def Tag(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        color: Optional[str] = None,
        comments: Optional[str] = None,
        device: Optional[str] = None,
        folder: Optional[str] = None,
        name: Optional[str] = None,
        snippet: Optional[str] = None)
    func NewTag(ctx *Context, name string, args *TagArgs, opts ...ResourceOption) (*Tag, error)
    public Tag(string name, TagArgs? args = null, CustomResourceOptions? opts = null)
    public Tag(String name, TagArgs args)
public Tag(String name, TagArgs args, CustomResourceOptions options)

    type: scm:Tag
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 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 Scm.Tag("tagResource", new()
{
    Color = "string",
    Comments = "string",
    Device = "string",
    Folder = "string",
    Name = "string",
    Snippet = "string",
});

    example, err := scm.NewTag(ctx, "tagResource", &scm.TagArgs{
	Color:    pulumi.String("string"),
	Comments: pulumi.String("string"),
	Device:   pulumi.String("string"),
	Folder:   pulumi.String("string"),
	Name:     pulumi.String("string"),
	Snippet:  pulumi.String("string"),
})

    var tagResource = new Tag("tagResource", TagArgs.builder()
    .color("string")
    .comments("string")
    .device("string")
    .folder("string")
    .name("string")
    .snippet("string")
    .build());

    tag_resource = scm.Tag("tagResource",
    color="string",
    comments="string",
    device="string",
    folder="string",
    name="string",
    snippet="string")

    const tagResource = new scm.Tag("tagResource", {
    color: "string",
    comments: "string",
    device: "string",
    folder: "string",
    name: "string",
    snippet: "string",
});

    type: scm:Tag
properties:
    color: string
    comments: string
    device: string
    folder: string
    name: string
    snippet: 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:

    Color string
    The Color param. String must be one of these: "Red", "Green", "Blue", "Yellow", "Copper", "Orange", "Purple", "Gray", "Light Green", "Cyan", "Light Gray", "Blue Gray", "Lime", "Black", "Gold", "Brown", "Olive", "Maroon", "Red-Orange", "Yellow-Orange", "Forest Green", "Turquoise Blue", "Azure Blue", "Cerulean Blue", "Midnight Blue", "Medium Blue", "Cobalt Blue", "Violet Blue", "Blue Violet", "Medium Violet", "Medium Rose", "Lavender", "Orchid", "Thistle", "Peach", "Salmon", "Magenta", "Red Violet", "Mahogany", "Burnt Sienna", "Chestnut".
    Comments string
    The Comments param. String length must not exceed 1023 characters.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Name string
    The Name param. String length must not exceed 127 characters.
    Snippet string
    The Snippet param.
    Color string
    The Color param. String must be one of these: "Red", "Green", "Blue", "Yellow", "Copper", "Orange", "Purple", "Gray", "Light Green", "Cyan", "Light Gray", "Blue Gray", "Lime", "Black", "Gold", "Brown", "Olive", "Maroon", "Red-Orange", "Yellow-Orange", "Forest Green", "Turquoise Blue", "Azure Blue", "Cerulean Blue", "Midnight Blue", "Medium Blue", "Cobalt Blue", "Violet Blue", "Blue Violet", "Medium Violet", "Medium Rose", "Lavender", "Orchid", "Thistle", "Peach", "Salmon", "Magenta", "Red Violet", "Mahogany", "Burnt Sienna", "Chestnut".
    Comments string
    The Comments param. String length must not exceed 1023 characters.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Name string
    The Name param. String length must not exceed 127 characters.
    Snippet string
    The Snippet param.
    color String
    The Color param. String must be one of these: "Red", "Green", "Blue", "Yellow", "Copper", "Orange", "Purple", "Gray", "Light Green", "Cyan", "Light Gray", "Blue Gray", "Lime", "Black", "Gold", "Brown", "Olive", "Maroon", "Red-Orange", "Yellow-Orange", "Forest Green", "Turquoise Blue", "Azure Blue", "Cerulean Blue", "Midnight Blue", "Medium Blue", "Cobalt Blue", "Violet Blue", "Blue Violet", "Medium Violet", "Medium Rose", "Lavender", "Orchid", "Thistle", "Peach", "Salmon", "Magenta", "Red Violet", "Mahogany", "Burnt Sienna", "Chestnut".
    comments String
    The Comments param. String length must not exceed 1023 characters.
    device String
    The Device param.
    folder String
    The Folder param.
    name String
    The Name param. String length must not exceed 127 characters.
    snippet String
    The Snippet param.
    color string
    The Color param. String must be one of these: "Red", "Green", "Blue", "Yellow", "Copper", "Orange", "Purple", "Gray", "Light Green", "Cyan", "Light Gray", "Blue Gray", "Lime", "Black", "Gold", "Brown", "Olive", "Maroon", "Red-Orange", "Yellow-Orange", "Forest Green", "Turquoise Blue", "Azure Blue", "Cerulean Blue", "Midnight Blue", "Medium Blue", "Cobalt Blue", "Violet Blue", "Blue Violet", "Medium Violet", "Medium Rose", "Lavender", "Orchid", "Thistle", "Peach", "Salmon", "Magenta", "Red Violet", "Mahogany", "Burnt Sienna", "Chestnut".
    comments string
    The Comments param. String length must not exceed 1023 characters.
    device string
    The Device param.
    folder string
    The Folder param.
    name string
    The Name param. String length must not exceed 127 characters.
    snippet string
    The Snippet param.
    color str
    The Color param. String must be one of these: "Red", "Green", "Blue", "Yellow", "Copper", "Orange", "Purple", "Gray", "Light Green", "Cyan", "Light Gray", "Blue Gray", "Lime", "Black", "Gold", "Brown", "Olive", "Maroon", "Red-Orange", "Yellow-Orange", "Forest Green", "Turquoise Blue", "Azure Blue", "Cerulean Blue", "Midnight Blue", "Medium Blue", "Cobalt Blue", "Violet Blue", "Blue Violet", "Medium Violet", "Medium Rose", "Lavender", "Orchid", "Thistle", "Peach", "Salmon", "Magenta", "Red Violet", "Mahogany", "Burnt Sienna", "Chestnut".
    comments str
    The Comments param. String length must not exceed 1023 characters.
    device str
    The Device param.
    folder str
    The Folder param.
    name str
    The Name param. String length must not exceed 127 characters.
    snippet str
    The Snippet param.
    color String
    The Color param. String must be one of these: "Red", "Green", "Blue", "Yellow", "Copper", "Orange", "Purple", "Gray", "Light Green", "Cyan", "Light Gray", "Blue Gray", "Lime", "Black", "Gold", "Brown", "Olive", "Maroon", "Red-Orange", "Yellow-Orange", "Forest Green", "Turquoise Blue", "Azure Blue", "Cerulean Blue", "Midnight Blue", "Medium Blue", "Cobalt Blue", "Violet Blue", "Blue Violet", "Medium Violet", "Medium Rose", "Lavender", "Orchid", "Thistle", "Peach", "Salmon", "Magenta", "Red Violet", "Mahogany", "Burnt Sienna", "Chestnut".
    comments String
    The Comments param. String length must not exceed 1023 characters.
    device String
    The Device param.
    folder String
    The Folder param.
    name String
    The Name param. String length must not exceed 127 characters.
    snippet String
    The Snippet param.

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

    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>, state?: TagState, opts?: CustomResourceOptions): Tag
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        color: Optional[str] = None,
        comments: Optional[str] = None,
        device: Optional[str] = None,
        folder: Optional[str] = None,
        name: Optional[str] = None,
        snippet: Optional[str] = None,
        tfid: Optional[str] = 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, TagState? state, CustomResourceOptions? opts = null)
    public static Tag get(String name, Output<String> id, TagState 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
    The Color param. String must be one of these: "Red", "Green", "Blue", "Yellow", "Copper", "Orange", "Purple", "Gray", "Light Green", "Cyan", "Light Gray", "Blue Gray", "Lime", "Black", "Gold", "Brown", "Olive", "Maroon", "Red-Orange", "Yellow-Orange", "Forest Green", "Turquoise Blue", "Azure Blue", "Cerulean Blue", "Midnight Blue", "Medium Blue", "Cobalt Blue", "Violet Blue", "Blue Violet", "Medium Violet", "Medium Rose", "Lavender", "Orchid", "Thistle", "Peach", "Salmon", "Magenta", "Red Violet", "Mahogany", "Burnt Sienna", "Chestnut".
    Comments string
    The Comments param. String length must not exceed 1023 characters.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Name string
    The Name param. String length must not exceed 127 characters.
    Snippet string
    The Snippet param.
    Tfid string
    Color string
    The Color param. String must be one of these: "Red", "Green", "Blue", "Yellow", "Copper", "Orange", "Purple", "Gray", "Light Green", "Cyan", "Light Gray", "Blue Gray", "Lime", "Black", "Gold", "Brown", "Olive", "Maroon", "Red-Orange", "Yellow-Orange", "Forest Green", "Turquoise Blue", "Azure Blue", "Cerulean Blue", "Midnight Blue", "Medium Blue", "Cobalt Blue", "Violet Blue", "Blue Violet", "Medium Violet", "Medium Rose", "Lavender", "Orchid", "Thistle", "Peach", "Salmon", "Magenta", "Red Violet", "Mahogany", "Burnt Sienna", "Chestnut".
    Comments string
    The Comments param. String length must not exceed 1023 characters.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Name string
    The Name param. String length must not exceed 127 characters.
    Snippet string
    The Snippet param.
    Tfid string
    color String
    The Color param. String must be one of these: "Red", "Green", "Blue", "Yellow", "Copper", "Orange", "Purple", "Gray", "Light Green", "Cyan", "Light Gray", "Blue Gray", "Lime", "Black", "Gold", "Brown", "Olive", "Maroon", "Red-Orange", "Yellow-Orange", "Forest Green", "Turquoise Blue", "Azure Blue", "Cerulean Blue", "Midnight Blue", "Medium Blue", "Cobalt Blue", "Violet Blue", "Blue Violet", "Medium Violet", "Medium Rose", "Lavender", "Orchid", "Thistle", "Peach", "Salmon", "Magenta", "Red Violet", "Mahogany", "Burnt Sienna", "Chestnut".
    comments String
    The Comments param. String length must not exceed 1023 characters.
    device String
    The Device param.
    folder String
    The Folder param.
    name String
    The Name param. String length must not exceed 127 characters.
    snippet String
    The Snippet param.
    tfid String
    color string
    The Color param. String must be one of these: "Red", "Green", "Blue", "Yellow", "Copper", "Orange", "Purple", "Gray", "Light Green", "Cyan", "Light Gray", "Blue Gray", "Lime", "Black", "Gold", "Brown", "Olive", "Maroon", "Red-Orange", "Yellow-Orange", "Forest Green", "Turquoise Blue", "Azure Blue", "Cerulean Blue", "Midnight Blue", "Medium Blue", "Cobalt Blue", "Violet Blue", "Blue Violet", "Medium Violet", "Medium Rose", "Lavender", "Orchid", "Thistle", "Peach", "Salmon", "Magenta", "Red Violet", "Mahogany", "Burnt Sienna", "Chestnut".
    comments string
    The Comments param. String length must not exceed 1023 characters.
    device string
    The Device param.
    folder string
    The Folder param.
    name string
    The Name param. String length must not exceed 127 characters.
    snippet string
    The Snippet param.
    tfid string
    color str
    The Color param. String must be one of these: "Red", "Green", "Blue", "Yellow", "Copper", "Orange", "Purple", "Gray", "Light Green", "Cyan", "Light Gray", "Blue Gray", "Lime", "Black", "Gold", "Brown", "Olive", "Maroon", "Red-Orange", "Yellow-Orange", "Forest Green", "Turquoise Blue", "Azure Blue", "Cerulean Blue", "Midnight Blue", "Medium Blue", "Cobalt Blue", "Violet Blue", "Blue Violet", "Medium Violet", "Medium Rose", "Lavender", "Orchid", "Thistle", "Peach", "Salmon", "Magenta", "Red Violet", "Mahogany", "Burnt Sienna", "Chestnut".
    comments str
    The Comments param. String length must not exceed 1023 characters.
    device str
    The Device param.
    folder str
    The Folder param.
    name str
    The Name param. String length must not exceed 127 characters.
    snippet str
    The Snippet param.
    tfid str
    color String
    The Color param. String must be one of these: "Red", "Green", "Blue", "Yellow", "Copper", "Orange", "Purple", "Gray", "Light Green", "Cyan", "Light Gray", "Blue Gray", "Lime", "Black", "Gold", "Brown", "Olive", "Maroon", "Red-Orange", "Yellow-Orange", "Forest Green", "Turquoise Blue", "Azure Blue", "Cerulean Blue", "Midnight Blue", "Medium Blue", "Cobalt Blue", "Violet Blue", "Blue Violet", "Medium Violet", "Medium Rose", "Lavender", "Orchid", "Thistle", "Peach", "Salmon", "Magenta", "Red Violet", "Mahogany", "Burnt Sienna", "Chestnut".
    comments String
    The Comments param. String length must not exceed 1023 characters.
    device String
    The Device param.
    folder String
    The Folder param.
    name String
    The Name param. String length must not exceed 127 characters.
    snippet String
    The Snippet param.
    tfid String

    Package Details

    Repository
    scm pulumi/pulumi-scm
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scm Terraform Provider.
    scm logo
    Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi
    pulumi/pulumi-scm