@pulumi/digitalocean
Version:
A Pulumi package for creating and managing DigitalOcean cloud resources.
137 lines • 4.83 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.getVolumeOutput = exports.getVolume = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("./utilities"));
/**
* Get information on a volume for use in other resources. This data source provides
* all of the volumes properties as configured on your DigitalOcean account. This is
* useful if the volume in question is not managed by Terraform or you need to utilize
* any of the volumes data.
*
* An error is triggered if the provided volume name does not exist.
*
* ## Example Usage
*
* Get the volume:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const example = digitalocean.getVolume({
* name: "app-data",
* region: "nyc3",
* });
* ```
*
* Reuse the data about a volume to attach it to a Droplet:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const example = digitalocean.getVolume({
* name: "app-data",
* region: "nyc3",
* });
* const exampleDroplet = new digitalocean.Droplet("example", {
* name: "foo",
* size: digitalocean.DropletSlug.DropletS1VCPU1GB,
* image: "ubuntu-18-04-x64",
* region: digitalocean.Region.NYC3,
* });
* const foobar = new digitalocean.VolumeAttachment("foobar", {
* dropletId: exampleDroplet.id.apply(x =>Number(x)),
* volumeId: example.then(example => example.id),
* });
* ```
*/
function getVolume(args, opts) {
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
return pulumi.runtime.invoke("digitalocean:index/getVolume:getVolume", {
"description": args.description,
"name": args.name,
"region": args.region,
}, opts);
}
exports.getVolume = getVolume;
/**
* Get information on a volume for use in other resources. This data source provides
* all of the volumes properties as configured on your DigitalOcean account. This is
* useful if the volume in question is not managed by Terraform or you need to utilize
* any of the volumes data.
*
* An error is triggered if the provided volume name does not exist.
*
* ## Example Usage
*
* Get the volume:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const example = digitalocean.getVolume({
* name: "app-data",
* region: "nyc3",
* });
* ```
*
* Reuse the data about a volume to attach it to a Droplet:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const example = digitalocean.getVolume({
* name: "app-data",
* region: "nyc3",
* });
* const exampleDroplet = new digitalocean.Droplet("example", {
* name: "foo",
* size: digitalocean.DropletSlug.DropletS1VCPU1GB,
* image: "ubuntu-18-04-x64",
* region: digitalocean.Region.NYC3,
* });
* const foobar = new digitalocean.VolumeAttachment("foobar", {
* dropletId: exampleDroplet.id.apply(x =>Number(x)),
* volumeId: example.then(example => example.id),
* });
* ```
*/
function getVolumeOutput(args, opts) {
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
return pulumi.runtime.invokeOutput("digitalocean:index/getVolume:getVolume", {
"description": args.description,
"name": args.name,
"region": args.region,
}, opts);
}
exports.getVolumeOutput = getVolumeOutput;
//# sourceMappingURL=getVolume.js.map