@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
170 lines (169 loc) • 6.62 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* A collection of policy tags that classify data along a common axis.
*
* To get more information about Taxonomy, see:
*
* * [API documentation](https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.taxonomies)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/data-catalog/docs)
*
* ## Example Usage
*
* ### Data Catalog Taxonomy Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const basicTaxonomy = new gcp.datacatalog.Taxonomy("basic_taxonomy", {
* displayName: "my_taxonomy",
* description: "A collection of policy tags",
* activatedPolicyTypes: ["FINE_GRAINED_ACCESS_CONTROL"],
* });
* ```
*
* ## Import
*
* Taxonomy can be imported using any of these accepted formats:
*
* * `{{name}}`
*
* When using the `pulumi import` command, Taxonomy can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:datacatalog/taxonomy:Taxonomy default {{name}}
* ```
*/
export declare class Taxonomy extends pulumi.CustomResource {
/**
* Get an existing Taxonomy resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TaxonomyState, opts?: pulumi.CustomResourceOptions): Taxonomy;
/**
* Returns true if the given object is an instance of Taxonomy. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Taxonomy;
/**
* A list of policy types that are activated for this taxonomy. If not set,
* defaults to an empty list.
* Each value may be one of: `POLICY_TYPE_UNSPECIFIED`, `FINE_GRAINED_ACCESS_CONTROL`.
*/
readonly activatedPolicyTypes: pulumi.Output<string[] | undefined>;
/**
* Description of this taxonomy. 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.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* User defined name of this taxonomy.
* The taxonomy display name must be unique within an organization.
* It must: 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.
*/
readonly displayName: pulumi.Output<string>;
/**
* Resource name of this taxonomy, whose format is:
* "projects/{project}/locations/{region}/taxonomies/{taxonomy}".
*/
readonly name: pulumi.Output<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* Taxonomy location region.
*/
readonly region: pulumi.Output<string>;
/**
* Create a Taxonomy resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: TaxonomyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Taxonomy resources.
*/
export interface TaxonomyState {
/**
* A list of policy types that are activated for this taxonomy. If not set,
* defaults to an empty list.
* Each value may be one of: `POLICY_TYPE_UNSPECIFIED`, `FINE_GRAINED_ACCESS_CONTROL`.
*/
activatedPolicyTypes?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Description of this taxonomy. 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.
*/
description?: pulumi.Input<string>;
/**
* User defined name of this taxonomy.
* The taxonomy display name must be unique within an organization.
* It must: 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.
*/
displayName?: pulumi.Input<string>;
/**
* Resource name of this taxonomy, whose format is:
* "projects/{project}/locations/{region}/taxonomies/{taxonomy}".
*/
name?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* Taxonomy location region.
*/
region?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Taxonomy resource.
*/
export interface TaxonomyArgs {
/**
* A list of policy types that are activated for this taxonomy. If not set,
* defaults to an empty list.
* Each value may be one of: `POLICY_TYPE_UNSPECIFIED`, `FINE_GRAINED_ACCESS_CONTROL`.
*/
activatedPolicyTypes?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Description of this taxonomy. 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.
*/
description?: pulumi.Input<string>;
/**
* User defined name of this taxonomy.
* The taxonomy display name must be unique within an organization.
* It must: 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.
*/
displayName: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* Taxonomy location region.
*/
region?: pulumi.Input<string>;
}