UNPKG

@pulumi/digitalocean

Version:

A Pulumi package for creating and managing DigitalOcean cloud resources.

172 lines 6.42 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! *** 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.Nfs = void 0; const pulumi = __importStar(require("@pulumi/pulumi")); const utilities = __importStar(require("./utilities")); /** * Provides a DigitalOcean NFS share which can be mounted to Droplets to provide shared storage. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as digitalocean from "@pulumi/digitalocean"; * * const example = new digitalocean.Vpc("example", { * name: "example-vpc", * region: "nyc1", * }); * const exampleNfs = new digitalocean.Nfs("example", { * region: "nyc1", * name: "example-nfs", * size: 50, * vpcId: example.id, * performanceTier: "high", * }); * ``` * * ### Moving Share Between VPCs * * To move an NFS share from one VPC to another using the Reassign API: * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as digitalocean from "@pulumi/digitalocean"; * * const source = new digitalocean.Vpc("source", { * name: "source-vpc", * region: "nyc1", * }); * const destination = new digitalocean.Vpc("destination", { * name: "destination-vpc", * region: "nyc1", * }); * const example = new digitalocean.Nfs("example", { * region: "nyc1", * name: "example-nfs", * size: 50, * vpcId: source.id, * performanceTier: "high", * }); * // Attach to source VPC * const sourceNfsAttachment = new digitalocean.NfsAttachment("source", { * shareId: example.id, * vpcId: source.id, * region: "nyc1", * }); * // Reassign to destination VPC - uses the efficient Reassign API * const destinationNfsAttachment = new digitalocean.NfsAttachment("destination", { * shareId: example.id, * vpcId: destination.id, * region: "nyc1", * }, { * dependsOn: [sourceNfsAttachment], * }); * ``` * * ## Notes * * Multiple NFS shares can now be attached to the same VPC, providing greater flexibility for storage management. * * ## Import * * NFS shares can be imported using the `share id` and the `region`, e.g. * * ```sh * $ pulumi import digitalocean:index/nfs:Nfs foobar 506f78a4-e098-11e5-ad9f-000f53306ae1,atl1 * ``` */ class Nfs extends pulumi.CustomResource { /** * Get an existing Nfs 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 Nfs(name, state, { ...opts, id: id }); } /** @internal */ static __pulumiType = 'digitalocean:index/nfs:Nfs'; /** * Returns true if the given object is an instance of Nfs. 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'] === Nfs.__pulumiType; } constructor(name, argsOrState, opts) { let resourceInputs = {}; opts = opts || {}; if (opts.id) { const state = argsOrState; resourceInputs["host"] = state?.host; resourceInputs["mountPath"] = state?.mountPath; resourceInputs["name"] = state?.name; resourceInputs["performanceTier"] = state?.performanceTier; resourceInputs["region"] = state?.region; resourceInputs["size"] = state?.size; resourceInputs["status"] = state?.status; resourceInputs["tags"] = state?.tags; resourceInputs["vpcId"] = state?.vpcId; resourceInputs["vpcIds"] = state?.vpcIds; } else { const args = argsOrState; if (args?.region === undefined && !opts.urn) { throw new Error("Missing required property 'region'"); } if (args?.size === undefined && !opts.urn) { throw new Error("Missing required property 'size'"); } if (args?.vpcId === undefined && !opts.urn) { throw new Error("Missing required property 'vpcId'"); } resourceInputs["name"] = args?.name; resourceInputs["performanceTier"] = args?.performanceTier; resourceInputs["region"] = args?.region; resourceInputs["size"] = args?.size; resourceInputs["tags"] = args?.tags; resourceInputs["vpcId"] = args?.vpcId; resourceInputs["host"] = undefined /*out*/; resourceInputs["mountPath"] = undefined /*out*/; resourceInputs["status"] = undefined /*out*/; resourceInputs["vpcIds"] = undefined /*out*/; } opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); super(Nfs.__pulumiType, name, resourceInputs, opts); } } exports.Nfs = Nfs; //# sourceMappingURL=nfs.js.map