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

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

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 taxonomy in a specified project. The taxonomy is initially empty, that is, it doesn’t contain policy tags. Auto-naming is currently not supported for this resource.

    Create Taxonomy Resource

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

    Constructor syntax

    new Taxonomy(name: string, args: TaxonomyArgs, opts?: CustomResourceOptions);
    @overload
    def Taxonomy(resource_name: str,
                 args: TaxonomyArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Taxonomy(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 display_name: Optional[str] = None,
                 activated_policy_types: Optional[Sequence[TaxonomyActivatedPolicyTypesItem]] = None,
                 description: Optional[str] = None,
                 location: Optional[str] = None,
                 project: Optional[str] = None)
    func NewTaxonomy(ctx *Context, name string, args TaxonomyArgs, opts ...ResourceOption) (*Taxonomy, error)
    public Taxonomy(string name, TaxonomyArgs args, CustomResourceOptions? opts = null)
    public Taxonomy(String name, TaxonomyArgs args)
    public Taxonomy(String name, TaxonomyArgs args, CustomResourceOptions options)
    
    type: google-native:datacatalog/v1:Taxonomy
    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 TaxonomyArgs
    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 TaxonomyArgs
    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 TaxonomyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TaxonomyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TaxonomyArgs
    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 taxonomyResource = new GoogleNative.DataCatalog.V1.Taxonomy("taxonomyResource", new()
    {
        DisplayName = "string",
        ActivatedPolicyTypes = new[]
        {
            GoogleNative.DataCatalog.V1.TaxonomyActivatedPolicyTypesItem.PolicyTypeUnspecified,
        },
        Description = "string",
        Location = "string",
        Project = "string",
    });
    
    example, err := datacatalog.NewTaxonomy(ctx, "taxonomyResource", &datacatalog.TaxonomyArgs{
    DisplayName: pulumi.String("string"),
    ActivatedPolicyTypes: datacatalog.TaxonomyActivatedPolicyTypesItemArray{
    datacatalog.TaxonomyActivatedPolicyTypesItemPolicyTypeUnspecified,
    },
    Description: pulumi.String("string"),
    Location: pulumi.String("string"),
    Project: pulumi.String("string"),
    })
    
    var taxonomyResource = new Taxonomy("taxonomyResource", TaxonomyArgs.builder()
        .displayName("string")
        .activatedPolicyTypes("POLICY_TYPE_UNSPECIFIED")
        .description("string")
        .location("string")
        .project("string")
        .build());
    
    taxonomy_resource = google_native.datacatalog.v1.Taxonomy("taxonomyResource",
        display_name="string",
        activated_policy_types=[google_native.datacatalog.v1.TaxonomyActivatedPolicyTypesItem.POLICY_TYPE_UNSPECIFIED],
        description="string",
        location="string",
        project="string")
    
    const taxonomyResource = new google_native.datacatalog.v1.Taxonomy("taxonomyResource", {
        displayName: "string",
        activatedPolicyTypes: [google_native.datacatalog.v1.TaxonomyActivatedPolicyTypesItem.PolicyTypeUnspecified],
        description: "string",
        location: "string",
        project: "string",
    });
    
    type: google-native:datacatalog/v1:Taxonomy
    properties:
        activatedPolicyTypes:
            - POLICY_TYPE_UNSPECIFIED
        description: string
        displayName: string
        location: string
        project: string
    

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

    DisplayName string
    User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and spaces, and be at most 200 bytes long when encoded in UTF-8. The taxonomy display name must be unique within an organization.
    ActivatedPolicyTypes List<Pulumi.GoogleNative.DataCatalog.V1.TaxonomyActivatedPolicyTypesItem>
    Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.
    Description string
    Optional. Description of this taxonomy. 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
    Project string
    DisplayName string
    User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and spaces, and be at most 200 bytes long when encoded in UTF-8. The taxonomy display name must be unique within an organization.
    ActivatedPolicyTypes []TaxonomyActivatedPolicyTypesItem
    Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.
    Description string
    Optional. Description of this taxonomy. 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
    Project string
    displayName String
    User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and spaces, and be at most 200 bytes long when encoded in UTF-8. The taxonomy display name must be unique within an organization.
    activatedPolicyTypes List<TaxonomyActivatedPolicyTypesItem>
    Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.
    description String
    Optional. Description of this taxonomy. 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
    project String
    displayName string
    User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and spaces, and be at most 200 bytes long when encoded in UTF-8. The taxonomy display name must be unique within an organization.
    activatedPolicyTypes TaxonomyActivatedPolicyTypesItem[]
    Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.
    description string
    Optional. Description of this taxonomy. 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
    project string
    display_name str
    User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and spaces, and be at most 200 bytes long when encoded in UTF-8. The taxonomy display name must be unique within an organization.
    activated_policy_types Sequence[TaxonomyActivatedPolicyTypesItem]
    Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.
    description str
    Optional. Description of this taxonomy. 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
    project str
    displayName String
    User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and spaces, and be at most 200 bytes long when encoded in UTF-8. The taxonomy display name must be unique within an organization.
    activatedPolicyTypes List<"POLICY_TYPE_UNSPECIFIED" | "FINE_GRAINED_ACCESS_CONTROL">
    Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.
    description String
    Optional. Description of this taxonomy. 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
    project String

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs.
    PolicyTagCount int
    Number of policy tags in this taxonomy.
    Service Pulumi.GoogleNative.DataCatalog.V1.Outputs.GoogleCloudDatacatalogV1TaxonomyServiceResponse
    Identity of the service which owns the Taxonomy. This field is only populated when the taxonomy is created by a Google Cloud service. Currently only 'DATAPLEX' is supported.
    TaxonomyTimestamps Pulumi.GoogleNative.DataCatalog.V1.Outputs.GoogleCloudDatacatalogV1SystemTimestampsResponse
    Creation and modification timestamps of this taxonomy.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs.
    PolicyTagCount int
    Number of policy tags in this taxonomy.
    Service GoogleCloudDatacatalogV1TaxonomyServiceResponse
    Identity of the service which owns the Taxonomy. This field is only populated when the taxonomy is created by a Google Cloud service. Currently only 'DATAPLEX' is supported.
    TaxonomyTimestamps GoogleCloudDatacatalogV1SystemTimestampsResponse
    Creation and modification timestamps of this taxonomy.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs.
    policyTagCount Integer
    Number of policy tags in this taxonomy.
    service GoogleCloudDatacatalogV1TaxonomyServiceResponse
    Identity of the service which owns the Taxonomy. This field is only populated when the taxonomy is created by a Google Cloud service. Currently only 'DATAPLEX' is supported.
    taxonomyTimestamps GoogleCloudDatacatalogV1SystemTimestampsResponse
    Creation and modification timestamps of this taxonomy.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs.
    policyTagCount number
    Number of policy tags in this taxonomy.
    service GoogleCloudDatacatalogV1TaxonomyServiceResponse
    Identity of the service which owns the Taxonomy. This field is only populated when the taxonomy is created by a Google Cloud service. Currently only 'DATAPLEX' is supported.
    taxonomyTimestamps GoogleCloudDatacatalogV1SystemTimestampsResponse
    Creation and modification timestamps of this taxonomy.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs.
    policy_tag_count int
    Number of policy tags in this taxonomy.
    service GoogleCloudDatacatalogV1TaxonomyServiceResponse
    Identity of the service which owns the Taxonomy. This field is only populated when the taxonomy is created by a Google Cloud service. Currently only 'DATAPLEX' is supported.
    taxonomy_timestamps GoogleCloudDatacatalogV1SystemTimestampsResponse
    Creation and modification timestamps of this taxonomy.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs.
    policyTagCount Number
    Number of policy tags in this taxonomy.
    service Property Map
    Identity of the service which owns the Taxonomy. This field is only populated when the taxonomy is created by a Google Cloud service. Currently only 'DATAPLEX' is supported.
    taxonomyTimestamps Property Map
    Creation and modification timestamps of this taxonomy.

    Supporting Types

    GoogleCloudDatacatalogV1SystemTimestampsResponse, GoogleCloudDatacatalogV1SystemTimestampsResponseArgs

    CreateTime string
    Creation timestamp of the resource within the given system.
    ExpireTime string
    Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources.
    UpdateTime string
    Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes.
    CreateTime string
    Creation timestamp of the resource within the given system.
    ExpireTime string
    Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources.
    UpdateTime string
    Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes.
    createTime String
    Creation timestamp of the resource within the given system.
    expireTime String
    Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources.
    updateTime String
    Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes.
    createTime string
    Creation timestamp of the resource within the given system.
    expireTime string
    Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources.
    updateTime string
    Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes.
    create_time str
    Creation timestamp of the resource within the given system.
    expire_time str
    Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources.
    update_time str
    Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes.
    createTime String
    Creation timestamp of the resource within the given system.
    expireTime String
    Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources.
    updateTime String
    Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes.

    GoogleCloudDatacatalogV1TaxonomyServiceResponse, GoogleCloudDatacatalogV1TaxonomyServiceResponseArgs

    Identity string
    The service agent for the service.
    Name string
    The Google Cloud service name.
    Identity string
    The service agent for the service.
    Name string
    The Google Cloud service name.
    identity String
    The service agent for the service.
    name String
    The Google Cloud service name.
    identity string
    The service agent for the service.
    name string
    The Google Cloud service name.
    identity str
    The service agent for the service.
    name str
    The Google Cloud service name.
    identity String
    The service agent for the service.
    name String
    The Google Cloud service name.

    TaxonomyActivatedPolicyTypesItem, TaxonomyActivatedPolicyTypesItemArgs

    PolicyTypeUnspecified
    POLICY_TYPE_UNSPECIFIEDUnspecified policy type.
    FineGrainedAccessControl
    FINE_GRAINED_ACCESS_CONTROLFine-grained access control policy that enables access control on tagged sub-resources.
    TaxonomyActivatedPolicyTypesItemPolicyTypeUnspecified
    POLICY_TYPE_UNSPECIFIEDUnspecified policy type.
    TaxonomyActivatedPolicyTypesItemFineGrainedAccessControl
    FINE_GRAINED_ACCESS_CONTROLFine-grained access control policy that enables access control on tagged sub-resources.
    PolicyTypeUnspecified
    POLICY_TYPE_UNSPECIFIEDUnspecified policy type.
    FineGrainedAccessControl
    FINE_GRAINED_ACCESS_CONTROLFine-grained access control policy that enables access control on tagged sub-resources.
    PolicyTypeUnspecified
    POLICY_TYPE_UNSPECIFIEDUnspecified policy type.
    FineGrainedAccessControl
    FINE_GRAINED_ACCESS_CONTROLFine-grained access control policy that enables access control on tagged sub-resources.
    POLICY_TYPE_UNSPECIFIED
    POLICY_TYPE_UNSPECIFIEDUnspecified policy type.
    FINE_GRAINED_ACCESS_CONTROL
    FINE_GRAINED_ACCESS_CONTROLFine-grained access control policy that enables access control on tagged sub-resources.
    "POLICY_TYPE_UNSPECIFIED"
    POLICY_TYPE_UNSPECIFIEDUnspecified policy type.
    "FINE_GRAINED_ACCESS_CONTROL"
    FINE_GRAINED_ACCESS_CONTROLFine-grained access control policy that enables access control on tagged sub-resources.

    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