@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
140 lines • 6.12 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.Glossary = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* 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}}
* ```
*
* ```sh
* $ pulumi import gcp:dataplex/glossary:Glossary default {{project}}/{{location}}/{{glossary_id}}
* ```
*
* ```sh
* $ pulumi import gcp:dataplex/glossary:Glossary default {{location}}/{{glossary_id}}
* ```
*/
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, id, state, opts) {
return new Glossary(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* 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) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === Glossary.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["categoryCount"] = state ? state.categoryCount : undefined;
resourceInputs["createTime"] = state ? state.createTime : undefined;
resourceInputs["description"] = state ? state.description : undefined;
resourceInputs["displayName"] = state ? state.displayName : undefined;
resourceInputs["effectiveLabels"] = state ? state.effectiveLabels : undefined;
resourceInputs["glossaryId"] = state ? state.glossaryId : undefined;
resourceInputs["labels"] = state ? state.labels : undefined;
resourceInputs["location"] = state ? state.location : undefined;
resourceInputs["name"] = state ? state.name : undefined;
resourceInputs["project"] = state ? state.project : undefined;
resourceInputs["pulumiLabels"] = state ? state.pulumiLabels : undefined;
resourceInputs["termCount"] = state ? state.termCount : undefined;
resourceInputs["uid"] = state ? state.uid : undefined;
resourceInputs["updateTime"] = state ? state.updateTime : undefined;
}
else {
const args = argsOrState;
if ((!args || args.glossaryId === undefined) && !opts.urn) {
throw new Error("Missing required property 'glossaryId'");
}
if ((!args || args.location === undefined) && !opts.urn) {
throw new Error("Missing required property 'location'");
}
resourceInputs["description"] = args ? args.description : undefined;
resourceInputs["displayName"] = args ? args.displayName : undefined;
resourceInputs["glossaryId"] = args ? args.glossaryId : undefined;
resourceInputs["labels"] = args ? args.labels : undefined;
resourceInputs["location"] = args ? args.location : undefined;
resourceInputs["project"] = args ? args.project : undefined;
resourceInputs["categoryCount"] = undefined /*out*/;
resourceInputs["createTime"] = undefined /*out*/;
resourceInputs["effectiveLabels"] = undefined /*out*/;
resourceInputs["name"] = undefined /*out*/;
resourceInputs["pulumiLabels"] = undefined /*out*/;
resourceInputs["termCount"] = undefined /*out*/;
resourceInputs["uid"] = undefined /*out*/;
resourceInputs["updateTime"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const secretOpts = { additionalSecretOutputs: ["effectiveLabels", "pulumiLabels"] };
opts = pulumi.mergeOptions(opts, secretOpts);
super(Glossary.__pulumiType, name, resourceInputs, opts);
}
}
exports.Glossary = Glossary;
/** @internal */
Glossary.__pulumiType = 'gcp:dataplex/glossary:Glossary';
//# sourceMappingURL=glossary.js.map