1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. datacatalog
  5. PolicyTag
Google Cloud Classic v7.29.0 published on Wednesday, Jun 26, 2024 by Pulumi

gcp.datacatalog.PolicyTag

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.29.0 published on Wednesday, Jun 26, 2024 by Pulumi

    Denotes one policy tag in a taxonomy.

    To get more information about PolicyTag, see:

    Example Usage

    Data Catalog Taxonomies Policy Tag Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const myTaxonomy = new gcp.datacatalog.Taxonomy("my_taxonomy", {
        displayName: "taxonomy_display_name",
        description: "A collection of policy tags",
        activatedPolicyTypes: ["FINE_GRAINED_ACCESS_CONTROL"],
    });
    const basicPolicyTag = new gcp.datacatalog.PolicyTag("basic_policy_tag", {
        taxonomy: myTaxonomy.id,
        displayName: "Low security",
        description: "A policy tag normally associated with low security items",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    my_taxonomy = gcp.datacatalog.Taxonomy("my_taxonomy",
        display_name="taxonomy_display_name",
        description="A collection of policy tags",
        activated_policy_types=["FINE_GRAINED_ACCESS_CONTROL"])
    basic_policy_tag = gcp.datacatalog.PolicyTag("basic_policy_tag",
        taxonomy=my_taxonomy.id,
        display_name="Low security",
        description="A policy tag normally associated with low security items")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/datacatalog"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		myTaxonomy, err := datacatalog.NewTaxonomy(ctx, "my_taxonomy", &datacatalog.TaxonomyArgs{
    			DisplayName: pulumi.String("taxonomy_display_name"),
    			Description: pulumi.String("A collection of policy tags"),
    			ActivatedPolicyTypes: pulumi.StringArray{
    				pulumi.String("FINE_GRAINED_ACCESS_CONTROL"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = datacatalog.NewPolicyTag(ctx, "basic_policy_tag", &datacatalog.PolicyTagArgs{
    			Taxonomy:    myTaxonomy.ID(),
    			DisplayName: pulumi.String("Low security"),
    			Description: pulumi.String("A policy tag normally associated with low security items"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var myTaxonomy = new Gcp.DataCatalog.Taxonomy("my_taxonomy", new()
        {
            DisplayName = "taxonomy_display_name",
            Description = "A collection of policy tags",
            ActivatedPolicyTypes = new[]
            {
                "FINE_GRAINED_ACCESS_CONTROL",
            },
        });
    
        var basicPolicyTag = new Gcp.DataCatalog.PolicyTag("basic_policy_tag", new()
        {
            Taxonomy = myTaxonomy.Id,
            DisplayName = "Low security",
            Description = "A policy tag normally associated with low security items",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.datacatalog.Taxonomy;
    import com.pulumi.gcp.datacatalog.TaxonomyArgs;
    import com.pulumi.gcp.datacatalog.PolicyTag;
    import com.pulumi.gcp.datacatalog.PolicyTagArgs;
    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 myTaxonomy = new Taxonomy("myTaxonomy", TaxonomyArgs.builder()
                .displayName("taxonomy_display_name")
                .description("A collection of policy tags")
                .activatedPolicyTypes("FINE_GRAINED_ACCESS_CONTROL")
                .build());
    
            var basicPolicyTag = new PolicyTag("basicPolicyTag", PolicyTagArgs.builder()
                .taxonomy(myTaxonomy.id())
                .displayName("Low security")
                .description("A policy tag normally associated with low security items")
                .build());
    
        }
    }
    
    resources:
      basicPolicyTag:
        type: gcp:datacatalog:PolicyTag
        name: basic_policy_tag
        properties:
          taxonomy: ${myTaxonomy.id}
          displayName: Low security
          description: A policy tag normally associated with low security items
      myTaxonomy:
        type: gcp:datacatalog:Taxonomy
        name: my_taxonomy
        properties:
          displayName: taxonomy_display_name
          description: A collection of policy tags
          activatedPolicyTypes:
            - FINE_GRAINED_ACCESS_CONTROL
    

    Data Catalog Taxonomies Policy Tag Child Policies

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const myTaxonomy = new gcp.datacatalog.Taxonomy("my_taxonomy", {
        displayName: "taxonomy_display_name",
        description: "A collection of policy tags",
        activatedPolicyTypes: ["FINE_GRAINED_ACCESS_CONTROL"],
    });
    const parentPolicy = new gcp.datacatalog.PolicyTag("parent_policy", {
        taxonomy: myTaxonomy.id,
        displayName: "High",
        description: "A policy tag category used for high security access",
    });
    const childPolicy = new gcp.datacatalog.PolicyTag("child_policy", {
        taxonomy: myTaxonomy.id,
        displayName: "ssn",
        description: "A hash of the users ssn",
        parentPolicyTag: parentPolicy.id,
    });
    const childPolicy2 = new gcp.datacatalog.PolicyTag("child_policy2", {
        taxonomy: myTaxonomy.id,
        displayName: "dob",
        description: "The users date of birth",
        parentPolicyTag: parentPolicy.id,
    }, {
        dependsOn: [childPolicy],
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    my_taxonomy = gcp.datacatalog.Taxonomy("my_taxonomy",
        display_name="taxonomy_display_name",
        description="A collection of policy tags",
        activated_policy_types=["FINE_GRAINED_ACCESS_CONTROL"])
    parent_policy = gcp.datacatalog.PolicyTag("parent_policy",
        taxonomy=my_taxonomy.id,
        display_name="High",
        description="A policy tag category used for high security access")
    child_policy = gcp.datacatalog.PolicyTag("child_policy",
        taxonomy=my_taxonomy.id,
        display_name="ssn",
        description="A hash of the users ssn",
        parent_policy_tag=parent_policy.id)
    child_policy2 = gcp.datacatalog.PolicyTag("child_policy2",
        taxonomy=my_taxonomy.id,
        display_name="dob",
        description="The users date of birth",
        parent_policy_tag=parent_policy.id,
        opts = pulumi.ResourceOptions(depends_on=[child_policy]))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/datacatalog"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		myTaxonomy, err := datacatalog.NewTaxonomy(ctx, "my_taxonomy", &datacatalog.TaxonomyArgs{
    			DisplayName: pulumi.String("taxonomy_display_name"),
    			Description: pulumi.String("A collection of policy tags"),
    			ActivatedPolicyTypes: pulumi.StringArray{
    				pulumi.String("FINE_GRAINED_ACCESS_CONTROL"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		parentPolicy, err := datacatalog.NewPolicyTag(ctx, "parent_policy", &datacatalog.PolicyTagArgs{
    			Taxonomy:    myTaxonomy.ID(),
    			DisplayName: pulumi.String("High"),
    			Description: pulumi.String("A policy tag category used for high security access"),
    		})
    		if err != nil {
    			return err
    		}
    		childPolicy, err := datacatalog.NewPolicyTag(ctx, "child_policy", &datacatalog.PolicyTagArgs{
    			Taxonomy:        myTaxonomy.ID(),
    			DisplayName:     pulumi.String("ssn"),
    			Description:     pulumi.String("A hash of the users ssn"),
    			ParentPolicyTag: parentPolicy.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = datacatalog.NewPolicyTag(ctx, "child_policy2", &datacatalog.PolicyTagArgs{
    			Taxonomy:        myTaxonomy.ID(),
    			DisplayName:     pulumi.String("dob"),
    			Description:     pulumi.String("The users date of birth"),
    			ParentPolicyTag: parentPolicy.ID(),
    		}, pulumi.DependsOn([]pulumi.Resource{
    			childPolicy,
    		}))
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var myTaxonomy = new Gcp.DataCatalog.Taxonomy("my_taxonomy", new()
        {
            DisplayName = "taxonomy_display_name",
            Description = "A collection of policy tags",
            ActivatedPolicyTypes = new[]
            {
                "FINE_GRAINED_ACCESS_CONTROL",
            },
        });
    
        var parentPolicy = new Gcp.DataCatalog.PolicyTag("parent_policy", new()
        {
            Taxonomy = myTaxonomy.Id,
            DisplayName = "High",
            Description = "A policy tag category used for high security access",
        });
    
        var childPolicy = new Gcp.DataCatalog.PolicyTag("child_policy", new()
        {
            Taxonomy = myTaxonomy.Id,
            DisplayName = "ssn",
            Description = "A hash of the users ssn",
            ParentPolicyTag = parentPolicy.Id,
        });
    
        var childPolicy2 = new Gcp.DataCatalog.PolicyTag("child_policy2", new()
        {
            Taxonomy = myTaxonomy.Id,
            DisplayName = "dob",
            Description = "The users date of birth",
            ParentPolicyTag = parentPolicy.Id,
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                childPolicy,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.datacatalog.Taxonomy;
    import com.pulumi.gcp.datacatalog.TaxonomyArgs;
    import com.pulumi.gcp.datacatalog.PolicyTag;
    import com.pulumi.gcp.datacatalog.PolicyTagArgs;
    import com.pulumi.resources.CustomResourceOptions;
    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 myTaxonomy = new Taxonomy("myTaxonomy", TaxonomyArgs.builder()
                .displayName("taxonomy_display_name")
                .description("A collection of policy tags")
                .activatedPolicyTypes("FINE_GRAINED_ACCESS_CONTROL")
                .build());
    
            var parentPolicy = new PolicyTag("parentPolicy", PolicyTagArgs.builder()
                .taxonomy(myTaxonomy.id())
                .displayName("High")
                .description("A policy tag category used for high security access")
                .build());
    
            var childPolicy = new PolicyTag("childPolicy", PolicyTagArgs.builder()
                .taxonomy(myTaxonomy.id())
                .displayName("ssn")
                .description("A hash of the users ssn")
                .parentPolicyTag(parentPolicy.id())
                .build());
    
            var childPolicy2 = new PolicyTag("childPolicy2", PolicyTagArgs.builder()
                .taxonomy(myTaxonomy.id())
                .displayName("dob")
                .description("The users date of birth")
                .parentPolicyTag(parentPolicy.id())
                .build(), CustomResourceOptions.builder()
                    .dependsOn(childPolicy)
                    .build());
    
        }
    }
    
    resources:
      parentPolicy:
        type: gcp:datacatalog:PolicyTag
        name: parent_policy
        properties:
          taxonomy: ${myTaxonomy.id}
          displayName: High
          description: A policy tag category used for high security access
      childPolicy:
        type: gcp:datacatalog:PolicyTag
        name: child_policy
        properties:
          taxonomy: ${myTaxonomy.id}
          displayName: ssn
          description: A hash of the users ssn
          parentPolicyTag: ${parentPolicy.id}
      childPolicy2:
        type: gcp:datacatalog:PolicyTag
        name: child_policy2
        properties:
          taxonomy: ${myTaxonomy.id}
          displayName: dob
          description: The users date of birth
          parentPolicyTag: ${parentPolicy.id}
        options:
          dependson:
            - ${childPolicy}
      myTaxonomy:
        type: gcp:datacatalog:Taxonomy
        name: my_taxonomy
        properties:
          displayName: taxonomy_display_name
          description: A collection of policy tags
          activatedPolicyTypes:
            - FINE_GRAINED_ACCESS_CONTROL
    

    Create PolicyTag Resource

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

    Constructor syntax

    new PolicyTag(name: string, args: PolicyTagArgs, opts?: CustomResourceOptions);
    @overload
    def PolicyTag(resource_name: str,
                  args: PolicyTagArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def PolicyTag(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  display_name: Optional[str] = None,
                  taxonomy: Optional[str] = None,
                  description: Optional[str] = None,
                  parent_policy_tag: Optional[str] = None)
    func NewPolicyTag(ctx *Context, name string, args PolicyTagArgs, opts ...ResourceOption) (*PolicyTag, error)
    public PolicyTag(string name, PolicyTagArgs args, CustomResourceOptions? opts = null)
    public PolicyTag(String name, PolicyTagArgs args)
    public PolicyTag(String name, PolicyTagArgs args, CustomResourceOptions options)
    
    type: gcp:datacatalog:PolicyTag
    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 PolicyTagArgs
    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 PolicyTagArgs
    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 PolicyTagArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyTagArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyTagArgs
    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 policyTagResource = new Gcp.DataCatalog.PolicyTag("policyTagResource", new()
    {
        DisplayName = "string",
        Taxonomy = "string",
        Description = "string",
        ParentPolicyTag = "string",
    });
    
    example, err := datacatalog.NewPolicyTag(ctx, "policyTagResource", &datacatalog.PolicyTagArgs{
    	DisplayName:     pulumi.String("string"),
    	Taxonomy:        pulumi.String("string"),
    	Description:     pulumi.String("string"),
    	ParentPolicyTag: pulumi.String("string"),
    })
    
    var policyTagResource = new PolicyTag("policyTagResource", PolicyTagArgs.builder()
        .displayName("string")
        .taxonomy("string")
        .description("string")
        .parentPolicyTag("string")
        .build());
    
    policy_tag_resource = gcp.datacatalog.PolicyTag("policyTagResource",
        display_name="string",
        taxonomy="string",
        description="string",
        parent_policy_tag="string")
    
    const policyTagResource = new gcp.datacatalog.PolicyTag("policyTagResource", {
        displayName: "string",
        taxonomy: "string",
        description: "string",
        parentPolicyTag: "string",
    });
    
    type: gcp:datacatalog:PolicyTag
    properties:
        description: string
        displayName: string
        parentPolicyTag: string
        taxonomy: string
    

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

    DisplayName string
    User defined name of this policy tag. It must: be unique within the parent taxonomy; contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8.
    Taxonomy string
    Taxonomy the policy tag is associated with


    Description string
    Description of this policy tag. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description. If not set, defaults to an empty description.
    ParentPolicyTag string
    Resource name of this policy tag's parent policy tag. If empty, it means this policy tag is a top level policy tag. If not set, defaults to an empty string.
    DisplayName string
    User defined name of this policy tag. It must: be unique within the parent taxonomy; contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8.
    Taxonomy string
    Taxonomy the policy tag is associated with


    Description string
    Description of this policy tag. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description. If not set, defaults to an empty description.
    ParentPolicyTag string
    Resource name of this policy tag's parent policy tag. If empty, it means this policy tag is a top level policy tag. If not set, defaults to an empty string.
    displayName String
    User defined name of this policy tag. It must: be unique within the parent taxonomy; contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8.
    taxonomy String
    Taxonomy the policy tag is associated with


    description String
    Description of this policy tag. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description. If not set, defaults to an empty description.
    parentPolicyTag String
    Resource name of this policy tag's parent policy tag. If empty, it means this policy tag is a top level policy tag. If not set, defaults to an empty string.
    displayName string
    User defined name of this policy tag. It must: be unique within the parent taxonomy; contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8.
    taxonomy string
    Taxonomy the policy tag is associated with


    description string
    Description of this policy tag. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description. If not set, defaults to an empty description.
    parentPolicyTag string
    Resource name of this policy tag's parent policy tag. If empty, it means this policy tag is a top level policy tag. If not set, defaults to an empty string.
    display_name str
    User defined name of this policy tag. It must: be unique within the parent taxonomy; contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8.
    taxonomy str
    Taxonomy the policy tag is associated with


    description str
    Description of this policy tag. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description. If not set, defaults to an empty description.
    parent_policy_tag str
    Resource name of this policy tag's parent policy tag. If empty, it means this policy tag is a top level policy tag. If not set, defaults to an empty string.
    displayName String
    User defined name of this policy tag. It must: be unique within the parent taxonomy; contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8.
    taxonomy String
    Taxonomy the policy tag is associated with


    description String
    Description of this policy tag. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description. If not set, defaults to an empty description.
    parentPolicyTag String
    Resource name of this policy tag's parent policy tag. If empty, it means this policy tag is a top level policy tag. If not set, defaults to an empty string.

    Outputs

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

    ChildPolicyTags List<string>
    Resource names of child policy tags of this policy tag.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name of this policy tag, whose format is: "projects/{project}/locations/{region}/taxonomies/{taxonomy}/policyTags/{policytag}"
    ChildPolicyTags []string
    Resource names of child policy tags of this policy tag.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name of this policy tag, whose format is: "projects/{project}/locations/{region}/taxonomies/{taxonomy}/policyTags/{policytag}"
    childPolicyTags List<String>
    Resource names of child policy tags of this policy tag.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name of this policy tag, whose format is: "projects/{project}/locations/{region}/taxonomies/{taxonomy}/policyTags/{policytag}"
    childPolicyTags string[]
    Resource names of child policy tags of this policy tag.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Resource name of this policy tag, whose format is: "projects/{project}/locations/{region}/taxonomies/{taxonomy}/policyTags/{policytag}"
    child_policy_tags Sequence[str]
    Resource names of child policy tags of this policy tag.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Resource name of this policy tag, whose format is: "projects/{project}/locations/{region}/taxonomies/{taxonomy}/policyTags/{policytag}"
    childPolicyTags List<String>
    Resource names of child policy tags of this policy tag.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name of this policy tag, whose format is: "projects/{project}/locations/{region}/taxonomies/{taxonomy}/policyTags/{policytag}"

    Look up Existing PolicyTag Resource

    Get an existing PolicyTag 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?: PolicyTagState, opts?: CustomResourceOptions): PolicyTag
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            child_policy_tags: Optional[Sequence[str]] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            name: Optional[str] = None,
            parent_policy_tag: Optional[str] = None,
            taxonomy: Optional[str] = None) -> PolicyTag
    func GetPolicyTag(ctx *Context, name string, id IDInput, state *PolicyTagState, opts ...ResourceOption) (*PolicyTag, error)
    public static PolicyTag Get(string name, Input<string> id, PolicyTagState? state, CustomResourceOptions? opts = null)
    public static PolicyTag get(String name, Output<String> id, PolicyTagState 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:
    ChildPolicyTags List<string>
    Resource names of child policy tags of this policy tag.
    Description string
    Description of this policy tag. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description. If not set, defaults to an empty description.
    DisplayName string
    User defined name of this policy tag. It must: be unique within the parent taxonomy; contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8.
    Name string
    Resource name of this policy tag, whose format is: "projects/{project}/locations/{region}/taxonomies/{taxonomy}/policyTags/{policytag}"
    ParentPolicyTag string
    Resource name of this policy tag's parent policy tag. If empty, it means this policy tag is a top level policy tag. If not set, defaults to an empty string.
    Taxonomy string
    Taxonomy the policy tag is associated with


    ChildPolicyTags []string
    Resource names of child policy tags of this policy tag.
    Description string
    Description of this policy tag. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description. If not set, defaults to an empty description.
    DisplayName string
    User defined name of this policy tag. It must: be unique within the parent taxonomy; contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8.
    Name string
    Resource name of this policy tag, whose format is: "projects/{project}/locations/{region}/taxonomies/{taxonomy}/policyTags/{policytag}"
    ParentPolicyTag string
    Resource name of this policy tag's parent policy tag. If empty, it means this policy tag is a top level policy tag. If not set, defaults to an empty string.
    Taxonomy string
    Taxonomy the policy tag is associated with


    childPolicyTags List<String>
    Resource names of child policy tags of this policy tag.
    description String
    Description of this policy tag. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description. If not set, defaults to an empty description.
    displayName String
    User defined name of this policy tag. It must: be unique within the parent taxonomy; contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8.
    name String
    Resource name of this policy tag, whose format is: "projects/{project}/locations/{region}/taxonomies/{taxonomy}/policyTags/{policytag}"
    parentPolicyTag String
    Resource name of this policy tag's parent policy tag. If empty, it means this policy tag is a top level policy tag. If not set, defaults to an empty string.
    taxonomy String
    Taxonomy the policy tag is associated with


    childPolicyTags string[]
    Resource names of child policy tags of this policy tag.
    description string
    Description of this policy tag. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description. If not set, defaults to an empty description.
    displayName string
    User defined name of this policy tag. It must: be unique within the parent taxonomy; contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8.
    name string
    Resource name of this policy tag, whose format is: "projects/{project}/locations/{region}/taxonomies/{taxonomy}/policyTags/{policytag}"
    parentPolicyTag string
    Resource name of this policy tag's parent policy tag. If empty, it means this policy tag is a top level policy tag. If not set, defaults to an empty string.
    taxonomy string
    Taxonomy the policy tag is associated with


    child_policy_tags Sequence[str]
    Resource names of child policy tags of this policy tag.
    description str
    Description of this policy tag. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description. If not set, defaults to an empty description.
    display_name str
    User defined name of this policy tag. It must: be unique within the parent taxonomy; contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8.
    name str
    Resource name of this policy tag, whose format is: "projects/{project}/locations/{region}/taxonomies/{taxonomy}/policyTags/{policytag}"
    parent_policy_tag str
    Resource name of this policy tag's parent policy tag. If empty, it means this policy tag is a top level policy tag. If not set, defaults to an empty string.
    taxonomy str
    Taxonomy the policy tag is associated with


    childPolicyTags List<String>
    Resource names of child policy tags of this policy tag.
    description String
    Description of this policy tag. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description. If not set, defaults to an empty description.
    displayName String
    User defined name of this policy tag. It must: be unique within the parent taxonomy; contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8.
    name String
    Resource name of this policy tag, whose format is: "projects/{project}/locations/{region}/taxonomies/{taxonomy}/policyTags/{policytag}"
    parentPolicyTag String
    Resource name of this policy tag's parent policy tag. If empty, it means this policy tag is a top level policy tag. If not set, defaults to an empty string.
    taxonomy String
    Taxonomy the policy tag is associated with


    Import

    PolicyTag can be imported using any of these accepted formats:

    • {{name}}

    When using the pulumi import command, PolicyTag can be imported using one of the formats above. For example:

    $ pulumi import gcp:datacatalog/policyTag:PolicyTag default {{name}}
    

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

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v7.29.0 published on Wednesday, Jun 26, 2024 by Pulumi