UNPKG

@pulumiverse/scaleway

Version:

A Pulumi package for creating and managing Scaleway cloud resources.

125 lines 5.5 kB
"use strict"; // *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. *** // *** Do not edit by hand unless you're certain you know what you are doing! *** Object.defineProperty(exports, "__esModule", { value: true }); exports.BlockVolume = void 0; const pulumi = require("@pulumi/pulumi"); const utilities = require("./utilities"); /** * The `scaleway.block.Volume` resource is used to create and manage Scaleway Block Storage volumes. * * Refer to the Block Storage [product documentation](https://www.scaleway.com/en/docs/block-storage/) and [API documentation](https://www.scaleway.com/en/developers/api/block/) for more information. * * ## Example Usage * * ### Create a Block Storage volume * * The following command allows you to create a Block Storage volume of 20 GB with a 5000 [IOPS](https://www.scaleway.com/en/docs/block-storage/concepts/#iops). * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as scaleway from "@pulumiverse/scaleway"; * * const blockVolume = new scaleway.block.Volume("block_volume", { * iops: 5000, * name: "some-volume-name", * sizeInGb: 20, * }); * ``` * * ### With snapshot * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as scaleway from "@pulumiverse/scaleway"; * * const base = new scaleway.block.Volume("base", { * name: "block-volume-base", * iops: 5000, * sizeInGb: 20, * }); * const main = new scaleway.block.Snapshot("main", { * name: "block-volume-from-snapshot", * volumeId: base.id, * }); * const mainVolume = new scaleway.block.Volume("main", { * name: "block-volume-from-snapshot", * iops: 5000, * snapshotId: main.id, * }); * ``` * * ## Import * * This section explains how to import a Block Storage volume using the zoned ID (`{zone}/{id}`) format. * * bash * * ```sh * $ pulumi import scaleway:index/blockVolume:BlockVolume block_volume fr-par-1/11111111-1111-1111-1111-111111111111 * ``` * * @deprecated scaleway.index/blockvolume.BlockVolume has been deprecated in favor of scaleway.block/volume.Volume */ class BlockVolume extends pulumi.CustomResource { /** * Get an existing BlockVolume 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) { pulumi.log.warn("BlockVolume is deprecated: scaleway.index/blockvolume.BlockVolume has been deprecated in favor of scaleway.block/volume.Volume"); return new BlockVolume(name, state, Object.assign(Object.assign({}, opts), { id: id })); } /** * Returns true if the given object is an instance of BlockVolume. 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'] === BlockVolume.__pulumiType; } /** @deprecated scaleway.index/blockvolume.BlockVolume has been deprecated in favor of scaleway.block/volume.Volume */ constructor(name, argsOrState, opts) { pulumi.log.warn("BlockVolume is deprecated: scaleway.index/blockvolume.BlockVolume has been deprecated in favor of scaleway.block/volume.Volume"); let resourceInputs = {}; opts = opts || {}; if (opts.id) { const state = argsOrState; resourceInputs["instanceVolumeId"] = state ? state.instanceVolumeId : undefined; resourceInputs["iops"] = state ? state.iops : undefined; resourceInputs["name"] = state ? state.name : undefined; resourceInputs["projectId"] = state ? state.projectId : undefined; resourceInputs["sizeInGb"] = state ? state.sizeInGb : undefined; resourceInputs["snapshotId"] = state ? state.snapshotId : undefined; resourceInputs["tags"] = state ? state.tags : undefined; resourceInputs["zone"] = state ? state.zone : undefined; } else { const args = argsOrState; if ((!args || args.iops === undefined) && !opts.urn) { throw new Error("Missing required property 'iops'"); } resourceInputs["instanceVolumeId"] = args ? args.instanceVolumeId : undefined; resourceInputs["iops"] = args ? args.iops : undefined; resourceInputs["name"] = args ? args.name : undefined; resourceInputs["projectId"] = args ? args.projectId : undefined; resourceInputs["sizeInGb"] = args ? args.sizeInGb : undefined; resourceInputs["snapshotId"] = args ? args.snapshotId : undefined; resourceInputs["tags"] = args ? args.tags : undefined; resourceInputs["zone"] = args ? args.zone : undefined; } opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); super(BlockVolume.__pulumiType, name, resourceInputs, opts); } } exports.BlockVolume = BlockVolume; /** @internal */ BlockVolume.__pulumiType = 'scaleway:index/blockVolume:BlockVolume'; //# sourceMappingURL=blockVolume.js.map