@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
108 lines • 3.31 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Get information about a Google Data Catalog Taxonomy. For more information see
* [the official documentation](https://cloud.google.com/data-catalog/docs)
* and
* [API](https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.taxonomies).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example = gcp.datacatalog.getTaxonomy({
* displayName: "my_taxonomy",
* region: "us-central1",
* });
* const examplePolicyTag = new gcp.datacatalog.PolicyTag("example", {
* taxonomy: example.then(example => example.id),
* displayName: "example_policy_tag",
* description: "A policy tag",
* });
* ```
*/
export declare function getTaxonomy(args: GetTaxonomyArgs, opts?: pulumi.InvokeOptions): Promise<GetTaxonomyResult>;
/**
* A collection of arguments for invoking getTaxonomy.
*/
export interface GetTaxonomyArgs {
/**
* The user-defined name of the taxonomy to look up.
*/
displayName: string;
/**
* The project in which the taxonomy exists. If not provided, the provider project is used.
*/
project?: string;
/**
* The region the taxonomy is located in.
*/
region: string;
}
/**
* A collection of values returned by getTaxonomy.
*/
export interface GetTaxonomyResult {
/**
* A list of policy types activated for this taxonomy.
*/
readonly activatedPolicyTypes: string[];
/**
* The description of the taxonomy.
*/
readonly description: string;
readonly displayName: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* The full resource name of the taxonomy.
*/
readonly name: string;
readonly project: string;
readonly region: string;
}
/**
* Get information about a Google Data Catalog Taxonomy. For more information see
* [the official documentation](https://cloud.google.com/data-catalog/docs)
* and
* [API](https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.taxonomies).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example = gcp.datacatalog.getTaxonomy({
* displayName: "my_taxonomy",
* region: "us-central1",
* });
* const examplePolicyTag = new gcp.datacatalog.PolicyTag("example", {
* taxonomy: example.then(example => example.id),
* displayName: "example_policy_tag",
* description: "A policy tag",
* });
* ```
*/
export declare function getTaxonomyOutput(args: GetTaxonomyOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetTaxonomyResult>;
/**
* A collection of arguments for invoking getTaxonomy.
*/
export interface GetTaxonomyOutputArgs {
/**
* The user-defined name of the taxonomy to look up.
*/
displayName: pulumi.Input<string>;
/**
* The project in which the taxonomy exists. If not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* The region the taxonomy is located in.
*/
region: pulumi.Input<string>;
}
//# sourceMappingURL=getTaxonomy.d.ts.map