Tag resource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as scm from "@pulumi/scm";
// This file is embedded using go:embed
// Tags for organizing and categorizing resources
const scmTag1 = new scm.Tag("scm_tag_1", {
folder: "All",
name: "scm_tag_1",
color: "Red",
});
const scmTag2 = new scm.Tag("scm_tag_2", {
folder: "All",
name: "scm_tag_2",
color: "Blue",
});
const scmTag3 = new scm.Tag("scm_tag_3", {
folder: "All",
name: "scm_tag_3",
color: "Orange",
});
import pulumi
import pulumi_scm as scm
# This file is embedded using go:embed
# Tags for organizing and categorizing resources
scm_tag1 = scm.Tag("scm_tag_1",
folder="All",
name="scm_tag_1",
color="Red")
scm_tag2 = scm.Tag("scm_tag_2",
folder="All",
name="scm_tag_2",
color="Blue")
scm_tag3 = scm.Tag("scm_tag_3",
folder="All",
name="scm_tag_3",
color="Orange")
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 {
// This file is embedded using go:embed
// Tags for organizing and categorizing resources
_, err := scm.NewTag(ctx, "scm_tag_1", &scm.TagArgs{
Folder: pulumi.String("All"),
Name: pulumi.String("scm_tag_1"),
Color: pulumi.String("Red"),
})
if err != nil {
return err
}
_, err = scm.NewTag(ctx, "scm_tag_2", &scm.TagArgs{
Folder: pulumi.String("All"),
Name: pulumi.String("scm_tag_2"),
Color: pulumi.String("Blue"),
})
if err != nil {
return err
}
_, err = scm.NewTag(ctx, "scm_tag_3", &scm.TagArgs{
Folder: pulumi.String("All"),
Name: pulumi.String("scm_tag_3"),
Color: pulumi.String("Orange"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scm = Pulumi.Scm;
return await Deployment.RunAsync(() =>
{
// This file is embedded using go:embed
// Tags for organizing and categorizing resources
var scmTag1 = new Scm.Tag("scm_tag_1", new()
{
Folder = "All",
Name = "scm_tag_1",
Color = "Red",
});
var scmTag2 = new Scm.Tag("scm_tag_2", new()
{
Folder = "All",
Name = "scm_tag_2",
Color = "Blue",
});
var scmTag3 = new Scm.Tag("scm_tag_3", new()
{
Folder = "All",
Name = "scm_tag_3",
Color = "Orange",
});
});
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) {
// This file is embedded using go:embed
// Tags for organizing and categorizing resources
var scmTag1 = new Tag("scmTag1", TagArgs.builder()
.folder("All")
.name("scm_tag_1")
.color("Red")
.build());
var scmTag2 = new Tag("scmTag2", TagArgs.builder()
.folder("All")
.name("scm_tag_2")
.color("Blue")
.build());
var scmTag3 = new Tag("scmTag3", TagArgs.builder()
.folder("All")
.name("scm_tag_3")
.color("Orange")
.build());
}
}
resources:
# This file is embedded using go:embed
# Tags for organizing and categorizing resources
scmTag1:
type: scm:Tag
name: scm_tag_1
properties:
folder: All
name: scm_tag_1
color: Red
scmTag2:
type: scm:Tag
name: scm_tag_2
properties:
folder: All
name: scm_tag_2
color: Blue
scmTag3:
type: scm:Tag
name: scm_tag_3
properties:
folder: All
name: scm_tag_3
color: Orange
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)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:
Outputs
All input properties are implicitly available as output properties. Additionally, the Tag resource produces the following output properties:
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) -> Tagfunc 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)resources: _: type: scm:Tag 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.
Package Details
- Repository
- scm pulumi/pulumi-scm
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
scmTerraform Provider.
