@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
185 lines • 6.43 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* 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.
*
* ```sh
* $ pulumi import scaleway:block/volume:Volume block_volume fr-par-1/11111111-1111-1111-1111-111111111111
* ```
*/
export declare class Volume extends pulumi.CustomResource {
/**
* Get an existing Volume 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?: VolumeState, opts?: pulumi.CustomResourceOptions): Volume;
/**
* Returns true if the given object is an instance of Volume. 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 Volume;
/**
* The instance volume to create the block volume from
*/
readonly instanceVolumeId: pulumi.Output<string>;
/**
* The maximum [IOPs](https://www.scaleway.com/en/docs/block-storage/concepts/#iops) expected, must match available options.
*/
readonly iops: pulumi.Output<number>;
/**
* The name of the volume. If not provided, a name will be randomly generated.
*/
readonly name: pulumi.Output<string>;
/**
* ). The ID of the Project the volume is associated with.
*/
readonly projectId: pulumi.Output<string>;
/**
* The size of the volume in gigabytes.
*/
readonly sizeInGb: pulumi.Output<number>;
/**
* If set, the new volume will be created from this snapshot.
*/
readonly snapshotId: pulumi.Output<string | undefined>;
/**
* A list of tags to apply to the volume.
*/
readonly tags: pulumi.Output<string[] | undefined>;
/**
* ). The zone in which the volume should be created.
*/
readonly zone: pulumi.Output<string | undefined>;
/**
* Create a Volume 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: VolumeArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Volume resources.
*/
export interface VolumeState {
/**
* The instance volume to create the block volume from
*/
instanceVolumeId?: pulumi.Input<string | undefined>;
/**
* The maximum [IOPs](https://www.scaleway.com/en/docs/block-storage/concepts/#iops) expected, must match available options.
*/
iops?: pulumi.Input<number | undefined>;
/**
* The name of the volume. If not provided, a name will be randomly generated.
*/
name?: pulumi.Input<string | undefined>;
/**
* ). The ID of the Project the volume is associated with.
*/
projectId?: pulumi.Input<string | undefined>;
/**
* The size of the volume in gigabytes.
*/
sizeInGb?: pulumi.Input<number | undefined>;
/**
* If set, the new volume will be created from this snapshot.
*/
snapshotId?: pulumi.Input<string | undefined>;
/**
* A list of tags to apply to the volume.
*/
tags?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* ). The zone in which the volume should be created.
*/
zone?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a Volume resource.
*/
export interface VolumeArgs {
/**
* The instance volume to create the block volume from
*/
instanceVolumeId?: pulumi.Input<string | undefined>;
/**
* The maximum [IOPs](https://www.scaleway.com/en/docs/block-storage/concepts/#iops) expected, must match available options.
*/
iops: pulumi.Input<number>;
/**
* The name of the volume. If not provided, a name will be randomly generated.
*/
name?: pulumi.Input<string | undefined>;
/**
* ). The ID of the Project the volume is associated with.
*/
projectId?: pulumi.Input<string | undefined>;
/**
* The size of the volume in gigabytes.
*/
sizeInGb?: pulumi.Input<number | undefined>;
/**
* If set, the new volume will be created from this snapshot.
*/
snapshotId?: pulumi.Input<string | undefined>;
/**
* A list of tags to apply to the volume.
*/
tags?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* ). The zone in which the volume should be created.
*/
zone?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=volume.d.ts.map