@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
229 lines • 9.92 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! ***
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.DataProductDataAsset = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("../utilities"));
/**
* A data asset resource that can be packaged and shared via a data product.
*
* > **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider.
* See Provider Versions for more details on beta resources.
*
* To get more information about DataProductDataAsset, see:
*
* * [API documentation](https://cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.dataProducts.dataAssets)
* * How-to Guides
* * [Official Documentation](https://docs.cloud.google.com/dataplex/docs/manage-data-products)
*
* ## Example Usage
*
* ### Dataplex Data Product Data Asset Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example = new gcp.dataplex.DataProduct("example", {
* project: "my-project-name",
* location: "us-central1",
* dataProductId: "tf-test-dp-_55138",
* displayName: "Parent Data Product",
* ownerEmails: ["gterraformtestuser@gmail.com"],
* accessGroups: [{
* id: "analyst",
* groupId: "analyst",
* displayName: "Data Analyst",
* principal: {
* googleGroup: "tf-test-analysts-_37559@example.com",
* },
* }],
* });
* const exampleDataset = new gcp.bigquery.Dataset("example", {
* project: "my-project-name",
* datasetId: "tf_test_dataset__91980",
* location: "us-central1",
* });
* const exampleDataProductDataAsset = new gcp.dataplex.DataProductDataAsset("example", {
* project: "my-project-name",
* location: "us-central1",
* dataProductId: example.dataProductId,
* dataAssetId: "data-product-data-asset",
* resource: pulumi.interpolate`//bigquery.googleapis.com/projects/${exampleDataset.project}/datasets/${exampleDataset.datasetId}`,
* });
* ```
* ### Dataplex Data Product Data Asset Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example = new gcp.dataplex.DataProduct("example", {
* project: "my-project-name",
* location: "us-central1",
* dataProductId: "tf-test-dp-_37118",
* displayName: "Full Example Parent DP",
* ownerEmails: ["gterraformtestuser@gmail.com"],
* accessGroups: [
* {
* id: "analyst",
* groupId: "analyst",
* displayName: "Data Analyst",
* principal: {
* googleGroup: "dataproduct-terraform-examples-3@google.com",
* },
* },
* {
* id: "scientist",
* groupId: "scientist",
* displayName: "Data Scientist",
* principal: {
* googleGroup: "dataproduct-terraform-examples-4@google.com",
* },
* },
* ],
* });
* const exampleDataset = new gcp.bigquery.Dataset("example", {
* project: "my-project-name",
* datasetId: "tf_test_dataset__80332",
* location: "us-central1",
* });
* const exampleDataProductDataAsset = new gcp.dataplex.DataProductDataAsset("example", {
* project: "my-project-name",
* location: "us-central1",
* dataProductId: example.dataProductId,
* dataAssetId: "data-product-data-asset",
* resource: pulumi.interpolate`//bigquery.googleapis.com/projects/${exampleDataset.project}/datasets/${exampleDataset.datasetId}`,
* labels: {
* env: "prod",
* critical: "true",
* },
* accessGroupConfigs: [
* {
* accessGroup: "analyst",
* iamRoles: ["roles/bigquery.dataViewer"],
* },
* {
* accessGroup: "scientist",
* iamRoles: ["roles/bigquery.dataEditor"],
* },
* ],
* });
* ```
*
* ## Import
*
* DataProductDataAsset can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/dataProducts/{{data_product_id}}/dataAssets/{{data_asset_id}}`
* * `{{project}}/{{location}}/{{data_product_id}}/{{data_asset_id}}`
* * `{{location}}/{{data_product_id}}/{{data_asset_id}}`
*
* When using the `pulumi import` command, DataProductDataAsset can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:dataplex/dataProductDataAsset:DataProductDataAsset default projects/{{project}}/locations/{{location}}/dataProducts/{{data_product_id}}/dataAssets/{{data_asset_id}}
* $ pulumi import gcp:dataplex/dataProductDataAsset:DataProductDataAsset default {{project}}/{{location}}/{{data_product_id}}/{{data_asset_id}}
* $ pulumi import gcp:dataplex/dataProductDataAsset:DataProductDataAsset default {{location}}/{{data_product_id}}/{{data_asset_id}}
* ```
*/
class DataProductDataAsset extends pulumi.CustomResource {
/**
* Get an existing DataProductDataAsset 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 DataProductDataAsset(name, state, { ...opts, id: id });
}
/** @internal */
static __pulumiType = 'gcp:dataplex/dataProductDataAsset:DataProductDataAsset';
/**
* Returns true if the given object is an instance of DataProductDataAsset. 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'] === DataProductDataAsset.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["accessGroupConfigs"] = state?.accessGroupConfigs;
resourceInputs["dataAssetId"] = state?.dataAssetId;
resourceInputs["dataProductId"] = state?.dataProductId;
resourceInputs["deletionPolicy"] = state?.deletionPolicy;
resourceInputs["effectiveLabels"] = state?.effectiveLabels;
resourceInputs["labels"] = state?.labels;
resourceInputs["location"] = state?.location;
resourceInputs["project"] = state?.project;
resourceInputs["pulumiLabels"] = state?.pulumiLabels;
resourceInputs["resource"] = state?.resource;
resourceInputs["uid"] = state?.uid;
}
else {
const args = argsOrState;
if (args?.dataAssetId === undefined && !opts.urn) {
throw new Error("Missing required property 'dataAssetId'");
}
if (args?.dataProductId === undefined && !opts.urn) {
throw new Error("Missing required property 'dataProductId'");
}
if (args?.location === undefined && !opts.urn) {
throw new Error("Missing required property 'location'");
}
if (args?.resource === undefined && !opts.urn) {
throw new Error("Missing required property 'resource'");
}
resourceInputs["accessGroupConfigs"] = args?.accessGroupConfigs;
resourceInputs["dataAssetId"] = args?.dataAssetId;
resourceInputs["dataProductId"] = args?.dataProductId;
resourceInputs["deletionPolicy"] = args?.deletionPolicy;
resourceInputs["labels"] = args?.labels;
resourceInputs["location"] = args?.location;
resourceInputs["project"] = args?.project;
resourceInputs["resource"] = args?.resource;
resourceInputs["effectiveLabels"] = undefined /*out*/;
resourceInputs["pulumiLabels"] = undefined /*out*/;
resourceInputs["uid"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const secretOpts = { additionalSecretOutputs: ["effectiveLabels", "pulumiLabels"] };
opts = pulumi.mergeOptions(opts, secretOpts);
super(DataProductDataAsset.__pulumiType, name, resourceInputs, opts);
}
}
exports.DataProductDataAsset = DataProductDataAsset;
//# sourceMappingURL=dataProductDataAsset.js.map