1. Packages
  2. Google Cloud Native
  3. API Docs
  4. datacatalog
  5. datacatalog/v1
  6. TagTemplate

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.datacatalog/v1.TagTemplate

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

    Creates a tag template. You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see [Data Catalog resource project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project).

    Create TagTemplate Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new TagTemplate(name: string, args: TagTemplateArgs, opts?: CustomResourceOptions);
    @overload
    def TagTemplate(resource_name: str,
                    args: TagTemplateArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def TagTemplate(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    fields: Optional[Mapping[str, str]] = None,
                    tag_template_id: Optional[str] = None,
                    display_name: Optional[str] = None,
                    is_publicly_readable: Optional[bool] = None,
                    location: Optional[str] = None,
                    name: Optional[str] = None,
                    project: Optional[str] = None)
    func NewTagTemplate(ctx *Context, name string, args TagTemplateArgs, opts ...ResourceOption) (*TagTemplate, error)
    public TagTemplate(string name, TagTemplateArgs args, CustomResourceOptions? opts = null)
    public TagTemplate(String name, TagTemplateArgs args)
    public TagTemplate(String name, TagTemplateArgs args, CustomResourceOptions options)
    
    type: google-native:datacatalog/v1:TagTemplate
    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 TagTemplateArgs
    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 TagTemplateArgs
    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 TagTemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TagTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TagTemplateArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var tagTemplateResource = new GoogleNative.DataCatalog.V1.TagTemplate("tagTemplateResource", new()
    {
        Fields = 
        {
            { "string", "string" },
        },
        TagTemplateId = "string",
        DisplayName = "string",
        IsPubliclyReadable = false,
        Location = "string",
        Name = "string",
        Project = "string",
    });
    
    example, err := datacatalog.NewTagTemplate(ctx, "tagTemplateResource", &datacatalog.TagTemplateArgs{
    Fields: pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    TagTemplateId: pulumi.String("string"),
    DisplayName: pulumi.String("string"),
    IsPubliclyReadable: pulumi.Bool(false),
    Location: pulumi.String("string"),
    Name: pulumi.String("string"),
    Project: pulumi.String("string"),
    })
    
    var tagTemplateResource = new TagTemplate("tagTemplateResource", TagTemplateArgs.builder()
        .fields(Map.of("string", "string"))
        .tagTemplateId("string")
        .displayName("string")
        .isPubliclyReadable(false)
        .location("string")
        .name("string")
        .project("string")
        .build());
    
    tag_template_resource = google_native.datacatalog.v1.TagTemplate("tagTemplateResource",
        fields={
            "string": "string",
        },
        tag_template_id="string",
        display_name="string",
        is_publicly_readable=False,
        location="string",
        name="string",
        project="string")
    
    const tagTemplateResource = new google_native.datacatalog.v1.TagTemplate("tagTemplateResource", {
        fields: {
            string: "string",
        },
        tagTemplateId: "string",
        displayName: "string",
        isPubliclyReadable: false,
        location: "string",
        name: "string",
        project: "string",
    });
    
    type: google-native:datacatalog/v1:TagTemplate
    properties:
        displayName: string
        fields:
            string: string
        isPubliclyReadable: false
        location: string
        name: string
        project: string
        tagTemplateId: string
    

    TagTemplate 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 TagTemplate resource accepts the following input properties:

    Fields Dictionary<string, string>
    Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. The map must contain at least one field and at most 500 fields. The keys to this map are tag template field IDs. The IDs have the following limitations: * Can contain uppercase and lowercase letters, numbers (0-9) and underscores (_). * Must be at least 1 character and at most 64 characters long. * Must start with a letter or underscore.
    TagTemplateId string
    Required. The ID of the tag template to create. The ID must contain only lowercase letters (a-z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8.
    DisplayName string
    Display name for this template. Defaults to an empty string. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters.
    IsPubliclyReadable bool
    Indicates whether tags created with this template are public. Public tags do not require tag template access to appear in ListTags API response. Additionally, you can search for a public tag by value with a simple search query in addition to using a tag: predicate.
    Location string
    Name string
    The resource name of the tag template in URL format. Note: The tag template itself and its child resources might not be stored in the location specified in its name.
    Project string
    Fields map[string]string
    Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. The map must contain at least one field and at most 500 fields. The keys to this map are tag template field IDs. The IDs have the following limitations: * Can contain uppercase and lowercase letters, numbers (0-9) and underscores (_). * Must be at least 1 character and at most 64 characters long. * Must start with a letter or underscore.
    TagTemplateId string
    Required. The ID of the tag template to create. The ID must contain only lowercase letters (a-z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8.
    DisplayName string
    Display name for this template. Defaults to an empty string. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters.
    IsPubliclyReadable bool
    Indicates whether tags created with this template are public. Public tags do not require tag template access to appear in ListTags API response. Additionally, you can search for a public tag by value with a simple search query in addition to using a tag: predicate.
    Location string
    Name string
    The resource name of the tag template in URL format. Note: The tag template itself and its child resources might not be stored in the location specified in its name.
    Project string
    fields Map<String,String>
    Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. The map must contain at least one field and at most 500 fields. The keys to this map are tag template field IDs. The IDs have the following limitations: * Can contain uppercase and lowercase letters, numbers (0-9) and underscores (_). * Must be at least 1 character and at most 64 characters long. * Must start with a letter or underscore.
    tagTemplateId String
    Required. The ID of the tag template to create. The ID must contain only lowercase letters (a-z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8.
    displayName String
    Display name for this template. Defaults to an empty string. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters.
    isPubliclyReadable Boolean
    Indicates whether tags created with this template are public. Public tags do not require tag template access to appear in ListTags API response. Additionally, you can search for a public tag by value with a simple search query in addition to using a tag: predicate.
    location String
    name String
    The resource name of the tag template in URL format. Note: The tag template itself and its child resources might not be stored in the location specified in its name.
    project String
    fields {[key: string]: string}
    Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. The map must contain at least one field and at most 500 fields. The keys to this map are tag template field IDs. The IDs have the following limitations: * Can contain uppercase and lowercase letters, numbers (0-9) and underscores (_). * Must be at least 1 character and at most 64 characters long. * Must start with a letter or underscore.
    tagTemplateId string
    Required. The ID of the tag template to create. The ID must contain only lowercase letters (a-z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8.
    displayName string
    Display name for this template. Defaults to an empty string. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters.
    isPubliclyReadable boolean
    Indicates whether tags created with this template are public. Public tags do not require tag template access to appear in ListTags API response. Additionally, you can search for a public tag by value with a simple search query in addition to using a tag: predicate.
    location string
    name string
    The resource name of the tag template in URL format. Note: The tag template itself and its child resources might not be stored in the location specified in its name.
    project string
    fields Mapping[str, str]
    Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. The map must contain at least one field and at most 500 fields. The keys to this map are tag template field IDs. The IDs have the following limitations: * Can contain uppercase and lowercase letters, numbers (0-9) and underscores (_). * Must be at least 1 character and at most 64 characters long. * Must start with a letter or underscore.
    tag_template_id str
    Required. The ID of the tag template to create. The ID must contain only lowercase letters (a-z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8.
    display_name str
    Display name for this template. Defaults to an empty string. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters.
    is_publicly_readable bool
    Indicates whether tags created with this template are public. Public tags do not require tag template access to appear in ListTags API response. Additionally, you can search for a public tag by value with a simple search query in addition to using a tag: predicate.
    location str
    name str
    The resource name of the tag template in URL format. Note: The tag template itself and its child resources might not be stored in the location specified in its name.
    project str
    fields Map<String>
    Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. The map must contain at least one field and at most 500 fields. The keys to this map are tag template field IDs. The IDs have the following limitations: * Can contain uppercase and lowercase letters, numbers (0-9) and underscores (_). * Must be at least 1 character and at most 64 characters long. * Must start with a letter or underscore.
    tagTemplateId String
    Required. The ID of the tag template to create. The ID must contain only lowercase letters (a-z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8.
    displayName String
    Display name for this template. Defaults to an empty string. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters.
    isPubliclyReadable Boolean
    Indicates whether tags created with this template are public. Public tags do not require tag template access to appear in ListTags API response. Additionally, you can search for a public tag by value with a simple search query in addition to using a tag: predicate.
    location String
    name String
    The resource name of the tag template in URL format. Note: The tag template itself and its child resources might not be stored in the location specified in its name.
    project String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TagTemplate 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.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi