@pulumiverse/scaleway/block/snapshot.d.ts

A Pulumi package for creating and managing Scaleway cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * 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
 * ```
 */
export declare 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: string, id: pulumi.Input<pulumi.ID>, state?: SnapshotState, opts?: pulumi.CustomResourceOptions): 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: any): obj is Snapshot;
    /**
     * Use this block to export the volume as a QCOW file to Object Storage.
     */
    readonly export: pulumi.Output<outputs.block.SnapshotExport | undefined>;
    /**
     * Use this block to import a QCOW image from Object Storage to create a volume.
     */
    readonly import: pulumi.Output<outputs.block.SnapshotImport | undefined>;
    /**
     * The name of the snapshot. If not provided, a name will be randomly generated.
     */
    readonly name: pulumi.Output<string>;
    /**
     * ). The ID of the Scaleway Project the snapshot is associated with.
     */
    readonly projectId: pulumi.Output<string>;
    /**
     * A list of tags to apply to the snapshot.
     */
    readonly tags: pulumi.Output<string[] | undefined>;
    /**
     * The ID of the volume to take a snapshot from.
     */
    readonly volumeId: pulumi.Output<string | undefined>;
    /**
     * ). The zone in which the snapshot should be created.
     */
    readonly zone: pulumi.Output<string | undefined>;
    /**
     * Create a Snapshot resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args?: SnapshotArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Snapshot resources.
 */
export interface SnapshotState {
    /**
     * Use this block to export the volume as a QCOW file to Object Storage.
     */
    export?: pulumi.Input<inputs.block.SnapshotExport | undefined>;
    /**
     * Use this block to import a QCOW image from Object Storage to create a volume.
     */
    import?: pulumi.Input<inputs.block.SnapshotImport | undefined>;
    /**
     * The name of the snapshot. If not provided, a name will be randomly generated.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * ). The ID of the Scaleway Project the snapshot is associated with.
     */
    projectId?: pulumi.Input<string | undefined>;
    /**
     * A list of tags to apply to the snapshot.
     */
    tags?: pulumi.Input<pulumi.Input<string>[] | undefined>;
    /**
     * The ID of the volume to take a snapshot from.
     */
    volumeId?: pulumi.Input<string | undefined>;
    /**
     * ). The zone in which the snapshot should be created.
     */
    zone?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a Snapshot resource.
 */
export interface SnapshotArgs {
    /**
     * Use this block to export the volume as a QCOW file to Object Storage.
     */
    export?: pulumi.Input<inputs.block.SnapshotExport | undefined>;
    /**
     * Use this block to import a QCOW image from Object Storage to create a volume.
     */
    import?: pulumi.Input<inputs.block.SnapshotImport | undefined>;
    /**
     * The name of the snapshot. If not provided, a name will be randomly generated.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * ). The ID of the Scaleway Project the snapshot is associated with.
     */
    projectId?: pulumi.Input<string | undefined>;
    /**
     * A list of tags to apply to the snapshot.
     */
    tags?: pulumi.Input<pulumi.Input<string>[] | undefined>;
    /**
     * The ID of the volume to take a snapshot from.
     */
    volumeId?: pulumi.Input<string | undefined>;
    /**
     * ). The zone in which the snapshot should be created.
     */
    zone?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=snapshot.d.ts.map