@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
180 lines • 6.8 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Creates and manages Scaleway compute Instance Volumes.
* For more information, see the [API documentation](https://www.scaleway.com/en/developers/api/instance/#path-volumes-list-volumes).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const serverVolume = new scaleway.instance.Volume("server_volume", {
* type: "l_ssd",
* name: "some-volume-name",
* sizeInGb: 20,
* });
* ```
*
* ## Import
*
* volumes can be imported using the `{zone}/{id}`, e.g.
*
* ```sh
* $ pulumi import scaleway:instance/volume:Volume server_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;
/**
* If set, the new volume will be created from this snapshot. Only one of `sizeInGb` and `fromSnapshotId` should be specified.
*/
readonly fromSnapshotId: pulumi.Output<string | undefined>;
/**
* If true, consider that this volume may have been migrated and no longer exists.
*/
readonly migrateToSbs: pulumi.Output<boolean | undefined>;
/**
* The name of the volume. If not provided it will be randomly generated.
*/
readonly name: pulumi.Output<string>;
/**
* The organization ID the volume is associated with.
*/
readonly organizationId: pulumi.Output<string>;
/**
* `projectId`) The ID of the project the volume is associated with.
*/
readonly projectId: pulumi.Output<string>;
/**
* The id of the associated server.
*/
readonly serverId: pulumi.Output<string>;
/**
* The size of the volume. Only one of `sizeInGb` and `fromSnapshotId` should be specified.
*
* > **Important:** It is not possible to resize local and scratch volumes. Updates to this field will recreate the resource.
*/
readonly sizeInGb: pulumi.Output<number | undefined>;
/**
* A list of tags to apply to the volume.
*/
readonly tags: pulumi.Output<string[] | undefined>;
/**
* The type of the volume. The possible values are: `lSsd` (Local SSD), `scratch` (Local Scratch SSD).
*/
readonly type: pulumi.Output<string>;
/**
* `zone`) 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 {
/**
* If set, the new volume will be created from this snapshot. Only one of `sizeInGb` and `fromSnapshotId` should be specified.
*/
fromSnapshotId?: pulumi.Input<string | undefined>;
/**
* If true, consider that this volume may have been migrated and no longer exists.
*/
migrateToSbs?: pulumi.Input<boolean | undefined>;
/**
* The name of the volume. If not provided it will be randomly generated.
*/
name?: pulumi.Input<string | undefined>;
/**
* The organization ID the volume is associated with.
*/
organizationId?: pulumi.Input<string | undefined>;
/**
* `projectId`) The ID of the project the volume is associated with.
*/
projectId?: pulumi.Input<string | undefined>;
/**
* The id of the associated server.
*/
serverId?: pulumi.Input<string | undefined>;
/**
* The size of the volume. Only one of `sizeInGb` and `fromSnapshotId` should be specified.
*
* > **Important:** It is not possible to resize local and scratch volumes. Updates to this field will recreate the resource.
*/
sizeInGb?: pulumi.Input<number | undefined>;
/**
* A list of tags to apply to the volume.
*/
tags?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* The type of the volume. The possible values are: `lSsd` (Local SSD), `scratch` (Local Scratch SSD).
*/
type?: pulumi.Input<string | undefined>;
/**
* `zone`) 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 {
/**
* If set, the new volume will be created from this snapshot. Only one of `sizeInGb` and `fromSnapshotId` should be specified.
*/
fromSnapshotId?: pulumi.Input<string | undefined>;
/**
* If true, consider that this volume may have been migrated and no longer exists.
*/
migrateToSbs?: pulumi.Input<boolean | undefined>;
/**
* The name of the volume. If not provided it will be randomly generated.
*/
name?: pulumi.Input<string | undefined>;
/**
* `projectId`) The ID of the project the volume is associated with.
*/
projectId?: pulumi.Input<string | undefined>;
/**
* The size of the volume. Only one of `sizeInGb` and `fromSnapshotId` should be specified.
*
* > **Important:** It is not possible to resize local and scratch volumes. Updates to this field will recreate the resource.
*/
sizeInGb?: pulumi.Input<number | undefined>;
/**
* A list of tags to apply to the volume.
*/
tags?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* The type of the volume. The possible values are: `lSsd` (Local SSD), `scratch` (Local Scratch SSD).
*/
type: pulumi.Input<string>;
/**
* `zone`) The zone in which the volume should be created.
*/
zone?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=volume.d.ts.map