Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Outscale Provider
  3. API Docs
  4. Volume
outscale 1.1.0 published on Thursday, Apr 3, 2025 by outscale
outscale/terraform-provider-outscale

outscale.Volume

Explore with Pulumi AI

outscale 1.1.0 published on Thursday, Apr 3, 2025 by outscale
outscale/terraform-provider-outscale

Manages a volume.

For more information on this resource, see the User Guide.
For more information on this resource actions, see the API documentation.

Example Usage

Creating an io1 volume

import * as pulumi from "@pulumi/pulumi";
import * as outscale from "@pulumi/outscale";

const volume01 = new outscale.Volume("volume01", {
    iops: 100,
    size: 10,
    subregionName: `${_var.region}a`,
    volumeType: "io1",
});
Copy
import pulumi
import pulumi_outscale as outscale

volume01 = outscale.Volume("volume01",
    iops=100,
    size=10,
    subregion_name=f"{var['region']}a",
    volume_type="io1")
Copy
package main

import (
	"fmt"

	"github.com/pulumi/pulumi-terraform-provider/sdks/go/outscale/outscale"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := outscale.NewVolume(ctx, "volume01", &outscale.VolumeArgs{
			Iops:          pulumi.Float64(100),
			Size:          pulumi.Float64(10),
			SubregionName: pulumi.Sprintf("%va", _var.Region),
			VolumeType:    pulumi.String("io1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Outscale = Pulumi.Outscale;

return await Deployment.RunAsync(() => 
{
    var volume01 = new Outscale.Volume("volume01", new()
    {
        Iops = 100,
        Size = 10,
        SubregionName = $"{@var.Region}a",
        VolumeType = "io1",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.outscale.Volume;
import com.pulumi.outscale.VolumeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var volume01 = new Volume("volume01", VolumeArgs.builder()
            .iops(100)
            .size(10)
            .subregionName(String.format("%sa", var_.region()))
            .volumeType("io1")
            .build());

    }
}
Copy
resources:
  volume01:
    type: outscale:Volume
    properties:
      iops: 100
      size: 10
      subregionName: ${var.region}a
      volumeType: io1
Copy

Creating a snapshot before volume deletion

import * as pulumi from "@pulumi/pulumi";
import * as outscale from "@pulumi/outscale";

const volume01 = new outscale.Volume("volume01", {
    size: 40,
    subregionName: `${_var.region}a`,
    terminationSnapshotName: "deleting_volume_snap",
});
Copy
import pulumi
import pulumi_outscale as outscale

volume01 = outscale.Volume("volume01",
    size=40,
    subregion_name=f"{var['region']}a",
    termination_snapshot_name="deleting_volume_snap")
Copy
package main

import (
	"fmt"

	"github.com/pulumi/pulumi-terraform-provider/sdks/go/outscale/outscale"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := outscale.NewVolume(ctx, "volume01", &outscale.VolumeArgs{
			Size:                    pulumi.Float64(40),
			SubregionName:           pulumi.Sprintf("%va", _var.Region),
			TerminationSnapshotName: pulumi.String("deleting_volume_snap"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Outscale = Pulumi.Outscale;

return await Deployment.RunAsync(() => 
{
    var volume01 = new Outscale.Volume("volume01", new()
    {
        Size = 40,
        SubregionName = $"{@var.Region}a",
        TerminationSnapshotName = "deleting_volume_snap",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.outscale.Volume;
import com.pulumi.outscale.VolumeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var volume01 = new Volume("volume01", VolumeArgs.builder()
            .size(40)
            .subregionName(String.format("%sa", var_.region()))
            .terminationSnapshotName("deleting_volume_snap")
            .build());

    }
}
Copy
resources:
  volume01:
    type: outscale:Volume
    properties:
      size: 40
      subregionName: ${var.region}a
      terminationSnapshotName: deleting_volume_snap
Copy

Create Volume Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Volume(name: string, args: VolumeArgs, opts?: CustomResourceOptions);
@overload
def Volume(resource_name: str,
           args: VolumeArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Volume(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           subregion_name: Optional[str] = None,
           iops: Optional[float] = None,
           outscale_volume_id: Optional[str] = None,
           size: Optional[float] = None,
           snapshot_id: Optional[str] = None,
           tags: Optional[Sequence[VolumeTagArgs]] = None,
           termination_snapshot_name: Optional[str] = None,
           volume_type: Optional[str] = None)
func NewVolume(ctx *Context, name string, args VolumeArgs, opts ...ResourceOption) (*Volume, error)
public Volume(string name, VolumeArgs args, CustomResourceOptions? opts = null)
public Volume(String name, VolumeArgs args)
public Volume(String name, VolumeArgs args, CustomResourceOptions options)

type: outscale:Volume
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. VolumeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. VolumeArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. VolumeArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. VolumeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. VolumeArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var volumeResource = new Outscale.Volume("volumeResource", new()
{
    SubregionName = "string",
    Iops = 0,
    OutscaleVolumeId = "string",
    Size = 0,
    SnapshotId = "string",
    Tags = new[]
    {
        new Outscale.Inputs.VolumeTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    TerminationSnapshotName = "string",
    VolumeType = "string",
});
Copy
example, err := outscale.NewVolume(ctx, "volumeResource", &outscale.VolumeArgs{
SubregionName: pulumi.String("string"),
Iops: pulumi.Float64(0),
OutscaleVolumeId: pulumi.String("string"),
Size: pulumi.Float64(0),
SnapshotId: pulumi.String("string"),
Tags: .VolumeTagArray{
&.VolumeTagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
TerminationSnapshotName: pulumi.String("string"),
VolumeType: pulumi.String("string"),
})
Copy
var volumeResource = new Volume("volumeResource", VolumeArgs.builder()
    .subregionName("string")
    .iops(0)
    .outscaleVolumeId("string")
    .size(0)
    .snapshotId("string")
    .tags(VolumeTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .terminationSnapshotName("string")
    .volumeType("string")
    .build());
Copy
volume_resource = outscale.Volume("volumeResource",
    subregion_name="string",
    iops=0,
    outscale_volume_id="string",
    size=0,
    snapshot_id="string",
    tags=[{
        "key": "string",
        "value": "string",
    }],
    termination_snapshot_name="string",
    volume_type="string")
Copy
const volumeResource = new outscale.Volume("volumeResource", {
    subregionName: "string",
    iops: 0,
    outscaleVolumeId: "string",
    size: 0,
    snapshotId: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
    terminationSnapshotName: "string",
    volumeType: "string",
});
Copy
type: outscale:Volume
properties:
    iops: 0
    outscaleVolumeId: string
    size: 0
    snapshotId: string
    subregionName: string
    tags:
        - key: string
          value: string
    terminationSnapshotName: string
    volumeType: string
Copy

Volume Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Volume resource accepts the following input properties:

SubregionName This property is required. string
The Subregion in which you want to create the volume.
Iops double
The number of I/O operations per second (IOPS). This parameter must be specified only if you create an io1 volume. The maximum number of IOPS allowed for io1 volumes is 13000 with a maximum performance ratio of 300 IOPS per gibibyte.
OutscaleVolumeId string
Size double
The size of the volume, in gibibytes (GiB). The maximum allowed size for a volume is 14901 GiB. This parameter is required if the volume is not created from a snapshot (snapshot_id unspecified).
SnapshotId string
The ID of the snapshot from which you want to create the volume.
Tags List<VolumeTag>
A tag to add to this resource. You can specify this argument several times.
TerminationSnapshotName string
Whether you want to create a snapshot before the volume deletion.
VolumeType string
The type of volume you want to create (io1 | gp2 | standard). If not specified, a standard volume is created. For more information about volume types, see About Volumes > Volume Types and IOPS.
SubregionName This property is required. string
The Subregion in which you want to create the volume.
Iops float64
The number of I/O operations per second (IOPS). This parameter must be specified only if you create an io1 volume. The maximum number of IOPS allowed for io1 volumes is 13000 with a maximum performance ratio of 300 IOPS per gibibyte.
OutscaleVolumeId string
Size float64
The size of the volume, in gibibytes (GiB). The maximum allowed size for a volume is 14901 GiB. This parameter is required if the volume is not created from a snapshot (snapshot_id unspecified).
SnapshotId string
The ID of the snapshot from which you want to create the volume.
Tags []VolumeTagArgs
A tag to add to this resource. You can specify this argument several times.
TerminationSnapshotName string
Whether you want to create a snapshot before the volume deletion.
VolumeType string
The type of volume you want to create (io1 | gp2 | standard). If not specified, a standard volume is created. For more information about volume types, see About Volumes > Volume Types and IOPS.
subregionName This property is required. String
The Subregion in which you want to create the volume.
iops Double
The number of I/O operations per second (IOPS). This parameter must be specified only if you create an io1 volume. The maximum number of IOPS allowed for io1 volumes is 13000 with a maximum performance ratio of 300 IOPS per gibibyte.
outscaleVolumeId String
size Double
The size of the volume, in gibibytes (GiB). The maximum allowed size for a volume is 14901 GiB. This parameter is required if the volume is not created from a snapshot (snapshot_id unspecified).
snapshotId String
The ID of the snapshot from which you want to create the volume.
tags List<VolumeTag>
A tag to add to this resource. You can specify this argument several times.
terminationSnapshotName String
Whether you want to create a snapshot before the volume deletion.
volumeType String
The type of volume you want to create (io1 | gp2 | standard). If not specified, a standard volume is created. For more information about volume types, see About Volumes > Volume Types and IOPS.
subregionName This property is required. string
The Subregion in which you want to create the volume.
iops number
The number of I/O operations per second (IOPS). This parameter must be specified only if you create an io1 volume. The maximum number of IOPS allowed for io1 volumes is 13000 with a maximum performance ratio of 300 IOPS per gibibyte.
outscaleVolumeId string
size number
The size of the volume, in gibibytes (GiB). The maximum allowed size for a volume is 14901 GiB. This parameter is required if the volume is not created from a snapshot (snapshot_id unspecified).
snapshotId string
The ID of the snapshot from which you want to create the volume.
tags VolumeTag[]
A tag to add to this resource. You can specify this argument several times.
terminationSnapshotName string
Whether you want to create a snapshot before the volume deletion.
volumeType string
The type of volume you want to create (io1 | gp2 | standard). If not specified, a standard volume is created. For more information about volume types, see About Volumes > Volume Types and IOPS.
subregion_name This property is required. str
The Subregion in which you want to create the volume.
iops float
The number of I/O operations per second (IOPS). This parameter must be specified only if you create an io1 volume. The maximum number of IOPS allowed for io1 volumes is 13000 with a maximum performance ratio of 300 IOPS per gibibyte.
outscale_volume_id str
size float
The size of the volume, in gibibytes (GiB). The maximum allowed size for a volume is 14901 GiB. This parameter is required if the volume is not created from a snapshot (snapshot_id unspecified).
snapshot_id str
The ID of the snapshot from which you want to create the volume.
tags Sequence[VolumeTagArgs]
A tag to add to this resource. You can specify this argument several times.
termination_snapshot_name str
Whether you want to create a snapshot before the volume deletion.
volume_type str
The type of volume you want to create (io1 | gp2 | standard). If not specified, a standard volume is created. For more information about volume types, see About Volumes > Volume Types and IOPS.
subregionName This property is required. String
The Subregion in which you want to create the volume.
iops Number
The number of I/O operations per second (IOPS). This parameter must be specified only if you create an io1 volume. The maximum number of IOPS allowed for io1 volumes is 13000 with a maximum performance ratio of 300 IOPS per gibibyte.
outscaleVolumeId String
size Number
The size of the volume, in gibibytes (GiB). The maximum allowed size for a volume is 14901 GiB. This parameter is required if the volume is not created from a snapshot (snapshot_id unspecified).
snapshotId String
The ID of the snapshot from which you want to create the volume.
tags List<Property Map>
A tag to add to this resource. You can specify this argument several times.
terminationSnapshotName String
Whether you want to create a snapshot before the volume deletion.
volumeType String
The type of volume you want to create (io1 | gp2 | standard). If not specified, a standard volume is created. For more information about volume types, see About Volumes > Volume Types and IOPS.

Outputs

All input properties are implicitly available as output properties. Additionally, the Volume resource produces the following output properties:

CreationDate string
The date and time (UTC) at which the volume was created.
Id string
The provider-assigned unique ID for this managed resource.
LinkedVolumes List<VolumeLinkedVolume>
Information about your volume attachment.
RequestId string
State string
The state of the volume (creating | available | in-use | updating | deleting | error).
VolumeId string
The ID of the volume.
CreationDate string
The date and time (UTC) at which the volume was created.
Id string
The provider-assigned unique ID for this managed resource.
LinkedVolumes []VolumeLinkedVolume
Information about your volume attachment.
RequestId string
State string
The state of the volume (creating | available | in-use | updating | deleting | error).
VolumeId string
The ID of the volume.
creationDate String
The date and time (UTC) at which the volume was created.
id String
The provider-assigned unique ID for this managed resource.
linkedVolumes List<VolumeLinkedVolume>
Information about your volume attachment.
requestId String
state String
The state of the volume (creating | available | in-use | updating | deleting | error).
volumeId String
The ID of the volume.
creationDate string
The date and time (UTC) at which the volume was created.
id string
The provider-assigned unique ID for this managed resource.
linkedVolumes VolumeLinkedVolume[]
Information about your volume attachment.
requestId string
state string
The state of the volume (creating | available | in-use | updating | deleting | error).
volumeId string
The ID of the volume.
creation_date str
The date and time (UTC) at which the volume was created.
id str
The provider-assigned unique ID for this managed resource.
linked_volumes Sequence[VolumeLinkedVolume]
Information about your volume attachment.
request_id str
state str
The state of the volume (creating | available | in-use | updating | deleting | error).
volume_id str
The ID of the volume.
creationDate String
The date and time (UTC) at which the volume was created.
id String
The provider-assigned unique ID for this managed resource.
linkedVolumes List<Property Map>
Information about your volume attachment.
requestId String
state String
The state of the volume (creating | available | in-use | updating | deleting | error).
volumeId String
The ID of the volume.

Look up Existing Volume Resource

Get an existing Volume resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: VolumeState, opts?: CustomResourceOptions): Volume
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        creation_date: Optional[str] = None,
        iops: Optional[float] = None,
        linked_volumes: Optional[Sequence[VolumeLinkedVolumeArgs]] = None,
        outscale_volume_id: Optional[str] = None,
        request_id: Optional[str] = None,
        size: Optional[float] = None,
        snapshot_id: Optional[str] = None,
        state: Optional[str] = None,
        subregion_name: Optional[str] = None,
        tags: Optional[Sequence[VolumeTagArgs]] = None,
        termination_snapshot_name: Optional[str] = None,
        volume_id: Optional[str] = None,
        volume_type: Optional[str] = None) -> Volume
func GetVolume(ctx *Context, name string, id IDInput, state *VolumeState, opts ...ResourceOption) (*Volume, error)
public static Volume Get(string name, Input<string> id, VolumeState? state, CustomResourceOptions? opts = null)
public static Volume get(String name, Output<String> id, VolumeState state, CustomResourceOptions options)
resources:  _:    type: outscale:Volume    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CreationDate string
The date and time (UTC) at which the volume was created.
Iops double
The number of I/O operations per second (IOPS). This parameter must be specified only if you create an io1 volume. The maximum number of IOPS allowed for io1 volumes is 13000 with a maximum performance ratio of 300 IOPS per gibibyte.
LinkedVolumes List<VolumeLinkedVolume>
Information about your volume attachment.
OutscaleVolumeId string
RequestId string
Size double
The size of the volume, in gibibytes (GiB). The maximum allowed size for a volume is 14901 GiB. This parameter is required if the volume is not created from a snapshot (snapshot_id unspecified).
SnapshotId string
The ID of the snapshot from which you want to create the volume.
State string
The state of the volume (creating | available | in-use | updating | deleting | error).
SubregionName string
The Subregion in which you want to create the volume.
Tags List<VolumeTag>
A tag to add to this resource. You can specify this argument several times.
TerminationSnapshotName string
Whether you want to create a snapshot before the volume deletion.
VolumeId string
The ID of the volume.
VolumeType string
The type of volume you want to create (io1 | gp2 | standard). If not specified, a standard volume is created. For more information about volume types, see About Volumes > Volume Types and IOPS.
CreationDate string
The date and time (UTC) at which the volume was created.
Iops float64
The number of I/O operations per second (IOPS). This parameter must be specified only if you create an io1 volume. The maximum number of IOPS allowed for io1 volumes is 13000 with a maximum performance ratio of 300 IOPS per gibibyte.
LinkedVolumes []VolumeLinkedVolumeArgs
Information about your volume attachment.
OutscaleVolumeId string
RequestId string
Size float64
The size of the volume, in gibibytes (GiB). The maximum allowed size for a volume is 14901 GiB. This parameter is required if the volume is not created from a snapshot (snapshot_id unspecified).
SnapshotId string
The ID of the snapshot from which you want to create the volume.
State string
The state of the volume (creating | available | in-use | updating | deleting | error).
SubregionName string
The Subregion in which you want to create the volume.
Tags []VolumeTagArgs
A tag to add to this resource. You can specify this argument several times.
TerminationSnapshotName string
Whether you want to create a snapshot before the volume deletion.
VolumeId string
The ID of the volume.
VolumeType string
The type of volume you want to create (io1 | gp2 | standard). If not specified, a standard volume is created. For more information about volume types, see About Volumes > Volume Types and IOPS.
creationDate String
The date and time (UTC) at which the volume was created.
iops Double
The number of I/O operations per second (IOPS). This parameter must be specified only if you create an io1 volume. The maximum number of IOPS allowed for io1 volumes is 13000 with a maximum performance ratio of 300 IOPS per gibibyte.
linkedVolumes List<VolumeLinkedVolume>
Information about your volume attachment.
outscaleVolumeId String
requestId String
size Double
The size of the volume, in gibibytes (GiB). The maximum allowed size for a volume is 14901 GiB. This parameter is required if the volume is not created from a snapshot (snapshot_id unspecified).
snapshotId String
The ID of the snapshot from which you want to create the volume.
state String
The state of the volume (creating | available | in-use | updating | deleting | error).
subregionName String
The Subregion in which you want to create the volume.
tags List<VolumeTag>
A tag to add to this resource. You can specify this argument several times.
terminationSnapshotName String
Whether you want to create a snapshot before the volume deletion.
volumeId String
The ID of the volume.
volumeType String
The type of volume you want to create (io1 | gp2 | standard). If not specified, a standard volume is created. For more information about volume types, see About Volumes > Volume Types and IOPS.
creationDate string
The date and time (UTC) at which the volume was created.
iops number
The number of I/O operations per second (IOPS). This parameter must be specified only if you create an io1 volume. The maximum number of IOPS allowed for io1 volumes is 13000 with a maximum performance ratio of 300 IOPS per gibibyte.
linkedVolumes VolumeLinkedVolume[]
Information about your volume attachment.
outscaleVolumeId string
requestId string
size number
The size of the volume, in gibibytes (GiB). The maximum allowed size for a volume is 14901 GiB. This parameter is required if the volume is not created from a snapshot (snapshot_id unspecified).
snapshotId string
The ID of the snapshot from which you want to create the volume.
state string
The state of the volume (creating | available | in-use | updating | deleting | error).
subregionName string
The Subregion in which you want to create the volume.
tags VolumeTag[]
A tag to add to this resource. You can specify this argument several times.
terminationSnapshotName string
Whether you want to create a snapshot before the volume deletion.
volumeId string
The ID of the volume.
volumeType string
The type of volume you want to create (io1 | gp2 | standard). If not specified, a standard volume is created. For more information about volume types, see About Volumes > Volume Types and IOPS.
creation_date str
The date and time (UTC) at which the volume was created.
iops float
The number of I/O operations per second (IOPS). This parameter must be specified only if you create an io1 volume. The maximum number of IOPS allowed for io1 volumes is 13000 with a maximum performance ratio of 300 IOPS per gibibyte.
linked_volumes Sequence[VolumeLinkedVolumeArgs]
Information about your volume attachment.
outscale_volume_id str
request_id str
size float
The size of the volume, in gibibytes (GiB). The maximum allowed size for a volume is 14901 GiB. This parameter is required if the volume is not created from a snapshot (snapshot_id unspecified).
snapshot_id str
The ID of the snapshot from which you want to create the volume.
state str
The state of the volume (creating | available | in-use | updating | deleting | error).
subregion_name str
The Subregion in which you want to create the volume.
tags Sequence[VolumeTagArgs]
A tag to add to this resource. You can specify this argument several times.
termination_snapshot_name str
Whether you want to create a snapshot before the volume deletion.
volume_id str
The ID of the volume.
volume_type str
The type of volume you want to create (io1 | gp2 | standard). If not specified, a standard volume is created. For more information about volume types, see About Volumes > Volume Types and IOPS.
creationDate String
The date and time (UTC) at which the volume was created.
iops Number
The number of I/O operations per second (IOPS). This parameter must be specified only if you create an io1 volume. The maximum number of IOPS allowed for io1 volumes is 13000 with a maximum performance ratio of 300 IOPS per gibibyte.
linkedVolumes List<Property Map>
Information about your volume attachment.
outscaleVolumeId String
requestId String
size Number
The size of the volume, in gibibytes (GiB). The maximum allowed size for a volume is 14901 GiB. This parameter is required if the volume is not created from a snapshot (snapshot_id unspecified).
snapshotId String
The ID of the snapshot from which you want to create the volume.
state String
The state of the volume (creating | available | in-use | updating | deleting | error).
subregionName String
The Subregion in which you want to create the volume.
tags List<Property Map>
A tag to add to this resource. You can specify this argument several times.
terminationSnapshotName String
Whether you want to create a snapshot before the volume deletion.
volumeId String
The ID of the volume.
volumeType String
The type of volume you want to create (io1 | gp2 | standard). If not specified, a standard volume is created. For more information about volume types, see About Volumes > Volume Types and IOPS.

Supporting Types

VolumeLinkedVolume
, VolumeLinkedVolumeArgs

DeleteOnVmDeletion This property is required. bool
If true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.
DeviceName This property is required. string
The name of the device.
State This property is required. string
The state of the volume (creating | available | in-use | updating | deleting | error).
VmId This property is required. string
The ID of the VM.
VolumeId This property is required. string
The ID of the volume.
DeleteOnVmDeletion This property is required. bool
If true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.
DeviceName This property is required. string
The name of the device.
State This property is required. string
The state of the volume (creating | available | in-use | updating | deleting | error).
VmId This property is required. string
The ID of the VM.
VolumeId This property is required. string
The ID of the volume.
deleteOnVmDeletion This property is required. Boolean
If true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.
deviceName This property is required. String
The name of the device.
state This property is required. String
The state of the volume (creating | available | in-use | updating | deleting | error).
vmId This property is required. String
The ID of the VM.
volumeId This property is required. String
The ID of the volume.
deleteOnVmDeletion This property is required. boolean
If true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.
deviceName This property is required. string
The name of the device.
state This property is required. string
The state of the volume (creating | available | in-use | updating | deleting | error).
vmId This property is required. string
The ID of the VM.
volumeId This property is required. string
The ID of the volume.
delete_on_vm_deletion This property is required. bool
If true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.
device_name This property is required. str
The name of the device.
state This property is required. str
The state of the volume (creating | available | in-use | updating | deleting | error).
vm_id This property is required. str
The ID of the VM.
volume_id This property is required. str
The ID of the volume.
deleteOnVmDeletion This property is required. Boolean
If true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.
deviceName This property is required. String
The name of the device.
state This property is required. String
The state of the volume (creating | available | in-use | updating | deleting | error).
vmId This property is required. String
The ID of the VM.
volumeId This property is required. String
The ID of the volume.

VolumeTag
, VolumeTagArgs

Key string
The key of the tag, with a minimum of 1 character.
Value string
The value of the tag, between 0 and 255 characters.
Key string
The key of the tag, with a minimum of 1 character.
Value string
The value of the tag, between 0 and 255 characters.
key String
The key of the tag, with a minimum of 1 character.
value String
The value of the tag, between 0 and 255 characters.
key string
The key of the tag, with a minimum of 1 character.
value string
The value of the tag, between 0 and 255 characters.
key str
The key of the tag, with a minimum of 1 character.
value str
The value of the tag, between 0 and 255 characters.
key String
The key of the tag, with a minimum of 1 character.
value String
The value of the tag, between 0 and 255 characters.

Import

A volume can be imported using its ID. For example:

console

$ pulumi import outscale:index/volume:Volume ImportedVolume vol-12345678
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
outscale outscale/terraform-provider-outscale
License
Notes
This Pulumi package is based on the outscale Terraform Provider.
outscale 1.1.0 published on Thursday, Apr 3, 2025 by outscale
outscale/terraform-provider-outscale