Docs Packages
  1. Packages
  2. Snowflake
  3. API Docs
  4. Tag
Snowflake v0.55.0 published on Friday, Jun 7, 2024 by Pulumi
pulumi/pulumi-snowflake

snowflake.Tag

Explore with Pulumi AI

snowflake logo
Snowflake v0.55.0 published on Friday, Jun 7, 2024 by Pulumi
pulumi/pulumi-snowflake

    Example Usage

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

const database = new snowflake.Database("database", {name: "database"});
const schema = new snowflake.Schema("schema", {
    name: "schema",
    database: database.name,
});
const tag = new snowflake.Tag("tag", {
    name: "cost_center",
    database: database.name,
    schema: schema.name,
    allowedValues: [
        "finance",
        "engineering",
    ],
});

    import pulumi
import pulumi_snowflake as snowflake

database = snowflake.Database("database", name="database")
schema = snowflake.Schema("schema",
    name="schema",
    database=database.name)
tag = snowflake.Tag("tag",
    name="cost_center",
    database=database.name,
    schema=schema.name,
    allowed_values=[
        "finance",
        "engineering",
    ])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		database, err := snowflake.NewDatabase(ctx, "database", &snowflake.DatabaseArgs{
			Name: pulumi.String("database"),
		})
		if err != nil {
			return err
		}
		schema, err := snowflake.NewSchema(ctx, "schema", &snowflake.SchemaArgs{
			Name:     pulumi.String("schema"),
			Database: database.Name,
		})
		if err != nil {
			return err
		}
		_, err = snowflake.NewTag(ctx, "tag", &snowflake.TagArgs{
			Name:     pulumi.String("cost_center"),
			Database: database.Name,
			Schema:   schema.Name,
			AllowedValues: pulumi.StringArray{
				pulumi.String("finance"),
				pulumi.String("engineering"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var database = new Snowflake.Database("database", new()
    {
        Name = "database",
    });

    var schema = new Snowflake.Schema("schema", new()
    {
        Name = "schema",
        Database = database.Name,
    });

    var tag = new Snowflake.Tag("tag", new()
    {
        Name = "cost_center",
        Database = database.Name,
        Schema = schema.Name,
        AllowedValues = new[]
        {
            "finance",
            "engineering",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.Database;
import com.pulumi.snowflake.DatabaseArgs;
import com.pulumi.snowflake.Schema;
import com.pulumi.snowflake.SchemaArgs;
import com.pulumi.snowflake.Tag;
import com.pulumi.snowflake.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 database = new Database("database", DatabaseArgs.builder()
            .name("database")
            .build());

        var schema = new Schema("schema", SchemaArgs.builder()
            .name("schema")
            .database(database.name())
            .build());

        var tag = new Tag("tag", TagArgs.builder()
            .name("cost_center")
            .database(database.name())
            .schema(schema.name())
            .allowedValues(            
                "finance",
                "engineering")
            .build());

    }
}

    resources:
  database:
    type: snowflake:Database
    properties:
      name: database
  schema:
    type: snowflake:Schema
    properties:
      name: schema
      database: ${database.name}
  tag:
    type: snowflake:Tag
    properties:
      name: cost_center
      database: ${database.name}
      schema: ${schema.name}
      allowedValues:
        - finance
        - engineering

    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,
        database: Optional[str] = None,
        schema: Optional[str] = None,
        allowed_values: Optional[Sequence[str]] = None,
        comment: Optional[str] = None,
        name: 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: snowflake: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 Snowflake.Tag("tagResource", new()
{
    Database = "string",
    Schema = "string",
    AllowedValues = new[]
    {
        "string",
    },
    Comment = "string",
    Name = "string",
});

    example, err := snowflake.NewTag(ctx, "tagResource", &snowflake.TagArgs{
	Database: pulumi.String("string"),
	Schema:   pulumi.String("string"),
	AllowedValues: pulumi.StringArray{
		pulumi.String("string"),
	},
	Comment: pulumi.String("string"),
	Name:    pulumi.String("string"),
})

    var tagResource = new Tag("tagResource", TagArgs.builder()
    .database("string")
    .schema("string")
    .allowedValues("string")
    .comment("string")
    .name("string")
    .build());

    tag_resource = snowflake.Tag("tagResource",
    database="string",
    schema="string",
    allowed_values=["string"],
    comment="string",
    name="string")

    const tagResource = new snowflake.Tag("tagResource", {
    database: "string",
    schema: "string",
    allowedValues: ["string"],
    comment: "string",
    name: "string",
});

    type: snowflake:Tag
properties:
    allowedValues:
        - string
    comment: string
    database: string
    name: string
    schema: 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

    The Tag resource accepts the following input properties:

    Database string
    The database in which to create the tag.
    Schema string
    The schema in which to create the tag.
    AllowedValues List<string>
    List of allowed values for the tag.
    Comment string
    Specifies a comment for the tag.
    Name string
    Specifies the identifier for the tag; must be unique for the database in which the tag is created.
    Database string
    The database in which to create the tag.
    Schema string
    The schema in which to create the tag.
    AllowedValues []string
    List of allowed values for the tag.
    Comment string
    Specifies a comment for the tag.
    Name string
    Specifies the identifier for the tag; must be unique for the database in which the tag is created.
    database String
    The database in which to create the tag.
    schema String
    The schema in which to create the tag.
    allowedValues List<String>
    List of allowed values for the tag.
    comment String
    Specifies a comment for the tag.
    name String
    Specifies the identifier for the tag; must be unique for the database in which the tag is created.
    database string
    The database in which to create the tag.
    schema string
    The schema in which to create the tag.
    allowedValues string[]
    List of allowed values for the tag.
    comment string
    Specifies a comment for the tag.
    name string
    Specifies the identifier for the tag; must be unique for the database in which the tag is created.
    database str
    The database in which to create the tag.
    schema str
    The schema in which to create the tag.
    allowed_values Sequence[str]
    List of allowed values for the tag.
    comment str
    Specifies a comment for the tag.
    name str
    Specifies the identifier for the tag; must be unique for the database in which the tag is created.
    database String
    The database in which to create the tag.
    schema String
    The schema in which to create the tag.
    allowedValues List<String>
    List of allowed values for the tag.
    comment String
    Specifies a comment for the tag.
    name String
    Specifies the identifier for the tag; must be unique for the database in which the tag is created.

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

    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,
        allowed_values: Optional[Sequence[str]] = None,
        comment: Optional[str] = None,
        database: Optional[str] = None,
        name: Optional[str] = None,
        schema: 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:
    AllowedValues List<string>
    List of allowed values for the tag.
    Comment string
    Specifies a comment for the tag.
    Database string
    The database in which to create the tag.
    Name string
    Specifies the identifier for the tag; must be unique for the database in which the tag is created.
    Schema string
    The schema in which to create the tag.
    AllowedValues []string
    List of allowed values for the tag.
    Comment string
    Specifies a comment for the tag.
    Database string
    The database in which to create the tag.
    Name string
    Specifies the identifier for the tag; must be unique for the database in which the tag is created.
    Schema string
    The schema in which to create the tag.
    allowedValues List<String>
    List of allowed values for the tag.
    comment String
    Specifies a comment for the tag.
    database String
    The database in which to create the tag.
    name String
    Specifies the identifier for the tag; must be unique for the database in which the tag is created.
    schema String
    The schema in which to create the tag.
    allowedValues string[]
    List of allowed values for the tag.
    comment string
    Specifies a comment for the tag.
    database string
    The database in which to create the tag.
    name string
    Specifies the identifier for the tag; must be unique for the database in which the tag is created.
    schema string
    The schema in which to create the tag.
    allowed_values Sequence[str]
    List of allowed values for the tag.
    comment str
    Specifies a comment for the tag.
    database str
    The database in which to create the tag.
    name str
    Specifies the identifier for the tag; must be unique for the database in which the tag is created.
    schema str
    The schema in which to create the tag.
    allowedValues List<String>
    List of allowed values for the tag.
    comment String
    Specifies a comment for the tag.
    database String
    The database in which to create the tag.
    name String
    Specifies the identifier for the tag; must be unique for the database in which the tag is created.
    schema String
    The schema in which to create the tag.

    Import

    format is database name | schema name | tag name

    $ pulumi import snowflake:index/tag:Tag example 'dbName|schemaName|tagName'

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

    Package Details

    Repository
    Snowflake pulumi/pulumi-snowflake
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the snowflake Terraform Provider.
    snowflake logo
    Snowflake v0.55.0 published on Friday, Jun 7, 2024 by Pulumi
    pulumi/pulumi-snowflake