Snowflake v1.1.4, Mar 26 25

Snowflake v1.1.4 published on Wednesday, Mar 26, 2025 by Pulumi

snowflake.Tag

Explore with Pulumi AI

Snowflake v1.1.4 published on Wednesday, Mar 26, 2025 by Pulumi

Import

$ pulumi import snowflake:index/tag:Tag example '"<database_name>"."<schema_name>"."<tag_name>"'

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,
        masking_policies: Optional[Sequence[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",
    MaskingPolicies = new[]
    {
        "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"),
	MaskingPolicies: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})

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

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

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

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

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:

Database string: The database in which to create the tag. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
Schema string: The schema in which to create the tag. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
AllowedValues List<string>: Set of allowed values for the tag.
Comment string: Specifies a comment for the tag.
MaskingPolicies List<string>: Set of masking policies for the tag. A tag can support one masking policy for each data type. If masking policies are assigned to the tag, before dropping the tag, the provider automatically unassigns them. For more information about this resource, see docs.
Name string: Specifies the identifier for the tag; must be unique for the database in which the tag is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".

Database string: The database in which to create the tag. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
Schema string: The schema in which to create the tag. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
AllowedValues []string: Set of allowed values for the tag.
Comment string: Specifies a comment for the tag.
MaskingPolicies []string: Set of masking policies for the tag. A tag can support one masking policy for each data type. If masking policies are assigned to the tag, before dropping the tag, the provider automatically unassigns them. For more information about this resource, see docs.
Name string: Specifies the identifier for the tag; must be unique for the database in which the tag is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".

database String: The database in which to create the tag. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
schema String: The schema in which to create the tag. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
allowedValues List<String>: Set of allowed values for the tag.
comment String: Specifies a comment for the tag.
maskingPolicies List<String>: Set of masking policies for the tag. A tag can support one masking policy for each data type. If masking policies are assigned to the tag, before dropping the tag, the provider automatically unassigns them. For more information about this resource, see docs.
name String: Specifies the identifier for the tag; must be unique for the database in which the tag is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".

database string: The database in which to create the tag. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
schema string: The schema in which to create the tag. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
allowedValues string[]: Set of allowed values for the tag.
comment string: Specifies a comment for the tag.
maskingPolicies string[]: Set of masking policies for the tag. A tag can support one masking policy for each data type. If masking policies are assigned to the tag, before dropping the tag, the provider automatically unassigns them. For more information about this resource, see docs.
name string: Specifies the identifier for the tag; must be unique for the database in which the tag is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".

database str: The database in which to create the tag. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
schema str: The schema in which to create the tag. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
allowed_values Sequence[str]: Set of allowed values for the tag.
comment str: Specifies a comment for the tag.
masking_policies Sequence[str]: Set of masking policies for the tag. A tag can support one masking policy for each data type. If masking policies are assigned to the tag, before dropping the tag, the provider automatically unassigns them. For more information about this resource, see docs.
name str: Specifies the identifier for the tag; must be unique for the database in which the tag is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".

database String: The database in which to create the tag. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
schema String: The schema in which to create the tag. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
allowedValues List<String>: Set of allowed values for the tag.
comment String: Specifies a comment for the tag.
maskingPolicies List<String>: Set of masking policies for the tag. A tag can support one masking policy for each data type. If masking policies are assigned to the tag, before dropping the tag, the provider automatically unassigns them. For more information about this resource, see docs.
name String: Specifies the identifier for the tag; must be unique for the database in which the tag is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".

Outputs

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

FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
Id string: The provider-assigned unique ID for this managed resource.
ShowOutputs List<TagShowOutput>: Outputs the result of SHOW TAGS for the given tag.

FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
Id string: The provider-assigned unique ID for this managed resource.
ShowOutputs []TagShowOutput: Outputs the result of SHOW TAGS for the given tag.

fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
id String: The provider-assigned unique ID for this managed resource.
showOutputs List<TagShowOutput>: Outputs the result of SHOW TAGS for the given tag.

fullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
id string: The provider-assigned unique ID for this managed resource.
showOutputs TagShowOutput[]: Outputs the result of SHOW TAGS for the given tag.

fully_qualified_name str: Fully qualified name of the resource. For more information, see object name resolution.
id str: The provider-assigned unique ID for this managed resource.
show_outputs Sequence[TagShowOutput]: Outputs the result of SHOW TAGS for the given tag.

fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
id String: The provider-assigned unique ID for this managed resource.
showOutputs List<Property Map>: Outputs the result of SHOW TAGS for the given tag.

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,
        fully_qualified_name: Optional[str] = None,
        masking_policies: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        schema: Optional[str] = None,
        show_outputs: Optional[Sequence[TagShowOutputArgs]] = 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)

resources:  _:    type: snowflake: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.

The following state arguments are supported:

AllowedValues List<string>: Set of allowed values for the tag.
Comment string: Specifies a comment for the tag.
Database string: The database in which to create the tag. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
MaskingPolicies List<string>: Set of masking policies for the tag. A tag can support one masking policy for each data type. If masking policies are assigned to the tag, before dropping the tag, the provider automatically unassigns them. For more information about this resource, see docs.
Name string: Specifies the identifier for the tag; must be unique for the database in which the tag is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
Schema string: The schema in which to create the tag. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
ShowOutputs List<TagShowOutput>: Outputs the result of SHOW TAGS for the given tag.

AllowedValues []string: Set of allowed values for the tag.
Comment string: Specifies a comment for the tag.
Database string: The database in which to create the tag. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
MaskingPolicies []string: Set of masking policies for the tag. A tag can support one masking policy for each data type. If masking policies are assigned to the tag, before dropping the tag, the provider automatically unassigns them. For more information about this resource, see docs.
Name string: Specifies the identifier for the tag; must be unique for the database in which the tag is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
Schema string: The schema in which to create the tag. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
ShowOutputs []TagShowOutputArgs: Outputs the result of SHOW TAGS for the given tag.

allowedValues List<String>: Set of allowed values for the tag.
comment String: Specifies a comment for the tag.
database String: The database in which to create the tag. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
maskingPolicies List<String>: Set of masking policies for the tag. A tag can support one masking policy for each data type. If masking policies are assigned to the tag, before dropping the tag, the provider automatically unassigns them. For more information about this resource, see docs.
name String: Specifies the identifier for the tag; must be unique for the database in which the tag is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
schema String: The schema in which to create the tag. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
showOutputs List<TagShowOutput>: Outputs the result of SHOW TAGS for the given tag.

allowedValues string[]: Set of allowed values for the tag.
comment string: Specifies a comment for the tag.
database string: The database in which to create the tag. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
fullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
maskingPolicies string[]: Set of masking policies for the tag. A tag can support one masking policy for each data type. If masking policies are assigned to the tag, before dropping the tag, the provider automatically unassigns them. For more information about this resource, see docs.
name string: Specifies the identifier for the tag; must be unique for the database in which the tag is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
schema string: The schema in which to create the tag. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
showOutputs TagShowOutput[]: Outputs the result of SHOW TAGS for the given tag.

allowed_values Sequence[str]: Set of allowed values for the tag.
comment str: Specifies a comment for the tag.
database str: The database in which to create the tag. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
fully_qualified_name str: Fully qualified name of the resource. For more information, see object name resolution.
masking_policies Sequence[str]: Set of masking policies for the tag. A tag can support one masking policy for each data type. If masking policies are assigned to the tag, before dropping the tag, the provider automatically unassigns them. For more information about this resource, see docs.
name str: Specifies the identifier for the tag; must be unique for the database in which the tag is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
schema str: The schema in which to create the tag. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
show_outputs Sequence[TagShowOutputArgs]: Outputs the result of SHOW TAGS for the given tag.

allowedValues List<String>: Set of allowed values for the tag.
comment String: Specifies a comment for the tag.
database String: The database in which to create the tag. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
maskingPolicies List<String>: Set of masking policies for the tag. A tag can support one masking policy for each data type. If masking policies are assigned to the tag, before dropping the tag, the provider automatically unassigns them. For more information about this resource, see docs.
name String: Specifies the identifier for the tag; must be unique for the database in which the tag is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
schema String: The schema in which to create the tag. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
showOutputs List<Property Map>: Outputs the result of SHOW TAGS for the given tag.