@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
195 lines • 7.6 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.Plugin = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* A plugin resource in the API hub.
*
* ## Example Usage
*
* ### Apihub Plugin Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const apihubPluginFull = new gcp.apihub.Plugin("apihub_plugin_full", {
* location: "us-central1",
* displayName: "Test Plugin",
* description: "Test description",
* pluginId: "plugin-full",
* pluginCategory: "API_GATEWAY",
* actionsConfigs: [{
* id: "sync-metadata",
* displayName: "Sync Metadata",
* description: "Syncs API metadata.",
* triggerMode: "API_HUB_SCHEDULE_TRIGGER",
* }],
* documentation: {
* externalUri: "https://example.com/plugin-documentation",
* },
* hostingService: {
* serviceUri: "https://your-plugin-service.example.com/api",
* },
* configTemplate: {
* authConfigTemplate: {
* supportedAuthTypes: [
* "NO_AUTH",
* "USER_PASSWORD",
* ],
* serviceAccount: {
* serviceAccount: "test@developer.gserviceaccount.com",
* },
* },
* additionalConfigTemplates: [
* {
* id: "string-val",
* description: "API key for the service.",
* valueType: "STRING",
* required: false,
* validationRegex: "^[a-zA-Z0-9]{5,20}$",
* },
* {
* id: "integer-val",
* description: "API key for the service.",
* valueType: "INT",
* required: true,
* validationRegex: "",
* },
* {
* id: "bool-val",
* description: "API key for the service.",
* valueType: "BOOL",
* required: false,
* validationRegex: "",
* },
* {
* id: "enum-val",
* description: "API key for the service.",
* valueType: "ENUM",
* enumOptions: [
* {
* id: "Option1",
* displayName: "Option1",
* description: "Description for Option1",
* },
* {
* id: "Option2",
* displayName: "Option2",
* description: "Description for Option2",
* },
* ],
* required: false,
* validationRegex: "",
* },
* ],
* },
* });
* ```
*
* ## Import
*
* Plugin can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/plugins/{{plugin_id}}`
*
* * `{{project}}/{{location}}/{{plugin_id}}`
*
* * `{{location}}/{{plugin_id}}`
*
* When using the `pulumi import` command, Plugin can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:apihub/plugin:Plugin default projects/{{project}}/locations/{{location}}/plugins/{{plugin_id}}
* ```
*
* ```sh
* $ pulumi import gcp:apihub/plugin:Plugin default {{project}}/{{location}}/{{plugin_id}}
* ```
*
* ```sh
* $ pulumi import gcp:apihub/plugin:Plugin default {{location}}/{{plugin_id}}
* ```
*/
class Plugin extends pulumi.CustomResource {
/**
* Get an existing Plugin 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 Plugin(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of Plugin. 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'] === Plugin.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["actionsConfigs"] = state?.actionsConfigs;
resourceInputs["configTemplate"] = state?.configTemplate;
resourceInputs["createTime"] = state?.createTime;
resourceInputs["description"] = state?.description;
resourceInputs["displayName"] = state?.displayName;
resourceInputs["documentation"] = state?.documentation;
resourceInputs["hostingService"] = state?.hostingService;
resourceInputs["location"] = state?.location;
resourceInputs["name"] = state?.name;
resourceInputs["ownershipType"] = state?.ownershipType;
resourceInputs["pluginCategory"] = state?.pluginCategory;
resourceInputs["pluginId"] = state?.pluginId;
resourceInputs["project"] = state?.project;
resourceInputs["state"] = state?.state;
resourceInputs["updateTime"] = state?.updateTime;
}
else {
const args = argsOrState;
if (args?.displayName === undefined && !opts.urn) {
throw new Error("Missing required property 'displayName'");
}
if (args?.location === undefined && !opts.urn) {
throw new Error("Missing required property 'location'");
}
if (args?.pluginId === undefined && !opts.urn) {
throw new Error("Missing required property 'pluginId'");
}
resourceInputs["actionsConfigs"] = args?.actionsConfigs;
resourceInputs["configTemplate"] = args?.configTemplate;
resourceInputs["description"] = args?.description;
resourceInputs["displayName"] = args?.displayName;
resourceInputs["documentation"] = args?.documentation;
resourceInputs["hostingService"] = args?.hostingService;
resourceInputs["location"] = args?.location;
resourceInputs["pluginCategory"] = args?.pluginCategory;
resourceInputs["pluginId"] = args?.pluginId;
resourceInputs["project"] = args?.project;
resourceInputs["createTime"] = undefined /*out*/;
resourceInputs["name"] = undefined /*out*/;
resourceInputs["ownershipType"] = undefined /*out*/;
resourceInputs["state"] = undefined /*out*/;
resourceInputs["updateTime"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(Plugin.__pulumiType, name, resourceInputs, opts);
}
}
exports.Plugin = Plugin;
/** @internal */
Plugin.__pulumiType = 'gcp:apihub/plugin:Plugin';
//# sourceMappingURL=plugin.js.map