@pulumi/gcp/dataplex/glossaryTerm.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Represents a collection of terms within a Glossary that are related to each other.
 *
 * ## Example Usage
 *
 * ### Dataplex Glossary Term Basic
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const termTestId = new gcp.dataplex.Glossary("term_test_id", {
 *     glossaryId: "tf-test-glossary_9329",
 *     location: "us-central1",
 * });
 * const termTestIdGlossaryTerm = new gcp.dataplex.GlossaryTerm("term_test_id", {
 *     parent: pulumi.interpolate`projects/${termTestId.project}/locations/us-central1/glossaries/${termTestId.glossaryId}`,
 *     glossaryId: termTestId.glossaryId,
 *     location: "us-central1",
 *     termId: "tf-test-term-basic_37135",
 * });
 * ```
 * ### Dataplex Glossary Term Full
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const termTestIdFull = new gcp.dataplex.Glossary("term_test_id_full", {
 *     glossaryId: "tf-test-glossary_42503",
 *     location: "us-central1",
 * });
 * const termTestIdFullGlossaryTerm = new gcp.dataplex.GlossaryTerm("term_test_id_full", {
 *     parent: pulumi.interpolate`projects/${termTestIdFull.project}/locations/us-central1/glossaries/${termTestIdFull.glossaryId}`,
 *     glossaryId: termTestIdFull.glossaryId,
 *     location: "us-central1",
 *     termId: "tf-test-term-full_9991",
 *     labels: {
 *         tag: "test-tf",
 *     },
 *     displayName: "terraform term",
 *     description: "term created by Terraform",
 * });
 * ```
 *
 * ## Import
 *
 * GlossaryTerm can be imported using any of these accepted formats:
 *
 * * `projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}/terms/{{term_id}}`
 * * `{{project}}/{{location}}/{{glossary_id}}/{{term_id}}`
 * * `{{location}}/{{glossary_id}}/{{term_id}}`
 *
 * When using the `pulumi import` command, GlossaryTerm can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:dataplex/glossaryTerm:GlossaryTerm default projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}/terms/{{term_id}}
 * $ pulumi import gcp:dataplex/glossaryTerm:GlossaryTerm default {{project}}/{{location}}/{{glossary_id}}/{{term_id}}
 * $ pulumi import gcp:dataplex/glossaryTerm:GlossaryTerm default {{location}}/{{glossary_id}}/{{term_id}}
 * ```
 */
export declare class GlossaryTerm extends pulumi.CustomResource {
    /**
     * Get an existing GlossaryTerm 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?: GlossaryTermState, opts?: pulumi.CustomResourceOptions): GlossaryTerm;
    /**
     * Returns true if the given object is an instance of GlossaryTerm.  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 GlossaryTerm;
    /**
     * The time at which the GlossaryTerm 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 GlossaryTerm.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the termId, 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 | undefined>;
    /**
     * User-defined labels for the GlossaryTerm.
     *
     * **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 term should reside.
     */
    readonly location: pulumi.Output<string>;
    /**
     * The resource name of the GlossaryTerm. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{termId}
     */
    readonly name: pulumi.Output<string>;
    /**
     * The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a Term. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/terms/{termId}
     */
    readonly parent: 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 term id for creation.
     */
    readonly termId: pulumi.Output<string | undefined>;
    /**
     * System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
     */
    readonly uid: pulumi.Output<string>;
    /**
     * The time at which the GlossaryTerm was last updated.
     */
    readonly updateTime: pulumi.Output<string>;
    /**
     * Create a GlossaryTerm 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: GlossaryTermArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering GlossaryTerm resources.
 */
export interface GlossaryTermState {
    /**
     * The time at which the GlossaryTerm 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 GlossaryTerm.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the termId, 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 GlossaryTerm.
     *
     * **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 term should reside.
     */
    location?: pulumi.Input<string | undefined>;
    /**
     * The resource name of the GlossaryTerm. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{termId}
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a Term. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/terms/{termId}
     */
    parent?: 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 term id for creation.
     */
    termId?: pulumi.Input<string | undefined>;
    /**
     * System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
     */
    uid?: pulumi.Input<string | undefined>;
    /**
     * The time at which the GlossaryTerm was last updated.
     */
    updateTime?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a GlossaryTerm resource.
 */
export interface GlossaryTermArgs {
    /**
     * 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 GlossaryTerm.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the termId, if not specified.
     */
    displayName?: pulumi.Input<string | undefined>;
    /**
     * The glossary id for creation.
     */
    glossaryId?: pulumi.Input<string | undefined>;
    /**
     * User-defined labels for the GlossaryTerm.
     *
     * **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 term should reside.
     */
    location: pulumi.Input<string>;
    /**
     * The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a Term. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/terms/{termId}
     */
    parent: 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>;
    /**
     * The term id for creation.
     */
    termId?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=glossaryTerm.d.ts.map