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

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.PolicyTag

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 policy tag in a taxonomy. Auto-naming is currently not supported for this resource.

    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_id: Optional[str] = None,
                  description: Optional[str] = None,
                  location: Optional[str] = None,
                  parent_policy_tag: Optional[str] = None,
                  project: 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: google-native:datacatalog/v1: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 GoogleNative.DataCatalog.V1.PolicyTag("policyTagResource", new()
    {
        DisplayName = "string",
        TaxonomyId = "string",
        Description = "string",
        Location = "string",
        ParentPolicyTag = "string",
        Project = "string",
    });
    
    example, err := datacatalog.NewPolicyTag(ctx, "policyTagResource", &datacatalog.PolicyTagArgs{
    DisplayName: pulumi.String("string"),
    TaxonomyId: pulumi.String("string"),
    Description: pulumi.String("string"),
    Location: pulumi.String("string"),
    ParentPolicyTag: pulumi.String("string"),
    Project: pulumi.String("string"),
    })
    
    var policyTagResource = new PolicyTag("policyTagResource", PolicyTagArgs.builder()
        .displayName("string")
        .taxonomyId("string")
        .description("string")
        .location("string")
        .parentPolicyTag("string")
        .project("string")
        .build());
    
    policy_tag_resource = google_native.datacatalog.v1.PolicyTag("policyTagResource",
        display_name="string",
        taxonomy_id="string",
        description="string",
        location="string",
        parent_policy_tag="string",
        project="string")
    
    const policyTagResource = new google_native.datacatalog.v1.PolicyTag("policyTagResource", {
        displayName: "string",
        taxonomyId: "string",
        description: "string",
        location: "string",
        parentPolicyTag: "string",
        project: "string",
    });
    
    type: google-native:datacatalog/v1:PolicyTag
    properties:
        description: string
        displayName: string
        location: string
        parentPolicyTag: string
        project: string
        taxonomyId: 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. The name can't start or end with spaces and must be unique within the parent taxonomy, contain only Unicode letters, numbers, underscores, dashes and spaces, and be at most 200 bytes long when encoded in UTF-8.
    TaxonomyId string
    Description string
    Description of this policy tag. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns and page breaks, and be at most 2000 bytes long when encoded in UTF-8.
    Location string
    ParentPolicyTag string
    Resource name of this policy tag's parent policy tag. If empty, this is a top level tag. If not set, defaults to an empty string. For example, for the "LatLong" policy tag in the example above, this field contains the resource name of the "Geolocation" policy tag, and, for "Geolocation", this field is empty.
    Project string
    DisplayName string
    User-defined name of this policy tag. The name can't start or end with spaces and must be unique within the parent taxonomy, contain only Unicode letters, numbers, underscores, dashes and spaces, and be at most 200 bytes long when encoded in UTF-8.
    TaxonomyId string
    Description string
    Description of this policy tag. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns and page breaks, and be at most 2000 bytes long when encoded in UTF-8.
    Location string
    ParentPolicyTag string
    Resource name of this policy tag's parent policy tag. If empty, this is a top level tag. If not set, defaults to an empty string. For example, for the "LatLong" policy tag in the example above, this field contains the resource name of the "Geolocation" policy tag, and, for "Geolocation", this field is empty.
    Project string
    displayName String
    User-defined name of this policy tag. The name can't start or end with spaces and must be unique within the parent taxonomy, contain only Unicode letters, numbers, underscores, dashes and spaces, and be at most 200 bytes long when encoded in UTF-8.
    taxonomyId String
    description String
    Description of this policy tag. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns and page breaks, and be at most 2000 bytes long when encoded in UTF-8.
    location String
    parentPolicyTag String
    Resource name of this policy tag's parent policy tag. If empty, this is a top level tag. If not set, defaults to an empty string. For example, for the "LatLong" policy tag in the example above, this field contains the resource name of the "Geolocation" policy tag, and, for "Geolocation", this field is empty.
    project String
    displayName string
    User-defined name of this policy tag. The name can't start or end with spaces and must be unique within the parent taxonomy, contain only Unicode letters, numbers, underscores, dashes and spaces, and be at most 200 bytes long when encoded in UTF-8.
    taxonomyId string
    description string
    Description of this policy tag. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns and page breaks, and be at most 2000 bytes long when encoded in UTF-8.
    location string
    parentPolicyTag string
    Resource name of this policy tag's parent policy tag. If empty, this is a top level tag. If not set, defaults to an empty string. For example, for the "LatLong" policy tag in the example above, this field contains the resource name of the "Geolocation" policy tag, and, for "Geolocation", this field is empty.
    project string
    display_name str
    User-defined name of this policy tag. The name can't start or end with spaces and must be unique within the parent taxonomy, contain only Unicode letters, numbers, underscores, dashes and spaces, and be at most 200 bytes long when encoded in UTF-8.
    taxonomy_id str
    description str
    Description of this policy tag. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns and page breaks, and be at most 2000 bytes long when encoded in UTF-8.
    location str
    parent_policy_tag str
    Resource name of this policy tag's parent policy tag. If empty, this is a top level tag. If not set, defaults to an empty string. For example, for the "LatLong" policy tag in the example above, this field contains the resource name of the "Geolocation" policy tag, and, for "Geolocation", this field is empty.
    project str
    displayName String
    User-defined name of this policy tag. The name can't start or end with spaces and must be unique within the parent taxonomy, contain only Unicode letters, numbers, underscores, dashes and spaces, and be at most 200 bytes long when encoded in UTF-8.
    taxonomyId String
    description String
    Description of this policy tag. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns and page breaks, and be at most 2000 bytes long when encoded in UTF-8.
    location String
    parentPolicyTag String
    Resource name of this policy tag's parent policy tag. If empty, this is a top level tag. If not set, defaults to an empty string. For example, for the "LatLong" policy tag in the example above, this field contains the resource name of the "Geolocation" policy tag, and, for "Geolocation", this field is empty.
    project 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 in the URL format. The policy tag manager generates unique taxonomy IDs and policy tag IDs.
    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 in the URL format. The policy tag manager generates unique taxonomy IDs and policy tag IDs.
    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 in the URL format. The policy tag manager generates unique taxonomy IDs and policy tag IDs.
    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 in the URL format. The policy tag manager generates unique taxonomy IDs and policy tag IDs.
    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 in the URL format. The policy tag manager generates unique taxonomy IDs and policy tag IDs.
    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 in the URL format. The policy tag manager generates unique taxonomy IDs and policy tag IDs.

    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