UNPKG

@pulumi/gcp

Version:

A Pulumi package for creating and managing Google Cloud Platform resources.

134 lines 5.8 kB
"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! *** Object.defineProperty(exports, "__esModule", { value: true }); exports.HostProjectRegistration = void 0; const pulumi = require("@pulumi/pulumi"); const utilities = require("../utilities"); /** * Host project registration refers to the registration of a Google cloud project with API hub as a host project. * This is the project where API hub is provisioned. * It acts as the consumer project for the API hub instance provisioned. * Multiple runtime projects can be attached to the host project and these attachments define the scope of API hub. * * ## Example Usage * * ### Apihub Host Project Registration Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * import * as time from "@pulumiverse/time"; * * const project = new gcp.organizations.Project("project", { * name: "apihub-proj", * projectId: "apihub-proj", * orgId: "123456789", * billingAccount: "000000-0000000-0000000-000000", * deletionPolicy: "DELETE", * }); * const wait60Seconds = new time.index.Sleep("wait_60_seconds", {createDuration: "60s"}, { * dependsOn: [project], * }); * // Enable API hub API * const apihubService = new gcp.projects.Service("apihub_service", { * project: project.projectId, * service: "apihub.googleapis.com", * }, { * dependsOn: [wait60Seconds], * }); * const apihubHostProject = new gcp.apihub.HostProjectRegistration("apihub_host_project", { * project: project.projectId, * location: "asia-south1", * hostProjectRegistrationId: project.projectId, * gcpProject: pulumi.interpolate`projects/${project.projectId}`, * }, { * dependsOn: [apihubService], * }); * ``` * * ## Import * * HostProjectRegistration can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/{{location}}/hostProjectRegistrations/{{host_project_registration_id}}` * * * `{{project}}/{{location}}/{{host_project_registration_id}}` * * * `{{location}}/{{host_project_registration_id}}` * * When using the `pulumi import` command, HostProjectRegistration can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:apihub/hostProjectRegistration:HostProjectRegistration default projects/{{project}}/locations/{{location}}/hostProjectRegistrations/{{host_project_registration_id}} * ``` * * ```sh * $ pulumi import gcp:apihub/hostProjectRegistration:HostProjectRegistration default {{project}}/{{location}}/{{host_project_registration_id}} * ``` * * ```sh * $ pulumi import gcp:apihub/hostProjectRegistration:HostProjectRegistration default {{location}}/{{host_project_registration_id}} * ``` */ class HostProjectRegistration extends pulumi.CustomResource { /** * Get an existing HostProjectRegistration 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 HostProjectRegistration(name, state, { ...opts, id: id }); } /** * Returns true if the given object is an instance of HostProjectRegistration. 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'] === HostProjectRegistration.__pulumiType; } constructor(name, argsOrState, opts) { let resourceInputs = {}; opts = opts || {}; if (opts.id) { const state = argsOrState; resourceInputs["createTime"] = state?.createTime; resourceInputs["gcpProject"] = state?.gcpProject; resourceInputs["hostProjectRegistrationId"] = state?.hostProjectRegistrationId; resourceInputs["location"] = state?.location; resourceInputs["name"] = state?.name; resourceInputs["project"] = state?.project; } else { const args = argsOrState; if (args?.gcpProject === undefined && !opts.urn) { throw new Error("Missing required property 'gcpProject'"); } if (args?.hostProjectRegistrationId === undefined && !opts.urn) { throw new Error("Missing required property 'hostProjectRegistrationId'"); } if (args?.location === undefined && !opts.urn) { throw new Error("Missing required property 'location'"); } resourceInputs["gcpProject"] = args?.gcpProject; resourceInputs["hostProjectRegistrationId"] = args?.hostProjectRegistrationId; resourceInputs["location"] = args?.location; resourceInputs["project"] = args?.project; resourceInputs["createTime"] = undefined /*out*/; resourceInputs["name"] = undefined /*out*/; } opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); super(HostProjectRegistration.__pulumiType, name, resourceInputs, opts); } } exports.HostProjectRegistration = HostProjectRegistration; /** @internal */ HostProjectRegistration.__pulumiType = 'gcp:apihub/hostProjectRegistration:HostProjectRegistration'; //# sourceMappingURL=hostProjectRegistration.js.map