snowflake.Tag
Explore with Pulumi AI
Import
format is database name | schema name | tag name
$ pulumi import snowflake:index/tag:Tag example 'dbName|schemaName|tagName'
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)
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
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.
- Schema string
- The schema in which to create the tag.
- Allowed
Values 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.
- Allowed
Values []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.
- allowed
Values 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.
- allowed
Values 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.
- allowed
Values 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:
- Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Id string
- The provider-assigned unique ID for this managed resource.
- Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Id string
- The provider-assigned unique ID for this managed resource.
- fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- id String
- The provider-assigned unique ID for this managed resource.
- fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- id string
- The provider-assigned unique ID for this managed resource.
- fully_
qualified_ strname - Fully qualified name of the resource. For more information, see object name resolution.
- id str
- The provider-assigned unique ID for this managed resource.
- fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- 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,
fully_qualified_name: 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.
- Allowed
Values 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.
- Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- 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 []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.
- Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- 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 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.
- fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- 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 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.
- fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- 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.
- fully_
qualified_ strname - Fully qualified name of the resource. For more information, see object name resolution.
- 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.
- allowed
Values 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.
- fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- 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.
Package Details
- Repository
- Snowflake pulumi/pulumi-snowflake
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
snowflake
Terraform Provider.