@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
277 lines • 10.8 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Represents a collection of categories and terms defined by the user. Glossary is a top level resource and is the GCP parent resource of all the categories and terms within it.
*
* ## Example Usage
*
* ### Dataplex Glossary Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const glossaryTestId = new gcp.dataplex.Glossary("glossary_test_id", {
* glossaryId: "glossary-basic",
* location: "us-central1",
* });
* ```
* ### Dataplex Glossary Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const glossaryTestIdFull = new gcp.dataplex.Glossary("glossary_test_id_full", {
* glossaryId: "glossary-full",
* location: "us-central1",
* labels: {
* tag: "test-tf",
* },
* displayName: "terraform glossary",
* description: "glossary created by Terraform",
* });
* ```
*
* ## Import
*
* Glossary can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}`
* * `{{project}}/{{location}}/{{glossary_id}}`
* * `{{location}}/{{glossary_id}}`
*
* When using the `pulumi import` command, Glossary can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:dataplex/glossary:Glossary default projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}
* $ pulumi import gcp:dataplex/glossary:Glossary default {{project}}/{{location}}/{{glossary_id}}
* $ pulumi import gcp:dataplex/glossary:Glossary default {{location}}/{{glossary_id}}
* ```
*/
export declare class Glossary extends pulumi.CustomResource {
/**
* Get an existing Glossary 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?: GlossaryState, opts?: pulumi.CustomResourceOptions): Glossary;
/**
* Returns true if the given object is an instance of Glossary. 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 Glossary;
/**
* The number of categories in the glossary.
*/
readonly categoryCount: pulumi.Output<number>;
/**
* The time at which the glossary was created.
*/
readonly createTime: pulumi.Output<string>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* The user-mutable description of the glossary.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* User friendly display name of the glossary. This is user-mutable. This will be same as the glossaryId, if not specified.
*/
readonly displayName: pulumi.Output<string | undefined>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
readonly effectiveLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* The glossary id for creation.
*/
readonly glossaryId: pulumi.Output<string>;
/**
* User-defined labels for the Glossary.
*
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The location where the glossary should reside.
*/
readonly location: pulumi.Output<string>;
/**
* The resource name of the Glossary. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}
*/
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>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
readonly pulumiLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* The number of terms in the glossary.
*/
readonly termCount: pulumi.Output<number>;
/**
* System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
*/
readonly uid: pulumi.Output<string>;
/**
* The time at which the glossary was last updated.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a Glossary 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: GlossaryArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Glossary resources.
*/
export interface GlossaryState {
/**
* The number of categories in the glossary.
*/
categoryCount?: pulumi.Input<number | undefined>;
/**
* The time at which the glossary was created.
*/
createTime?: pulumi.Input<string | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* The user-mutable description of the glossary.
*/
description?: pulumi.Input<string | undefined>;
/**
* User friendly display name of the glossary. This is user-mutable. This will be same as the glossaryId, if not specified.
*/
displayName?: pulumi.Input<string | undefined>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
effectiveLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* The glossary id for creation.
*/
glossaryId?: pulumi.Input<string | undefined>;
/**
* User-defined labels for the Glossary.
*
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* The location where the glossary should reside.
*/
location?: pulumi.Input<string | undefined>;
/**
* The resource name of the Glossary. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}
*/
name?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
pulumiLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* The number of terms in the glossary.
*/
termCount?: pulumi.Input<number | undefined>;
/**
* System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
*/
uid?: pulumi.Input<string | undefined>;
/**
* The time at which the glossary was last updated.
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a Glossary resource.
*/
export interface GlossaryArgs {
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* The user-mutable description of the glossary.
*/
description?: pulumi.Input<string | undefined>;
/**
* User friendly display name of the glossary. This is user-mutable. This will be same as the glossaryId, if not specified.
*/
displayName?: pulumi.Input<string | undefined>;
/**
* The glossary id for creation.
*/
glossaryId: pulumi.Input<string>;
/**
* User-defined labels for the Glossary.
*
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* The location where the glossary should reside.
*/
location: 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 | undefined>;
}
//# sourceMappingURL=glossary.d.ts.map