@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
311 lines • 11.3 kB
JavaScript
"use strict";
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.AspectType = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("../utilities"));
/**
* An Aspect Type is a template for creating Aspects.
*
* ## Example Usage
*
* ### Dataplex Aspect Type Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const testAspectTypeBasic = new gcp.dataplex.AspectType("test_aspect_type_basic", {
* aspectTypeId: "aspect-type-basic",
* project: "my-project-name",
* location: "us-central1",
* dataClassification: "DATA_CLASSIFICATION_UNSPECIFIED",
* metadataTemplate: `{
* \\"name\\": \\"tf-test-template\\",
* \\"type\\": \\"record\\",
* \\"recordFields\\": [
* {
* \\"name\\": \\"type\\",
* \\"type\\": \\"enum\\",
* \\"annotations\\": {
* \\"displayName\\": \\"Type\\",
* \\"description\\": \\"Specifies the type of view represented by the entry.\\"
* },
* \\"index\\": 1,
* \\"constraints\\": {
* \\"required\\": true
* },
* \\"enumValues\\": [
* {
* \\"name\\": \\"VIEW\\",
* \\"index\\": 1
* }
* ]
* }
* ]
* }
* `,
* });
* ```
* ### Dataplex Aspect Type Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const testAspectTypeFull = new gcp.dataplex.AspectType("test_aspect_type_full", {
* aspectTypeId: "aspect-type-full",
* project: "my-project-name",
* location: "us-central1",
* labels: {
* tag: "test-tf",
* },
* displayName: "terraform aspect type",
* description: "data aspect type created by Terraform",
* dataClassification: "METADATA_AND_DATA",
* metadataTemplate: `{
* \\"type\\": \\"record\\",
* \\"name\\": \\"Schema\\",
* \\"recordFields\\": [
* {
* \\"name\\": \\"fields\\",
* \\"type\\": \\"array\\",
* \\"index\\": 1,
* \\"arrayItems\\": {
* \\"name\\": \\"field\\",
* \\"type\\": \\"record\\",
* \\"typeId\\": \\"field\\",
* \\"recordFields\\": [
* {
* \\"name\\": \\"name\\",
* \\"type\\": \\"string\\",
* \\"index\\": 1,
* \\"constraints\\": {
* \\"required\\": true
* }
* },
* {
* \\"name\\": \\"description\\",
* \\"type\\": \\"string\\",
* \\"index\\": 2
* },
* {
* \\"name\\": \\"dataType\\",
* \\"type\\": \\"string\\",
* \\"index\\": 3,
* \\"constraints\\": {
* \\"required\\": true
* }
* },
* {
* \\"name\\": \\"metadataType\\",
* \\"type\\": \\"enum\\",
* \\"index\\": 4,
* \\"constraints\\": {
* \\"required\\": true
* },
* \\"enumValues\\": [
* {
* \\"name\\": \\"BOOLEAN\\",
* \\"index\\": 1
* },
* {
* \\"name\\": \\"NUMBER\\",
* \\"index\\": 2
* },
* {
* \\"name\\": \\"STRING\\",
* \\"index\\": 3
* },
* {
* \\"name\\": \\"BYTES\\",
* \\"index\\": 4
* },
* {
* \\"name\\": \\"DATETIME\\",
* \\"index\\": 5
* },
* {
* \\"name\\": \\"TIMESTAMP\\",
* \\"index\\": 6
* },
* {
* \\"name\\": \\"GEOSPATIAL\\",
* \\"index\\": 7
* },
* {
* \\"name\\": \\"STRUCT\\",
* \\"index\\": 8
* },
* {
* \\"name\\": \\"OTHER\\",
* \\"index\\": 100
* }
* ]
* },
* {
* \\"name\\": \\"mode\\",
* \\"type\\": \\"enum\\",
* \\"index\\": 5,
* \\"enumValues\\": [
* {
* \\"name\\": \\"NULLABLE\\",
* \\"index\\": 1
* },
* {
* \\"name\\": \\"REPEATED\\",
* \\"index\\": 2
* },
* {
* \\"name\\": \\"REQUIRED\\",
* \\"index\\": 3
* }
* ]
* },
* {
* \\"name\\": \\"defaultValue\\",
* \\"type\\": \\"string\\",
* \\"index\\": 6
* },
* {
* \\"name\\": \\"annotations\\",
* \\"type\\": \\"map\\",
* \\"index\\": 7,
* \\"mapItems\\": {
* \\"name\\": \\"label\\",
* \\"type\\": \\"string\\"
* }
* },
* {
* \\"name\\": \\"fields\\",
* \\"type\\": \\"array\\",
* \\"index\\": 20,
* \\"arrayItems\\": {
* \\"name\\": \\"field\\",
* \\"type\\": \\"record\\",
* \\"typeRef\\": \\"field\\"
* }
* }
* ]
* }
* }
* ]
* }
* `,
* });
* ```
*
* ## Import
*
* AspectType can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/aspectTypes/{{aspect_type_id}}`
* * `{{project}}/{{location}}/{{aspect_type_id}}`
* * `{{location}}/{{aspect_type_id}}`
*
* When using the `pulumi import` command, AspectType can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:dataplex/aspectType:AspectType default projects/{{project}}/locations/{{location}}/aspectTypes/{{aspect_type_id}}
* $ pulumi import gcp:dataplex/aspectType:AspectType default {{project}}/{{location}}/{{aspect_type_id}}
* $ pulumi import gcp:dataplex/aspectType:AspectType default {{location}}/{{aspect_type_id}}
* ```
*/
class AspectType extends pulumi.CustomResource {
/**
* Get an existing AspectType 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 AspectType(name, state, { ...opts, id: id });
}
/** @internal */
static __pulumiType = 'gcp:dataplex/aspectType:AspectType';
/**
* Returns true if the given object is an instance of AspectType. 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'] === AspectType.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["aspectTypeId"] = state?.aspectTypeId;
resourceInputs["createTime"] = state?.createTime;
resourceInputs["dataClassification"] = state?.dataClassification;
resourceInputs["deletionPolicy"] = state?.deletionPolicy;
resourceInputs["description"] = state?.description;
resourceInputs["displayName"] = state?.displayName;
resourceInputs["effectiveLabels"] = state?.effectiveLabels;
resourceInputs["labels"] = state?.labels;
resourceInputs["location"] = state?.location;
resourceInputs["metadataTemplate"] = state?.metadataTemplate;
resourceInputs["name"] = state?.name;
resourceInputs["project"] = state?.project;
resourceInputs["pulumiLabels"] = state?.pulumiLabels;
resourceInputs["transferStatus"] = state?.transferStatus;
resourceInputs["uid"] = state?.uid;
resourceInputs["updateTime"] = state?.updateTime;
}
else {
const args = argsOrState;
resourceInputs["aspectTypeId"] = args?.aspectTypeId;
resourceInputs["dataClassification"] = args?.dataClassification;
resourceInputs["deletionPolicy"] = args?.deletionPolicy;
resourceInputs["description"] = args?.description;
resourceInputs["displayName"] = args?.displayName;
resourceInputs["labels"] = args?.labels;
resourceInputs["location"] = args?.location;
resourceInputs["metadataTemplate"] = args?.metadataTemplate;
resourceInputs["project"] = args?.project;
resourceInputs["createTime"] = undefined /*out*/;
resourceInputs["effectiveLabels"] = undefined /*out*/;
resourceInputs["name"] = undefined /*out*/;
resourceInputs["pulumiLabels"] = undefined /*out*/;
resourceInputs["transferStatus"] = 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(AspectType.__pulumiType, name, resourceInputs, opts);
}
}
exports.AspectType = AspectType;
//# sourceMappingURL=aspectType.js.map