@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
214 lines • 9.21 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.MetadataFeed = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("../utilities"));
/**
* A Dataplex Metadata Feed monitors Dataplex metadata entries in a specified scope and publishes notifications of changes to a Cloud Pub/Sub topic.
*
* ## Example Usage
*
* ### Dataplex Metadata Feed Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const project = gcp.organizations.getProject({});
* const primary = new gcp.pubsub.Topic("primary", {name: "tf-test-feed-topic"});
* const primaryPublisher = new gcp.pubsub.TopicIAMMember("primary_publisher", {
* topic: primary.name,
* role: "roles/pubsub.publisher",
* member: project.then(project => `serviceAccount:service-${project.number}@gcp-sa-dataplex.iam.gserviceaccount.com`),
* });
* const primaryViewer = new gcp.pubsub.TopicIAMMember("primary_viewer", {
* topic: primary.name,
* role: "roles/pubsub.viewer",
* member: project.then(project => `serviceAccount:service-${project.number}@gcp-sa-dataplex.iam.gserviceaccount.com`),
* }, {
* dependsOn: [primaryPublisher],
* });
* const group = new gcp.dataplex.EntryGroup("group", {
* entryGroupId: "tf-test-feed-group",
* project: "my-project-name",
* location: "us-central1",
* });
* const type = new gcp.dataplex.EntryType("type", {
* entryTypeId: "tf-test-feed-type",
* project: "my-project-name",
* location: "us-central1",
* });
* const aspect = new gcp.dataplex.AspectType("aspect", {
* aspectTypeId: "tf-test-feed-aspect",
* project: "my-project-name",
* location: "us-central1",
* 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
* }
* ]
* }
* ]
* }
* `,
* });
* const primaryMetadataFeed = new gcp.dataplex.MetadataFeed("primary", {
* metadataFeedId: "tf-test-feed",
* location: "us-central1",
* project: "my-project-name",
* pubsubTopic: primary.id,
* labels: {
* foo: "bar",
* },
* filters: {
* aspectTypes: [pulumi.all([project, aspect.aspectTypeId]).apply(([project, aspectTypeId]) => `projects/${project.number}/locations/us-central1/aspectTypes/${aspectTypeId}`)],
* changeTypes: ["CREATE"],
* entryTypes: [pulumi.all([project, type.entryTypeId]).apply(([project, entryTypeId]) => `projects/${project.number}/locations/us-central1/entryTypes/${entryTypeId}`)],
* },
* scope: {
* entryGroups: [pulumi.all([project, group.entryGroupId]).apply(([project, entryGroupId]) => `projects/${project.number}/locations/us-central1/entryGroups/${entryGroupId}`)],
* },
* }, {
* dependsOn: [
* primaryPublisher,
* primaryViewer,
* ],
* });
* ```
*
* ## Import
*
* MetadataFeed can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/metadataFeeds/{{metadata_feed_id}}`
* * `{{project}}/{{location}}/{{metadata_feed_id}}`
* * `{{location}}/{{metadata_feed_id}}`
*
* When using the `pulumi import` command, MetadataFeed can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:dataplex/metadataFeed:MetadataFeed default projects/{{project}}/locations/{{location}}/metadataFeeds/{{metadata_feed_id}}
* $ pulumi import gcp:dataplex/metadataFeed:MetadataFeed default {{project}}/{{location}}/{{metadata_feed_id}}
* $ pulumi import gcp:dataplex/metadataFeed:MetadataFeed default {{location}}/{{metadata_feed_id}}
* ```
*/
class MetadataFeed extends pulumi.CustomResource {
/**
* Get an existing MetadataFeed 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 MetadataFeed(name, state, { ...opts, id: id });
}
/** @internal */
static __pulumiType = 'gcp:dataplex/metadataFeed:MetadataFeed';
/**
* Returns true if the given object is an instance of MetadataFeed. 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'] === MetadataFeed.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["createTime"] = state?.createTime;
resourceInputs["deletionPolicy"] = state?.deletionPolicy;
resourceInputs["effectiveLabels"] = state?.effectiveLabels;
resourceInputs["filters"] = state?.filters;
resourceInputs["labels"] = state?.labels;
resourceInputs["location"] = state?.location;
resourceInputs["metadataFeedId"] = state?.metadataFeedId;
resourceInputs["name"] = state?.name;
resourceInputs["project"] = state?.project;
resourceInputs["pubsubTopic"] = state?.pubsubTopic;
resourceInputs["pulumiLabels"] = state?.pulumiLabels;
resourceInputs["scope"] = state?.scope;
resourceInputs["uid"] = state?.uid;
resourceInputs["updateTime"] = state?.updateTime;
}
else {
const args = argsOrState;
if (args?.location === undefined && !opts.urn) {
throw new Error("Missing required property 'location'");
}
if (args?.metadataFeedId === undefined && !opts.urn) {
throw new Error("Missing required property 'metadataFeedId'");
}
if (args?.scope === undefined && !opts.urn) {
throw new Error("Missing required property 'scope'");
}
resourceInputs["deletionPolicy"] = args?.deletionPolicy;
resourceInputs["filters"] = args?.filters;
resourceInputs["labels"] = args?.labels;
resourceInputs["location"] = args?.location;
resourceInputs["metadataFeedId"] = args?.metadataFeedId;
resourceInputs["project"] = args?.project;
resourceInputs["pubsubTopic"] = args?.pubsubTopic;
resourceInputs["scope"] = args?.scope;
resourceInputs["createTime"] = undefined /*out*/;
resourceInputs["effectiveLabels"] = undefined /*out*/;
resourceInputs["name"] = undefined /*out*/;
resourceInputs["pulumiLabels"] = 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(MetadataFeed.__pulumiType, name, resourceInputs, opts);
}
}
exports.MetadataFeed = MetadataFeed;
//# sourceMappingURL=metadataFeed.js.map