UNPKG

@pulumiverse/scaleway

Version:

A Pulumi package for creating and managing Scaleway cloud resources.

100 lines 4.65 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.BlockSnapshot = void 0; const pulumi = require("@pulumi/pulumi"); const utilities = require("./utilities"); /** * The `scaleway.block.Snapshot` resource is used to create and manage snapshots of 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 snapshot of a Block Storage volume * * The following command allows you to create a snapshot (`some-snapshot-name`) from a Block Storage volume specified by its ID. * * ```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, * }); * const blockSnapshot = new scaleway.block.Snapshot("block_snapshot", { * name: "some-snapshot-name", * volumeId: blockVolume.id, * }); * ``` * * ## Import * * This section explains how to import the snapshot of a Block Storage volume using the zoned ID format (`{zone}/{id}`). * * bash * * ```sh * $ pulumi import scaleway:index/blockSnapshot:BlockSnapshot main fr-par-1/11111111-1111-1111-1111-111111111111 * ``` * * @deprecated scaleway.index/blocksnapshot.BlockSnapshot has been deprecated in favor of scaleway.block/snapshot.Snapshot */ class BlockSnapshot extends pulumi.CustomResource { /** * Get an existing BlockSnapshot 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("BlockSnapshot is deprecated: scaleway.index/blocksnapshot.BlockSnapshot has been deprecated in favor of scaleway.block/snapshot.Snapshot"); return new BlockSnapshot(name, state, Object.assign(Object.assign({}, opts), { id: id })); } /** * Returns true if the given object is an instance of BlockSnapshot. 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'] === BlockSnapshot.__pulumiType; } /** @deprecated scaleway.index/blocksnapshot.BlockSnapshot has been deprecated in favor of scaleway.block/snapshot.Snapshot */ constructor(name, argsOrState, opts) { pulumi.log.warn("BlockSnapshot is deprecated: scaleway.index/blocksnapshot.BlockSnapshot has been deprecated in favor of scaleway.block/snapshot.Snapshot"); let resourceInputs = {}; opts = opts || {}; if (opts.id) { const state = argsOrState; resourceInputs["import"] = state ? state.import : undefined; resourceInputs["name"] = state ? state.name : undefined; resourceInputs["projectId"] = state ? state.projectId : undefined; resourceInputs["tags"] = state ? state.tags : undefined; resourceInputs["volumeId"] = state ? state.volumeId : undefined; resourceInputs["zone"] = state ? state.zone : undefined; } else { const args = argsOrState; resourceInputs["import"] = args ? args.import : undefined; resourceInputs["name"] = args ? args.name : undefined; resourceInputs["projectId"] = args ? args.projectId : undefined; resourceInputs["tags"] = args ? args.tags : undefined; resourceInputs["volumeId"] = args ? args.volumeId : undefined; resourceInputs["zone"] = args ? args.zone : undefined; } opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); super(BlockSnapshot.__pulumiType, name, resourceInputs, opts); } } exports.BlockSnapshot = BlockSnapshot; /** @internal */ BlockSnapshot.__pulumiType = 'scaleway:index/blockSnapshot:BlockSnapshot'; //# sourceMappingURL=blockSnapshot.js.map