Tag

Tags are used to attach custom metadata to Data Catalog resources. Tags conform to the specifications within their tag template.

See Data Catalog IAM for information on the permissions needed to create or view tags.

To get more information about Tag, see:

API documentation
How-to Guides
- Official Documentation

Create a Tag Resource

new Tag(name: string, args: TagArgs, opts?: CustomResourceOptions);

def Tag(resource_name, opts=None, column=None, fields=None, parent=None, template=None, __props__=None);

func NewTag(ctx *Context, name string, args TagArgs, opts ...ResourceOption) (*Tag, error)

public Tag(string name, TagArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

Tag Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Tag resource accepts the following input properties:

Fields List<TagFieldArgs>: This maps the ID of a tag field to the value of and additional information about that field. Valid field IDs are defined by the tag’s template. A tag must have at least 1 field and at most 500 fields. Structure is documented below.
Template string: The resource name of the tag template that this tag uses. Example: projects/{project_id}/locations/{location}/tagTemplates/{tagTemplateId} This field cannot be modified after creation.
Column string: Resources like Entry can have schemas associated with them. This scope allows users to attach tags to an individual column based on that schema. For attaching a tag to a nested column, use . to separate the column names. Example: outer_column.inner_column
Parent string: The name of the parent this tag is attached to. This can be the name of an entry or an entry group. If an entry group, the tag will be attached to all entries in that group.

Fields []TagField: This maps the ID of a tag field to the value of and additional information about that field. Valid field IDs are defined by the tag’s template. A tag must have at least 1 field and at most 500 fields. Structure is documented below.
Template string: The resource name of the tag template that this tag uses. Example: projects/{project_id}/locations/{location}/tagTemplates/{tagTemplateId} This field cannot be modified after creation.
Column string: Resources like Entry can have schemas associated with them. This scope allows users to attach tags to an individual column based on that schema. For attaching a tag to a nested column, use . to separate the column names. Example: outer_column.inner_column
Parent string: The name of the parent this tag is attached to. This can be the name of an entry or an entry group. If an entry group, the tag will be attached to all entries in that group.

fields TagField[]: This maps the ID of a tag field to the value of and additional information about that field. Valid field IDs are defined by the tag’s template. A tag must have at least 1 field and at most 500 fields. Structure is documented below.
template string: The resource name of the tag template that this tag uses. Example: projects/{project_id}/locations/{location}/tagTemplates/{tagTemplateId} This field cannot be modified after creation.
column string: Resources like Entry can have schemas associated with them. This scope allows users to attach tags to an individual column based on that schema. For attaching a tag to a nested column, use . to separate the column names. Example: outer_column.inner_column
parent string: The name of the parent this tag is attached to. This can be the name of an entry or an entry group. If an entry group, the tag will be attached to all entries in that group.

fields List[TagField]: This maps the ID of a tag field to the value of and additional information about that field. Valid field IDs are defined by the tag’s template. A tag must have at least 1 field and at most 500 fields. Structure is documented below.
template str: The resource name of the tag template that this tag uses. Example: projects/{project_id}/locations/{location}/tagTemplates/{tagTemplateId} This field cannot be modified after creation.
column str: Resources like Entry can have schemas associated with them. This scope allows users to attach tags to an individual column based on that schema. For attaching a tag to a nested column, use . to separate the column names. Example: outer_column.inner_column
parent str: The name of the parent this tag is attached to. This can be the name of an entry or an entry group. If an entry group, the tag will be attached to all entries in that group.

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.
Name string: The resource name of the tag in URL format. Example: projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/entries/{entryId}/tags/{tag_id} or projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/tags/{tag_id} where tag_id is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.
TemplateDisplayname string: The display name of the tag template.

Id string: The provider-assigned unique ID for this managed resource.
Name string: The resource name of the tag in URL format. Example: projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/entries/{entryId}/tags/{tag_id} or projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/tags/{tag_id} where tag_id is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.
TemplateDisplayname string: The display name of the tag template.

id string: The provider-assigned unique ID for this managed resource.
name string: The resource name of the tag in URL format. Example: projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/entries/{entryId}/tags/{tag_id} or projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/tags/{tag_id} where tag_id is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.
templateDisplayname string: The display name of the tag template.

id str: The provider-assigned unique ID for this managed resource.
name str: The resource name of the tag in URL format. Example: projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/entries/{entryId}/tags/{tag_id} or projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/tags/{tag_id} where tag_id is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.
template_displayname str: The display name of the tag template.

Look up an 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

static get(resource_name, id, opts=None, column=None, fields=None, name=None, parent=None, template=None, template_displayname=None, __props__=None);

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)

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.

The following state arguments are supported:

Column string: Resources like Entry can have schemas associated with them. This scope allows users to attach tags to an individual column based on that schema. For attaching a tag to a nested column, use . to separate the column names. Example: outer_column.inner_column
Fields List<TagFieldArgs>: This maps the ID of a tag field to the value of and additional information about that field. Valid field IDs are defined by the tag’s template. A tag must have at least 1 field and at most 500 fields. Structure is documented below.
Name string: The resource name of the tag in URL format. Example: projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/entries/{entryId}/tags/{tag_id} or projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/tags/{tag_id} where tag_id is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.
Parent string: The name of the parent this tag is attached to. This can be the name of an entry or an entry group. If an entry group, the tag will be attached to all entries in that group.
Template string: The resource name of the tag template that this tag uses. Example: projects/{project_id}/locations/{location}/tagTemplates/{tagTemplateId} This field cannot be modified after creation.
TemplateDisplayname string: The display name of the tag template.

Column string: Resources like Entry can have schemas associated with them. This scope allows users to attach tags to an individual column based on that schema. For attaching a tag to a nested column, use . to separate the column names. Example: outer_column.inner_column
Fields []TagField: This maps the ID of a tag field to the value of and additional information about that field. Valid field IDs are defined by the tag’s template. A tag must have at least 1 field and at most 500 fields. Structure is documented below.
Name string: The resource name of the tag in URL format. Example: projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/entries/{entryId}/tags/{tag_id} or projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/tags/{tag_id} where tag_id is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.
Parent string: The name of the parent this tag is attached to. This can be the name of an entry or an entry group. If an entry group, the tag will be attached to all entries in that group.
Template string: The resource name of the tag template that this tag uses. Example: projects/{project_id}/locations/{location}/tagTemplates/{tagTemplateId} This field cannot be modified after creation.
TemplateDisplayname string: The display name of the tag template.

column string: Resources like Entry can have schemas associated with them. This scope allows users to attach tags to an individual column based on that schema. For attaching a tag to a nested column, use . to separate the column names. Example: outer_column.inner_column
fields TagField[]: This maps the ID of a tag field to the value of and additional information about that field. Valid field IDs are defined by the tag’s template. A tag must have at least 1 field and at most 500 fields. Structure is documented below.
name string: The resource name of the tag in URL format. Example: projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/entries/{entryId}/tags/{tag_id} or projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/tags/{tag_id} where tag_id is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.
parent string: The name of the parent this tag is attached to. This can be the name of an entry or an entry group. If an entry group, the tag will be attached to all entries in that group.
template string: The resource name of the tag template that this tag uses. Example: projects/{project_id}/locations/{location}/tagTemplates/{tagTemplateId} This field cannot be modified after creation.
templateDisplayname string: The display name of the tag template.

column str: Resources like Entry can have schemas associated with them. This scope allows users to attach tags to an individual column based on that schema. For attaching a tag to a nested column, use . to separate the column names. Example: outer_column.inner_column
fields List[TagField]: This maps the ID of a tag field to the value of and additional information about that field. Valid field IDs are defined by the tag’s template. A tag must have at least 1 field and at most 500 fields. Structure is documented below.
name str: The resource name of the tag in URL format. Example: projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/entries/{entryId}/tags/{tag_id} or projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/tags/{tag_id} where tag_id is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.
parent str: The name of the parent this tag is attached to. This can be the name of an entry or an entry group. If an entry group, the tag will be attached to all entries in that group.
template str: The resource name of the tag template that this tag uses. Example: projects/{project_id}/locations/{location}/tagTemplates/{tagTemplateId} This field cannot be modified after creation.
template_displayname str: The display name of the tag template.

Supporting Types

TagField

See the input and output API doc for this type.

FieldName string: The identifier for this object. Format specified above.
BoolValue bool: Holds the value for a tag field with boolean type.
DisplayName string: - The display name of this field
DoubleValue double: Holds the value for a tag field with double type.
EnumValue string: Holds the value for a tag field with enum type. This value must be one of the allowed values in the definition of this enum. Structure is documented below.
Order int: - The order of this field with respect to other fields in this tag. For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag do not have to be sequential.
StringValue string: Holds the value for a tag field with string type.
TimestampValue string: Holds the value for a tag field with timestamp type.

FieldName string: The identifier for this object. Format specified above.
BoolValue bool: Holds the value for a tag field with boolean type.
DisplayName string: - The display name of this field
DoubleValue float64: Holds the value for a tag field with double type.
EnumValue string: Holds the value for a tag field with enum type. This value must be one of the allowed values in the definition of this enum. Structure is documented below.
Order int: - The order of this field with respect to other fields in this tag. For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag do not have to be sequential.
StringValue string: Holds the value for a tag field with string type.
TimestampValue string: Holds the value for a tag field with timestamp type.

fieldName string: The identifier for this object. Format specified above.
boolValue boolean: Holds the value for a tag field with boolean type.
displayName string: - The display name of this field
doubleValue number: Holds the value for a tag field with double type.
enumValue string: Holds the value for a tag field with enum type. This value must be one of the allowed values in the definition of this enum. Structure is documented below.
order number: - The order of this field with respect to other fields in this tag. For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag do not have to be sequential.
stringValue string: Holds the value for a tag field with string type.
timestampValue string: Holds the value for a tag field with timestamp type.

fieldName str: The identifier for this object. Format specified above.
boolValue bool: Holds the value for a tag field with boolean type.
display_name str: - The display name of this field
doubleValue float: Holds the value for a tag field with double type.
enumValue str: Holds the value for a tag field with enum type. This value must be one of the allowed values in the definition of this enum. Structure is documented below.
order float: - The order of this field with respect to other fields in this tag. For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag do not have to be sequential.
stringValue str: Holds the value for a tag field with string type.
timestampValue str: Holds the value for a tag field with timestamp type.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Tag