@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
163 lines • 6.41 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.Snapshot = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(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,
* });
* ```
*
* ### How to import from Object Storage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const my_import_bucket = new scaleway.object.Bucket("my-import-bucket", {name: "snapshot-bucket-to-import"});
* const qcow_object = new scaleway.object.Item("qcow-object", {
* bucket: snapshot_bucket.name,
* key: "my-snapshot.qcow2",
* file: "imported-snapshot/snapshot.qcow2",
* });
* const imported = new scaleway.block.Volume("imported", {
* iops: 5000,
* name: "imported-from-qcow",
* "import": [{
* bucket: "my-import-bucket",
* key: "imported-snapshot/snapshot.qcow2",
* }],
* });
* ```
*
* ### How to export to Object Storage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const my_import_bucket = new scaleway.object.Bucket("my-import-bucket", {name: "snapshot-bucket-to-import"});
* const qcow_object = new scaleway.object.Item("qcow-object", {
* bucket: snapshot_bucket.name,
* key: "export/my-snapshot.qcow2",
* });
* const toExport = new scaleway.block.Volume("to_export", {
* iops: 5000,
* name: "to-export",
* "export": [{
* bucket: "snapshot-bucket-to-import",
* key: "exports/my-snapshot.qcow2",
* }],
* });
* ```
*
* ## Import
*
* This section explains how to import the snapshot of a Block Storage volume using the zoned ID format (`{zone}/{id}`).
*
* ```sh
* $ pulumi import scaleway:block/snapshot:Snapshot main fr-par-1/11111111-1111-1111-1111-111111111111
* ```
*/
class Snapshot extends pulumi.CustomResource {
/**
* Get an existing Snapshot 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 Snapshot(name, state, { ...opts, id: id });
}
/** @internal */
static __pulumiType = 'scaleway:block/snapshot:Snapshot';
/**
* Returns true if the given object is an instance of Snapshot. 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'] === Snapshot.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["export"] = state?.export;
resourceInputs["import"] = state?.import;
resourceInputs["name"] = state?.name;
resourceInputs["projectId"] = state?.projectId;
resourceInputs["tags"] = state?.tags;
resourceInputs["volumeId"] = state?.volumeId;
resourceInputs["zone"] = state?.zone;
}
else {
const args = argsOrState;
resourceInputs["export"] = args?.export;
resourceInputs["import"] = args?.import;
resourceInputs["name"] = args?.name;
resourceInputs["projectId"] = args?.projectId;
resourceInputs["tags"] = args?.tags;
resourceInputs["volumeId"] = args?.volumeId;
resourceInputs["zone"] = args?.zone;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const aliasOpts = { aliases: [{ type: "scaleway:index/blockSnapshot:BlockSnapshot" }] };
opts = pulumi.mergeOptions(opts, aliasOpts);
super(Snapshot.__pulumiType, name, resourceInputs, opts);
}
}
exports.Snapshot = Snapshot;
//# sourceMappingURL=snapshot.js.map