Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. IsVolume
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.IsVolume

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Create, update, or delete a VPC block storage volume. For more information, about the VPC block storage volume, see getting started with VPC.

    NOTE: VPC infrastructure services are a regional specific based endpoint, by default targets to us-south. Please make sure to target right region in the provider block as shown in the provider.tf file, if VPC service is created in region other than us-south.

    provider.tf

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

    import pulumi

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
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) {
    }
}

    {}

    Example Usage

    The following example creates a volume with 10 IOPs tier.

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

const example = new ibm.IsVolume("example", {
    profile: "10iops-tier",
    zone: "us-south-1",
});

    import pulumi
import pulumi_ibm as ibm

example = ibm.IsVolume("example",
    profile="10iops-tier",
    zone="us-south-1")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewIsVolume(ctx, "example", &ibm.IsVolumeArgs{
			Profile: pulumi.String("10iops-tier"),
			Zone:    pulumi.String("us-south-1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var example = new Ibm.IsVolume("example", new()
    {
        Profile = "10iops-tier",
        Zone = "us-south-1",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IsVolume;
import com.pulumi.ibm.IsVolumeArgs;
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 example = new IsVolume("example", IsVolumeArgs.builder()
            .profile("10iops-tier")
            .zone("us-south-1")
            .build());

    }
}

    resources:
  example:
    type: ibm:IsVolume
    properties:
      profile: 10iops-tier
      zone: us-south-1

    The following example creates a custom volume.

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

const example = new ibm.IsVolume("example", {
    capacity: 200,
    encryptionKey: "crn:v1:bluemix:public:kms:us-south:a/dffc98a0f1f0f95f6613b3b752286b87:e4a29d1a-2ef0-42a6-8fd2-350deb1c647e:key:5437653b-c4b1-447f-9646-b2a2a4cd6179",
    iops: 1000,
    profile: "custom",
    zone: "us-south-1",
});

    import pulumi
import pulumi_ibm as ibm

example = ibm.IsVolume("example",
    capacity=200,
    encryption_key="crn:v1:bluemix:public:kms:us-south:a/dffc98a0f1f0f95f6613b3b752286b87:e4a29d1a-2ef0-42a6-8fd2-350deb1c647e:key:5437653b-c4b1-447f-9646-b2a2a4cd6179",
    iops=1000,
    profile="custom",
    zone="us-south-1")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewIsVolume(ctx, "example", &ibm.IsVolumeArgs{
			Capacity:      pulumi.Float64(200),
			EncryptionKey: pulumi.String("crn:v1:bluemix:public:kms:us-south:a/dffc98a0f1f0f95f6613b3b752286b87:e4a29d1a-2ef0-42a6-8fd2-350deb1c647e:key:5437653b-c4b1-447f-9646-b2a2a4cd6179"),
			Iops:          pulumi.Float64(1000),
			Profile:       pulumi.String("custom"),
			Zone:          pulumi.String("us-south-1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var example = new Ibm.IsVolume("example", new()
    {
        Capacity = 200,
        EncryptionKey = "crn:v1:bluemix:public:kms:us-south:a/dffc98a0f1f0f95f6613b3b752286b87:e4a29d1a-2ef0-42a6-8fd2-350deb1c647e:key:5437653b-c4b1-447f-9646-b2a2a4cd6179",
        Iops = 1000,
        Profile = "custom",
        Zone = "us-south-1",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IsVolume;
import com.pulumi.ibm.IsVolumeArgs;
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 example = new IsVolume("example", IsVolumeArgs.builder()
            .capacity(200)
            .encryptionKey("crn:v1:bluemix:public:kms:us-south:a/dffc98a0f1f0f95f6613b3b752286b87:e4a29d1a-2ef0-42a6-8fd2-350deb1c647e:key:5437653b-c4b1-447f-9646-b2a2a4cd6179")
            .iops(1000)
            .profile("custom")
            .zone("us-south-1")
            .build());

    }
}

    resources:
  example:
    type: ibm:IsVolume
    properties:
      capacity: 200
      encryptionKey: crn:v1:bluemix:public:kms:us-south:a/dffc98a0f1f0f95f6613b3b752286b87:e4a29d1a-2ef0-42a6-8fd2-350deb1c647e:key:5437653b-c4b1-447f-9646-b2a2a4cd6179
      iops: 1000
      profile: custom
      zone: us-south-1

    The following example creates a volume from snapshot.

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

const storage = new ibm.IsVolume("storage", {
    profile: "general-purpose",
    zone: "us-south-1",
    sourceSnapshot: ibm_is_snapshot.example.id,
});

    import pulumi
import pulumi_ibm as ibm

storage = ibm.IsVolume("storage",
    profile="general-purpose",
    zone="us-south-1",
    source_snapshot=ibm_is_snapshot["example"]["id"])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewIsVolume(ctx, "storage", &ibm.IsVolumeArgs{
			Profile:        pulumi.String("general-purpose"),
			Zone:           pulumi.String("us-south-1"),
			SourceSnapshot: pulumi.Any(ibm_is_snapshot.Example.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var storage = new Ibm.IsVolume("storage", new()
    {
        Profile = "general-purpose",
        Zone = "us-south-1",
        SourceSnapshot = ibm_is_snapshot.Example.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IsVolume;
import com.pulumi.ibm.IsVolumeArgs;
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 storage = new IsVolume("storage", IsVolumeArgs.builder()
            .profile("general-purpose")
            .zone("us-south-1")
            .sourceSnapshot(ibm_is_snapshot.example().id())
            .build());

    }
}

    resources:
  storage:
    type: ibm:IsVolume
    properties:
      profile: general-purpose
      zone: us-south-1
      sourceSnapshot: ${ibm_is_snapshot.example.id}

    Create IsVolume Resource

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

    Constructor syntax

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

@overload
def IsVolume(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             profile: Optional[str] = None,
             zone: Optional[str] = None,
             is_volume_id: Optional[str] = None,
             delete_all_snapshots: Optional[bool] = None,
             encryption_key: Optional[str] = None,
             iops: Optional[float] = None,
             access_tags: Optional[Sequence[str]] = None,
             name: Optional[str] = None,
             capacity: Optional[float] = None,
             resource_group: Optional[str] = None,
             source_snapshot: Optional[str] = None,
             source_snapshot_crn: Optional[str] = None,
             tags: Optional[Sequence[str]] = None,
             timeouts: Optional[IsVolumeTimeoutsArgs] = None,
             bandwidth: Optional[float] = None)
    func NewIsVolume(ctx *Context, name string, args IsVolumeArgs, opts ...ResourceOption) (*IsVolume, error)
    public IsVolume(string name, IsVolumeArgs args, CustomResourceOptions? opts = null)
    public IsVolume(String name, IsVolumeArgs args)
public IsVolume(String name, IsVolumeArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args IsVolumeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args IsVolumeArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args IsVolumeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IsVolumeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IsVolumeArgs
    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 isVolumeResource = new Ibm.IsVolume("isVolumeResource", new()
{
    Profile = "string",
    Zone = "string",
    IsVolumeId = "string",
    DeleteAllSnapshots = false,
    EncryptionKey = "string",
    Iops = 0,
    AccessTags = new[]
    {
        "string",
    },
    Name = "string",
    Capacity = 0,
    ResourceGroup = "string",
    SourceSnapshot = "string",
    SourceSnapshotCrn = "string",
    Tags = new[]
    {
        "string",
    },
    Timeouts = new Ibm.Inputs.IsVolumeTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
    Bandwidth = 0,
});

    example, err := ibm.NewIsVolume(ctx, "isVolumeResource", &ibm.IsVolumeArgs{
	Profile:            pulumi.String("string"),
	Zone:               pulumi.String("string"),
	IsVolumeId:         pulumi.String("string"),
	DeleteAllSnapshots: pulumi.Bool(false),
	EncryptionKey:      pulumi.String("string"),
	Iops:               pulumi.Float64(0),
	AccessTags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:              pulumi.String("string"),
	Capacity:          pulumi.Float64(0),
	ResourceGroup:     pulumi.String("string"),
	SourceSnapshot:    pulumi.String("string"),
	SourceSnapshotCrn: pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Timeouts: &ibm.IsVolumeTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
	},
	Bandwidth: pulumi.Float64(0),
})

    var isVolumeResource = new IsVolume("isVolumeResource", IsVolumeArgs.builder()
    .profile("string")
    .zone("string")
    .isVolumeId("string")
    .deleteAllSnapshots(false)
    .encryptionKey("string")
    .iops(0)
    .accessTags("string")
    .name("string")
    .capacity(0)
    .resourceGroup("string")
    .sourceSnapshot("string")
    .sourceSnapshotCrn("string")
    .tags("string")
    .timeouts(IsVolumeTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .bandwidth(0)
    .build());

    is_volume_resource = ibm.IsVolume("isVolumeResource",
    profile="string",
    zone="string",
    is_volume_id="string",
    delete_all_snapshots=False,
    encryption_key="string",
    iops=0,
    access_tags=["string"],
    name="string",
    capacity=0,
    resource_group="string",
    source_snapshot="string",
    source_snapshot_crn="string",
    tags=["string"],
    timeouts={
        "create": "string",
        "delete": "string",
    },
    bandwidth=0)

    const isVolumeResource = new ibm.IsVolume("isVolumeResource", {
    profile: "string",
    zone: "string",
    isVolumeId: "string",
    deleteAllSnapshots: false,
    encryptionKey: "string",
    iops: 0,
    accessTags: ["string"],
    name: "string",
    capacity: 0,
    resourceGroup: "string",
    sourceSnapshot: "string",
    sourceSnapshotCrn: "string",
    tags: ["string"],
    timeouts: {
        create: "string",
        "delete": "string",
    },
    bandwidth: 0,
});

    type: ibm:IsVolume
properties:
    accessTags:
        - string
    bandwidth: 0
    capacity: 0
    deleteAllSnapshots: false
    encryptionKey: string
    iops: 0
    isVolumeId: string
    name: string
    profile: string
    resourceGroup: string
    sourceSnapshot: string
    sourceSnapshotCrn: string
    tags:
        - string
    timeouts:
        create: string
        delete: string
    zone: string

    IsVolume 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 IsVolume resource accepts the following input properties:

    Profile string

    The profile to use for this volume.

    NOTE: tiered profiles [general-purpose, 5iops-tier, 10iops-tier] can be upgraded and downgraded into each other if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume.

    Zone string
    The location of the volume.
    AccessTags List<string>

    A list of access management tags to attach to the bare metal server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    Bandwidth double
    The maximum bandwidth (in megabits per second) for the volume
    Capacity double

    (The capacity of the volume in gigabytes. This defaults to 100, minimum to 10 and maximum to 16000.

    NOTE: Supports only expansion on update (must be attached to a running instance and must not be less than the current volume capacity). Can be updated only if volume is attached to an running virtual server instance. Stopped instance will be started on update of capacity of the volume.If source_snapshot is provided capacity must be at least the snapshot's minimum_capacity. The maximum value may increase in the future and If unspecified, the capacity will be the source snapshot's minimum_capacity.

    DeleteAllSnapshots bool
    Deletes all snapshots created from this volume.
    EncryptionKey string
    The key to use for encrypting this volume.
    Iops double

    The total input/ output operations per second (IOPS) for your storage. This value is required for custom storage profiles only.

    NOTE: iops value can be upgraded and downgraged if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume.

    This table shows how storage size affects the iops ranges:

    | Size range (GB) | IOPS range | |--------------------|----------------| | 10 - 39 | 100 - 1000 | | 40 - 79 | 100 - 2000 | | 80 - 99 | 100 - 4000 | | 100 - 499 | 100 - 6000 | | 500 - 999 | 100 - 10000 | | 1000 - 1999 | 100 - 20000 | | 2000 - 3999 | 100 - 40000 | | 4000 - 1999 | 100 - 40000 | | 8000 - 1999 | 100 - 48000 | | 10000 - 16000 | 100 - 48000 |

    IsVolumeId string
    (String) The unique identifier of the volume.
    Name string
    The user-defined name for this volume.No.
    ResourceGroup string
    The resource group ID for this volume.
    SourceSnapshot string
    The ID of snapshot from which to clone the volume.
    SourceSnapshotCrn string
    The CRN of snapshot from which to clone the volume.
    Tags List<string>
    A list of user tags that you want to add to your volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
    Timeouts IsVolumeTimeouts
    Profile string

    The profile to use for this volume.

    NOTE: tiered profiles [general-purpose, 5iops-tier, 10iops-tier] can be upgraded and downgraded into each other if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume.

    Zone string
    The location of the volume.
    AccessTags []string

    A list of access management tags to attach to the bare metal server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    Bandwidth float64
    The maximum bandwidth (in megabits per second) for the volume
    Capacity float64

    (The capacity of the volume in gigabytes. This defaults to 100, minimum to 10 and maximum to 16000.

    NOTE: Supports only expansion on update (must be attached to a running instance and must not be less than the current volume capacity). Can be updated only if volume is attached to an running virtual server instance. Stopped instance will be started on update of capacity of the volume.If source_snapshot is provided capacity must be at least the snapshot's minimum_capacity. The maximum value may increase in the future and If unspecified, the capacity will be the source snapshot's minimum_capacity.

    DeleteAllSnapshots bool
    Deletes all snapshots created from this volume.
    EncryptionKey string
    The key to use for encrypting this volume.
    Iops float64

    The total input/ output operations per second (IOPS) for your storage. This value is required for custom storage profiles only.

    NOTE: iops value can be upgraded and downgraged if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume.

    This table shows how storage size affects the iops ranges:

    | Size range (GB) | IOPS range | |--------------------|----------------| | 10 - 39 | 100 - 1000 | | 40 - 79 | 100 - 2000 | | 80 - 99 | 100 - 4000 | | 100 - 499 | 100 - 6000 | | 500 - 999 | 100 - 10000 | | 1000 - 1999 | 100 - 20000 | | 2000 - 3999 | 100 - 40000 | | 4000 - 1999 | 100 - 40000 | | 8000 - 1999 | 100 - 48000 | | 10000 - 16000 | 100 - 48000 |

    IsVolumeId string
    (String) The unique identifier of the volume.
    Name string
    The user-defined name for this volume.No.
    ResourceGroup string
    The resource group ID for this volume.
    SourceSnapshot string
    The ID of snapshot from which to clone the volume.
    SourceSnapshotCrn string
    The CRN of snapshot from which to clone the volume.
    Tags []string
    A list of user tags that you want to add to your volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
    Timeouts IsVolumeTimeoutsArgs
    profile String

    The profile to use for this volume.

    NOTE: tiered profiles [general-purpose, 5iops-tier, 10iops-tier] can be upgraded and downgraded into each other if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume.

    zone String
    The location of the volume.
    accessTags List<String>

    A list of access management tags to attach to the bare metal server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    bandwidth Double
    The maximum bandwidth (in megabits per second) for the volume
    capacity Double

    (The capacity of the volume in gigabytes. This defaults to 100, minimum to 10 and maximum to 16000.

    NOTE: Supports only expansion on update (must be attached to a running instance and must not be less than the current volume capacity). Can be updated only if volume is attached to an running virtual server instance. Stopped instance will be started on update of capacity of the volume.If source_snapshot is provided capacity must be at least the snapshot's minimum_capacity. The maximum value may increase in the future and If unspecified, the capacity will be the source snapshot's minimum_capacity.

    deleteAllSnapshots Boolean
    Deletes all snapshots created from this volume.
    encryptionKey String
    The key to use for encrypting this volume.
    iops Double

    The total input/ output operations per second (IOPS) for your storage. This value is required for custom storage profiles only.

    NOTE: iops value can be upgraded and downgraged if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume.

    This table shows how storage size affects the iops ranges:

    | Size range (GB) | IOPS range | |--------------------|----------------| | 10 - 39 | 100 - 1000 | | 40 - 79 | 100 - 2000 | | 80 - 99 | 100 - 4000 | | 100 - 499 | 100 - 6000 | | 500 - 999 | 100 - 10000 | | 1000 - 1999 | 100 - 20000 | | 2000 - 3999 | 100 - 40000 | | 4000 - 1999 | 100 - 40000 | | 8000 - 1999 | 100 - 48000 | | 10000 - 16000 | 100 - 48000 |

    isVolumeId String
    (String) The unique identifier of the volume.
    name String
    The user-defined name for this volume.No.
    resourceGroup String
    The resource group ID for this volume.
    sourceSnapshot String
    The ID of snapshot from which to clone the volume.
    sourceSnapshotCrn String
    The CRN of snapshot from which to clone the volume.
    tags List<String>
    A list of user tags that you want to add to your volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
    timeouts IsVolumeTimeouts
    profile string

    The profile to use for this volume.

    NOTE: tiered profiles [general-purpose, 5iops-tier, 10iops-tier] can be upgraded and downgraded into each other if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume.

    zone string
    The location of the volume.
    accessTags string[]

    A list of access management tags to attach to the bare metal server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    bandwidth number
    The maximum bandwidth (in megabits per second) for the volume
    capacity number

    (The capacity of the volume in gigabytes. This defaults to 100, minimum to 10 and maximum to 16000.

    NOTE: Supports only expansion on update (must be attached to a running instance and must not be less than the current volume capacity). Can be updated only if volume is attached to an running virtual server instance. Stopped instance will be started on update of capacity of the volume.If source_snapshot is provided capacity must be at least the snapshot's minimum_capacity. The maximum value may increase in the future and If unspecified, the capacity will be the source snapshot's minimum_capacity.

    deleteAllSnapshots boolean
    Deletes all snapshots created from this volume.
    encryptionKey string
    The key to use for encrypting this volume.
    iops number

    The total input/ output operations per second (IOPS) for your storage. This value is required for custom storage profiles only.

    NOTE: iops value can be upgraded and downgraged if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume.

    This table shows how storage size affects the iops ranges:

    | Size range (GB) | IOPS range | |--------------------|----------------| | 10 - 39 | 100 - 1000 | | 40 - 79 | 100 - 2000 | | 80 - 99 | 100 - 4000 | | 100 - 499 | 100 - 6000 | | 500 - 999 | 100 - 10000 | | 1000 - 1999 | 100 - 20000 | | 2000 - 3999 | 100 - 40000 | | 4000 - 1999 | 100 - 40000 | | 8000 - 1999 | 100 - 48000 | | 10000 - 16000 | 100 - 48000 |

    isVolumeId string
    (String) The unique identifier of the volume.
    name string
    The user-defined name for this volume.No.
    resourceGroup string
    The resource group ID for this volume.
    sourceSnapshot string
    The ID of snapshot from which to clone the volume.
    sourceSnapshotCrn string
    The CRN of snapshot from which to clone the volume.
    tags string[]
    A list of user tags that you want to add to your volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
    timeouts IsVolumeTimeouts
    profile str

    The profile to use for this volume.

    NOTE: tiered profiles [general-purpose, 5iops-tier, 10iops-tier] can be upgraded and downgraded into each other if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume.

    zone str
    The location of the volume.
    access_tags Sequence[str]

    A list of access management tags to attach to the bare metal server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    bandwidth float
    The maximum bandwidth (in megabits per second) for the volume
    capacity float

    (The capacity of the volume in gigabytes. This defaults to 100, minimum to 10 and maximum to 16000.

    NOTE: Supports only expansion on update (must be attached to a running instance and must not be less than the current volume capacity). Can be updated only if volume is attached to an running virtual server instance. Stopped instance will be started on update of capacity of the volume.If source_snapshot is provided capacity must be at least the snapshot's minimum_capacity. The maximum value may increase in the future and If unspecified, the capacity will be the source snapshot's minimum_capacity.

    delete_all_snapshots bool
    Deletes all snapshots created from this volume.
    encryption_key str
    The key to use for encrypting this volume.
    iops float

    The total input/ output operations per second (IOPS) for your storage. This value is required for custom storage profiles only.

    NOTE: iops value can be upgraded and downgraged if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume.

    This table shows how storage size affects the iops ranges:

    | Size range (GB) | IOPS range | |--------------------|----------------| | 10 - 39 | 100 - 1000 | | 40 - 79 | 100 - 2000 | | 80 - 99 | 100 - 4000 | | 100 - 499 | 100 - 6000 | | 500 - 999 | 100 - 10000 | | 1000 - 1999 | 100 - 20000 | | 2000 - 3999 | 100 - 40000 | | 4000 - 1999 | 100 - 40000 | | 8000 - 1999 | 100 - 48000 | | 10000 - 16000 | 100 - 48000 |

    is_volume_id str
    (String) The unique identifier of the volume.
    name str
    The user-defined name for this volume.No.
    resource_group str
    The resource group ID for this volume.
    source_snapshot str
    The ID of snapshot from which to clone the volume.
    source_snapshot_crn str
    The CRN of snapshot from which to clone the volume.
    tags Sequence[str]
    A list of user tags that you want to add to your volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
    timeouts IsVolumeTimeoutsArgs
    profile String

    The profile to use for this volume.

    NOTE: tiered profiles [general-purpose, 5iops-tier, 10iops-tier] can be upgraded and downgraded into each other if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume.

    zone String
    The location of the volume.
    accessTags List<String>

    A list of access management tags to attach to the bare metal server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    bandwidth Number
    The maximum bandwidth (in megabits per second) for the volume
    capacity Number

    (The capacity of the volume in gigabytes. This defaults to 100, minimum to 10 and maximum to 16000.

    NOTE: Supports only expansion on update (must be attached to a running instance and must not be less than the current volume capacity). Can be updated only if volume is attached to an running virtual server instance. Stopped instance will be started on update of capacity of the volume.If source_snapshot is provided capacity must be at least the snapshot's minimum_capacity. The maximum value may increase in the future and If unspecified, the capacity will be the source snapshot's minimum_capacity.

    deleteAllSnapshots Boolean
    Deletes all snapshots created from this volume.
    encryptionKey String
    The key to use for encrypting this volume.
    iops Number

    The total input/ output operations per second (IOPS) for your storage. This value is required for custom storage profiles only.

    NOTE: iops value can be upgraded and downgraged if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume.

    This table shows how storage size affects the iops ranges:

    | Size range (GB) | IOPS range | |--------------------|----------------| | 10 - 39 | 100 - 1000 | | 40 - 79 | 100 - 2000 | | 80 - 99 | 100 - 4000 | | 100 - 499 | 100 - 6000 | | 500 - 999 | 100 - 10000 | | 1000 - 1999 | 100 - 20000 | | 2000 - 3999 | 100 - 40000 | | 4000 - 1999 | 100 - 40000 | | 8000 - 1999 | 100 - 48000 | | 10000 - 16000 | 100 - 48000 |

    isVolumeId String
    (String) The unique identifier of the volume.
    name String
    The user-defined name for this volume.No.
    resourceGroup String
    The resource group ID for this volume.
    sourceSnapshot String
    The ID of snapshot from which to clone the volume.
    sourceSnapshotCrn String
    The CRN of snapshot from which to clone the volume.
    tags List<String>
    A list of user tags that you want to add to your volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
    timeouts Property Map

    Outputs

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

    AdjustableCapacityStates List<string>
    The attachment states that support adjustable capacity for this volume. Allowable list items are: attached, unattached, unusable.
    AdjustableIopsStates List<string>
    The attachment states that support adjustable IOPS for this volume. Allowable list items are: attached, unattached, unusable.
    CatalogOfferings List<IsVolumeCatalogOffering>
    (List) The catalog offering this volume was created from. If a virtual server instance is provisioned with a boot_volume_attachment specifying this volume, the virtual server instance will use this volume's catalog offering, including its pricing plan.If absent, this volume was not created from a catalog offering.
    Crn string
    (String) The CRN for the volume.
    EncryptionType string
    (String) The type of encryption used in the volume [provider_managed, user_managed].
    HealthReasons List<IsVolumeHealthReason>
    (List) The reasons for the current health_state (if any).
    HealthState string
    (String) The health of this resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    OperatingSystems List<IsVolumeOperatingSystem>
    The operating system associated with this volume. If absent, this volume was notcreated from an image, or the image did not include an operating system.
    ResourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance.
    ResourceCrn string
    The crn of the resource
    ResourceGroupName string
    The resource group name in which resource is provisioned
    ResourceName string
    The name of the resource
    ResourceStatus string
    The status of the resource
    Status string
    (String) The status of volume. Supported values are available, failed, pending, unusable, or pending_deletion.
    StatusReasons List<IsVolumeStatusReason>
    (List) Array of reasons for the current status.
    AdjustableCapacityStates []string
    The attachment states that support adjustable capacity for this volume. Allowable list items are: attached, unattached, unusable.
    AdjustableIopsStates []string
    The attachment states that support adjustable IOPS for this volume. Allowable list items are: attached, unattached, unusable.
    CatalogOfferings []IsVolumeCatalogOffering
    (List) The catalog offering this volume was created from. If a virtual server instance is provisioned with a boot_volume_attachment specifying this volume, the virtual server instance will use this volume's catalog offering, including its pricing plan.If absent, this volume was not created from a catalog offering.
    Crn string
    (String) The CRN for the volume.
    EncryptionType string
    (String) The type of encryption used in the volume [provider_managed, user_managed].
    HealthReasons []IsVolumeHealthReason
    (List) The reasons for the current health_state (if any).
    HealthState string
    (String) The health of this resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    OperatingSystems []IsVolumeOperatingSystem
    The operating system associated with this volume. If absent, this volume was notcreated from an image, or the image did not include an operating system.
    ResourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance.
    ResourceCrn string
    The crn of the resource
    ResourceGroupName string
    The resource group name in which resource is provisioned
    ResourceName string
    The name of the resource
    ResourceStatus string
    The status of the resource
    Status string
    (String) The status of volume. Supported values are available, failed, pending, unusable, or pending_deletion.
    StatusReasons []IsVolumeStatusReason
    (List) Array of reasons for the current status.
    adjustableCapacityStates List<String>
    The attachment states that support adjustable capacity for this volume. Allowable list items are: attached, unattached, unusable.
    adjustableIopsStates List<String>
    The attachment states that support adjustable IOPS for this volume. Allowable list items are: attached, unattached, unusable.
    catalogOfferings List<IsVolumeCatalogOffering>
    (List) The catalog offering this volume was created from. If a virtual server instance is provisioned with a boot_volume_attachment specifying this volume, the virtual server instance will use this volume's catalog offering, including its pricing plan.If absent, this volume was not created from a catalog offering.
    crn String
    (String) The CRN for the volume.
    encryptionType String
    (String) The type of encryption used in the volume [provider_managed, user_managed].
    healthReasons List<IsVolumeHealthReason>
    (List) The reasons for the current health_state (if any).
    healthState String
    (String) The health of this resource.
    id String
    The provider-assigned unique ID for this managed resource.
    operatingSystems List<IsVolumeOperatingSystem>
    The operating system associated with this volume. If absent, this volume was notcreated from an image, or the image did not include an operating system.
    resourceControllerUrl String
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance.
    resourceCrn String
    The crn of the resource
    resourceGroupName String
    The resource group name in which resource is provisioned
    resourceName String
    The name of the resource
    resourceStatus String
    The status of the resource
    status String
    (String) The status of volume. Supported values are available, failed, pending, unusable, or pending_deletion.
    statusReasons List<IsVolumeStatusReason>
    (List) Array of reasons for the current status.
    adjustableCapacityStates string[]
    The attachment states that support adjustable capacity for this volume. Allowable list items are: attached, unattached, unusable.
    adjustableIopsStates string[]
    The attachment states that support adjustable IOPS for this volume. Allowable list items are: attached, unattached, unusable.
    catalogOfferings IsVolumeCatalogOffering[]
    (List) The catalog offering this volume was created from. If a virtual server instance is provisioned with a boot_volume_attachment specifying this volume, the virtual server instance will use this volume's catalog offering, including its pricing plan.If absent, this volume was not created from a catalog offering.
    crn string
    (String) The CRN for the volume.
    encryptionType string
    (String) The type of encryption used in the volume [provider_managed, user_managed].
    healthReasons IsVolumeHealthReason[]
    (List) The reasons for the current health_state (if any).
    healthState string
    (String) The health of this resource.
    id string
    The provider-assigned unique ID for this managed resource.
    operatingSystems IsVolumeOperatingSystem[]
    The operating system associated with this volume. If absent, this volume was notcreated from an image, or the image did not include an operating system.
    resourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance.
    resourceCrn string
    The crn of the resource
    resourceGroupName string
    The resource group name in which resource is provisioned
    resourceName string
    The name of the resource
    resourceStatus string
    The status of the resource
    status string
    (String) The status of volume. Supported values are available, failed, pending, unusable, or pending_deletion.
    statusReasons IsVolumeStatusReason[]
    (List) Array of reasons for the current status.
    adjustable_capacity_states Sequence[str]
    The attachment states that support adjustable capacity for this volume. Allowable list items are: attached, unattached, unusable.
    adjustable_iops_states Sequence[str]
    The attachment states that support adjustable IOPS for this volume. Allowable list items are: attached, unattached, unusable.
    catalog_offerings Sequence[IsVolumeCatalogOffering]
    (List) The catalog offering this volume was created from. If a virtual server instance is provisioned with a boot_volume_attachment specifying this volume, the virtual server instance will use this volume's catalog offering, including its pricing plan.If absent, this volume was not created from a catalog offering.
    crn str
    (String) The CRN for the volume.
    encryption_type str
    (String) The type of encryption used in the volume [provider_managed, user_managed].
    health_reasons Sequence[IsVolumeHealthReason]
    (List) The reasons for the current health_state (if any).
    health_state str
    (String) The health of this resource.
    id str
    The provider-assigned unique ID for this managed resource.
    operating_systems Sequence[IsVolumeOperatingSystem]
    The operating system associated with this volume. If absent, this volume was notcreated from an image, or the image did not include an operating system.
    resource_controller_url str
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance.
    resource_crn str
    The crn of the resource
    resource_group_name str
    The resource group name in which resource is provisioned
    resource_name str
    The name of the resource
    resource_status str
    The status of the resource
    status str
    (String) The status of volume. Supported values are available, failed, pending, unusable, or pending_deletion.
    status_reasons Sequence[IsVolumeStatusReason]
    (List) Array of reasons for the current status.
    adjustableCapacityStates List<String>
    The attachment states that support adjustable capacity for this volume. Allowable list items are: attached, unattached, unusable.
    adjustableIopsStates List<String>
    The attachment states that support adjustable IOPS for this volume. Allowable list items are: attached, unattached, unusable.
    catalogOfferings List<Property Map>
    (List) The catalog offering this volume was created from. If a virtual server instance is provisioned with a boot_volume_attachment specifying this volume, the virtual server instance will use this volume's catalog offering, including its pricing plan.If absent, this volume was not created from a catalog offering.
    crn String
    (String) The CRN for the volume.
    encryptionType String
    (String) The type of encryption used in the volume [provider_managed, user_managed].
    healthReasons List<Property Map>
    (List) The reasons for the current health_state (if any).
    healthState String
    (String) The health of this resource.
    id String
    The provider-assigned unique ID for this managed resource.
    operatingSystems List<Property Map>
    The operating system associated with this volume. If absent, this volume was notcreated from an image, or the image did not include an operating system.
    resourceControllerUrl String
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance.
    resourceCrn String
    The crn of the resource
    resourceGroupName String
    The resource group name in which resource is provisioned
    resourceName String
    The name of the resource
    resourceStatus String
    The status of the resource
    status String
    (String) The status of volume. Supported values are available, failed, pending, unusable, or pending_deletion.
    statusReasons List<Property Map>
    (List) Array of reasons for the current status.

    Look up Existing IsVolume Resource

    Get an existing IsVolume 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?: IsVolumeState, opts?: CustomResourceOptions): IsVolume
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_tags: Optional[Sequence[str]] = None,
        adjustable_capacity_states: Optional[Sequence[str]] = None,
        adjustable_iops_states: Optional[Sequence[str]] = None,
        bandwidth: Optional[float] = None,
        capacity: Optional[float] = None,
        catalog_offerings: Optional[Sequence[IsVolumeCatalogOfferingArgs]] = None,
        crn: Optional[str] = None,
        delete_all_snapshots: Optional[bool] = None,
        encryption_key: Optional[str] = None,
        encryption_type: Optional[str] = None,
        health_reasons: Optional[Sequence[IsVolumeHealthReasonArgs]] = None,
        health_state: Optional[str] = None,
        iops: Optional[float] = None,
        is_volume_id: Optional[str] = None,
        name: Optional[str] = None,
        operating_systems: Optional[Sequence[IsVolumeOperatingSystemArgs]] = None,
        profile: Optional[str] = None,
        resource_controller_url: Optional[str] = None,
        resource_crn: Optional[str] = None,
        resource_group: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        resource_name: Optional[str] = None,
        resource_status: Optional[str] = None,
        source_snapshot: Optional[str] = None,
        source_snapshot_crn: Optional[str] = None,
        status: Optional[str] = None,
        status_reasons: Optional[Sequence[IsVolumeStatusReasonArgs]] = None,
        tags: Optional[Sequence[str]] = None,
        timeouts: Optional[IsVolumeTimeoutsArgs] = None,
        zone: Optional[str] = None) -> IsVolume
    func GetIsVolume(ctx *Context, name string, id IDInput, state *IsVolumeState, opts ...ResourceOption) (*IsVolume, error)
    public static IsVolume Get(string name, Input<string> id, IsVolumeState? state, CustomResourceOptions? opts = null)
    public static IsVolume get(String name, Output<String> id, IsVolumeState state, CustomResourceOptions options)
    resources:  _:    type: ibm:IsVolume    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    AccessTags List<string>

    A list of access management tags to attach to the bare metal server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    AdjustableCapacityStates List<string>
    The attachment states that support adjustable capacity for this volume. Allowable list items are: attached, unattached, unusable.
    AdjustableIopsStates List<string>
    The attachment states that support adjustable IOPS for this volume. Allowable list items are: attached, unattached, unusable.
    Bandwidth double
    The maximum bandwidth (in megabits per second) for the volume
    Capacity double

    (The capacity of the volume in gigabytes. This defaults to 100, minimum to 10 and maximum to 16000.

    NOTE: Supports only expansion on update (must be attached to a running instance and must not be less than the current volume capacity). Can be updated only if volume is attached to an running virtual server instance. Stopped instance will be started on update of capacity of the volume.If source_snapshot is provided capacity must be at least the snapshot's minimum_capacity. The maximum value may increase in the future and If unspecified, the capacity will be the source snapshot's minimum_capacity.

    CatalogOfferings List<IsVolumeCatalogOffering>
    (List) The catalog offering this volume was created from. If a virtual server instance is provisioned with a boot_volume_attachment specifying this volume, the virtual server instance will use this volume's catalog offering, including its pricing plan.If absent, this volume was not created from a catalog offering.
    Crn string
    (String) The CRN for the volume.
    DeleteAllSnapshots bool
    Deletes all snapshots created from this volume.
    EncryptionKey string
    The key to use for encrypting this volume.
    EncryptionType string
    (String) The type of encryption used in the volume [provider_managed, user_managed].
    HealthReasons List<IsVolumeHealthReason>
    (List) The reasons for the current health_state (if any).
    HealthState string
    (String) The health of this resource.
    Iops double

    The total input/ output operations per second (IOPS) for your storage. This value is required for custom storage profiles only.

    NOTE: iops value can be upgraded and downgraged if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume.

    This table shows how storage size affects the iops ranges:

    | Size range (GB) | IOPS range | |--------------------|----------------| | 10 - 39 | 100 - 1000 | | 40 - 79 | 100 - 2000 | | 80 - 99 | 100 - 4000 | | 100 - 499 | 100 - 6000 | | 500 - 999 | 100 - 10000 | | 1000 - 1999 | 100 - 20000 | | 2000 - 3999 | 100 - 40000 | | 4000 - 1999 | 100 - 40000 | | 8000 - 1999 | 100 - 48000 | | 10000 - 16000 | 100 - 48000 |

    IsVolumeId string
    (String) The unique identifier of the volume.
    Name string
    The user-defined name for this volume.No.
    OperatingSystems List<IsVolumeOperatingSystem>
    The operating system associated with this volume. If absent, this volume was notcreated from an image, or the image did not include an operating system.
    Profile string

    The profile to use for this volume.

    NOTE: tiered profiles [general-purpose, 5iops-tier, 10iops-tier] can be upgraded and downgraded into each other if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume.

    ResourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance.
    ResourceCrn string
    The crn of the resource
    ResourceGroup string
    The resource group ID for this volume.
    ResourceGroupName string
    The resource group name in which resource is provisioned
    ResourceName string
    The name of the resource
    ResourceStatus string
    The status of the resource
    SourceSnapshot string
    The ID of snapshot from which to clone the volume.
    SourceSnapshotCrn string
    The CRN of snapshot from which to clone the volume.
    Status string
    (String) The status of volume. Supported values are available, failed, pending, unusable, or pending_deletion.
    StatusReasons List<IsVolumeStatusReason>
    (List) Array of reasons for the current status.
    Tags List<string>
    A list of user tags that you want to add to your volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
    Timeouts IsVolumeTimeouts
    Zone string
    The location of the volume.
    AccessTags []string

    A list of access management tags to attach to the bare metal server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    AdjustableCapacityStates []string
    The attachment states that support adjustable capacity for this volume. Allowable list items are: attached, unattached, unusable.
    AdjustableIopsStates []string
    The attachment states that support adjustable IOPS for this volume. Allowable list items are: attached, unattached, unusable.
    Bandwidth float64
    The maximum bandwidth (in megabits per second) for the volume
    Capacity float64

    (The capacity of the volume in gigabytes. This defaults to 100, minimum to 10 and maximum to 16000.

    NOTE: Supports only expansion on update (must be attached to a running instance and must not be less than the current volume capacity). Can be updated only if volume is attached to an running virtual server instance. Stopped instance will be started on update of capacity of the volume.If source_snapshot is provided capacity must be at least the snapshot's minimum_capacity. The maximum value may increase in the future and If unspecified, the capacity will be the source snapshot's minimum_capacity.

    CatalogOfferings []IsVolumeCatalogOfferingArgs
    (List) The catalog offering this volume was created from. If a virtual server instance is provisioned with a boot_volume_attachment specifying this volume, the virtual server instance will use this volume's catalog offering, including its pricing plan.If absent, this volume was not created from a catalog offering.
    Crn string
    (String) The CRN for the volume.
    DeleteAllSnapshots bool
    Deletes all snapshots created from this volume.
    EncryptionKey string
    The key to use for encrypting this volume.
    EncryptionType string
    (String) The type of encryption used in the volume [provider_managed, user_managed].
    HealthReasons []IsVolumeHealthReasonArgs
    (List) The reasons for the current health_state (if any).
    HealthState string
    (String) The health of this resource.
    Iops float64

    The total input/ output operations per second (IOPS) for your storage. This value is required for custom storage profiles only.

    NOTE: iops value can be upgraded and downgraged if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume.

    This table shows how storage size affects the iops ranges:

    | Size range (GB) | IOPS range | |--------------------|----------------| | 10 - 39 | 100 - 1000 | | 40 - 79 | 100 - 2000 | | 80 - 99 | 100 - 4000 | | 100 - 499 | 100 - 6000 | | 500 - 999 | 100 - 10000 | | 1000 - 1999 | 100 - 20000 | | 2000 - 3999 | 100 - 40000 | | 4000 - 1999 | 100 - 40000 | | 8000 - 1999 | 100 - 48000 | | 10000 - 16000 | 100 - 48000 |

    IsVolumeId string
    (String) The unique identifier of the volume.
    Name string
    The user-defined name for this volume.No.
    OperatingSystems []IsVolumeOperatingSystemArgs
    The operating system associated with this volume. If absent, this volume was notcreated from an image, or the image did not include an operating system.
    Profile string

    The profile to use for this volume.

    NOTE: tiered profiles [general-purpose, 5iops-tier, 10iops-tier] can be upgraded and downgraded into each other if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume.

    ResourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance.
    ResourceCrn string
    The crn of the resource
    ResourceGroup string
    The resource group ID for this volume.
    ResourceGroupName string
    The resource group name in which resource is provisioned
    ResourceName string
    The name of the resource
    ResourceStatus string
    The status of the resource
    SourceSnapshot string
    The ID of snapshot from which to clone the volume.
    SourceSnapshotCrn string
    The CRN of snapshot from which to clone the volume.
    Status string
    (String) The status of volume. Supported values are available, failed, pending, unusable, or pending_deletion.
    StatusReasons []IsVolumeStatusReasonArgs
    (List) Array of reasons for the current status.
    Tags []string
    A list of user tags that you want to add to your volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
    Timeouts IsVolumeTimeoutsArgs
    Zone string
    The location of the volume.
    accessTags List<String>

    A list of access management tags to attach to the bare metal server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    adjustableCapacityStates List<String>
    The attachment states that support adjustable capacity for this volume. Allowable list items are: attached, unattached, unusable.
    adjustableIopsStates List<String>
    The attachment states that support adjustable IOPS for this volume. Allowable list items are: attached, unattached, unusable.
    bandwidth Double
    The maximum bandwidth (in megabits per second) for the volume
    capacity Double

    (The capacity of the volume in gigabytes. This defaults to 100, minimum to 10 and maximum to 16000.

    NOTE: Supports only expansion on update (must be attached to a running instance and must not be less than the current volume capacity). Can be updated only if volume is attached to an running virtual server instance. Stopped instance will be started on update of capacity of the volume.If source_snapshot is provided capacity must be at least the snapshot's minimum_capacity. The maximum value may increase in the future and If unspecified, the capacity will be the source snapshot's minimum_capacity.

    catalogOfferings List<IsVolumeCatalogOffering>
    (List) The catalog offering this volume was created from. If a virtual server instance is provisioned with a boot_volume_attachment specifying this volume, the virtual server instance will use this volume's catalog offering, including its pricing plan.If absent, this volume was not created from a catalog offering.
    crn String
    (String) The CRN for the volume.
    deleteAllSnapshots Boolean
    Deletes all snapshots created from this volume.
    encryptionKey String
    The key to use for encrypting this volume.
    encryptionType String
    (String) The type of encryption used in the volume [provider_managed, user_managed].
    healthReasons List<IsVolumeHealthReason>
    (List) The reasons for the current health_state (if any).
    healthState String
    (String) The health of this resource.
    iops Double

    The total input/ output operations per second (IOPS) for your storage. This value is required for custom storage profiles only.

    NOTE: iops value can be upgraded and downgraged if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume.

    This table shows how storage size affects the iops ranges:

    | Size range (GB) | IOPS range | |--------------------|----------------| | 10 - 39 | 100 - 1000 | | 40 - 79 | 100 - 2000 | | 80 - 99 | 100 - 4000 | | 100 - 499 | 100 - 6000 | | 500 - 999 | 100 - 10000 | | 1000 - 1999 | 100 - 20000 | | 2000 - 3999 | 100 - 40000 | | 4000 - 1999 | 100 - 40000 | | 8000 - 1999 | 100 - 48000 | | 10000 - 16000 | 100 - 48000 |

    isVolumeId String
    (String) The unique identifier of the volume.
    name String
    The user-defined name for this volume.No.
    operatingSystems List<IsVolumeOperatingSystem>
    The operating system associated with this volume. If absent, this volume was notcreated from an image, or the image did not include an operating system.
    profile String

    The profile to use for this volume.

    NOTE: tiered profiles [general-purpose, 5iops-tier, 10iops-tier] can be upgraded and downgraded into each other if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume.

    resourceControllerUrl String
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance.
    resourceCrn String
    The crn of the resource
    resourceGroup String
    The resource group ID for this volume.
    resourceGroupName String
    The resource group name in which resource is provisioned
    resourceName String
    The name of the resource
    resourceStatus String
    The status of the resource
    sourceSnapshot String
    The ID of snapshot from which to clone the volume.
    sourceSnapshotCrn String
    The CRN of snapshot from which to clone the volume.
    status String
    (String) The status of volume. Supported values are available, failed, pending, unusable, or pending_deletion.
    statusReasons List<IsVolumeStatusReason>
    (List) Array of reasons for the current status.
    tags List<String>
    A list of user tags that you want to add to your volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
    timeouts IsVolumeTimeouts
    zone String
    The location of the volume.
    accessTags string[]

    A list of access management tags to attach to the bare metal server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    adjustableCapacityStates string[]
    The attachment states that support adjustable capacity for this volume. Allowable list items are: attached, unattached, unusable.
    adjustableIopsStates string[]
    The attachment states that support adjustable IOPS for this volume. Allowable list items are: attached, unattached, unusable.
    bandwidth number
    The maximum bandwidth (in megabits per second) for the volume
    capacity number

    (The capacity of the volume in gigabytes. This defaults to 100, minimum to 10 and maximum to 16000.

    NOTE: Supports only expansion on update (must be attached to a running instance and must not be less than the current volume capacity). Can be updated only if volume is attached to an running virtual server instance. Stopped instance will be started on update of capacity of the volume.If source_snapshot is provided capacity must be at least the snapshot's minimum_capacity. The maximum value may increase in the future and If unspecified, the capacity will be the source snapshot's minimum_capacity.

    catalogOfferings IsVolumeCatalogOffering[]
    (List) The catalog offering this volume was created from. If a virtual server instance is provisioned with a boot_volume_attachment specifying this volume, the virtual server instance will use this volume's catalog offering, including its pricing plan.If absent, this volume was not created from a catalog offering.
    crn string
    (String) The CRN for the volume.
    deleteAllSnapshots boolean
    Deletes all snapshots created from this volume.
    encryptionKey string
    The key to use for encrypting this volume.
    encryptionType string
    (String) The type of encryption used in the volume [provider_managed, user_managed].
    healthReasons IsVolumeHealthReason[]
    (List) The reasons for the current health_state (if any).
    healthState string
    (String) The health of this resource.
    iops number

    The total input/ output operations per second (IOPS) for your storage. This value is required for custom storage profiles only.

    NOTE: iops value can be upgraded and downgraged if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume.

    This table shows how storage size affects the iops ranges:

    | Size range (GB) | IOPS range | |--------------------|----------------| | 10 - 39 | 100 - 1000 | | 40 - 79 | 100 - 2000 | | 80 - 99 | 100 - 4000 | | 100 - 499 | 100 - 6000 | | 500 - 999 | 100 - 10000 | | 1000 - 1999 | 100 - 20000 | | 2000 - 3999 | 100 - 40000 | | 4000 - 1999 | 100 - 40000 | | 8000 - 1999 | 100 - 48000 | | 10000 - 16000 | 100 - 48000 |

    isVolumeId string
    (String) The unique identifier of the volume.
    name string
    The user-defined name for this volume.No.
    operatingSystems IsVolumeOperatingSystem[]
    The operating system associated with this volume. If absent, this volume was notcreated from an image, or the image did not include an operating system.
    profile string

    The profile to use for this volume.

    NOTE: tiered profiles [general-purpose, 5iops-tier, 10iops-tier] can be upgraded and downgraded into each other if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume.

    resourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance.
    resourceCrn string
    The crn of the resource
    resourceGroup string
    The resource group ID for this volume.
    resourceGroupName string
    The resource group name in which resource is provisioned
    resourceName string
    The name of the resource
    resourceStatus string
    The status of the resource
    sourceSnapshot string
    The ID of snapshot from which to clone the volume.
    sourceSnapshotCrn string
    The CRN of snapshot from which to clone the volume.
    status string
    (String) The status of volume. Supported values are available, failed, pending, unusable, or pending_deletion.
    statusReasons IsVolumeStatusReason[]
    (List) Array of reasons for the current status.
    tags string[]
    A list of user tags that you want to add to your volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
    timeouts IsVolumeTimeouts
    zone string
    The location of the volume.
    access_tags Sequence[str]

    A list of access management tags to attach to the bare metal server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    adjustable_capacity_states Sequence[str]
    The attachment states that support adjustable capacity for this volume. Allowable list items are: attached, unattached, unusable.
    adjustable_iops_states Sequence[str]
    The attachment states that support adjustable IOPS for this volume. Allowable list items are: attached, unattached, unusable.
    bandwidth float
    The maximum bandwidth (in megabits per second) for the volume
    capacity float

    (The capacity of the volume in gigabytes. This defaults to 100, minimum to 10 and maximum to 16000.

    NOTE: Supports only expansion on update (must be attached to a running instance and must not be less than the current volume capacity). Can be updated only if volume is attached to an running virtual server instance. Stopped instance will be started on update of capacity of the volume.If source_snapshot is provided capacity must be at least the snapshot's minimum_capacity. The maximum value may increase in the future and If unspecified, the capacity will be the source snapshot's minimum_capacity.

    catalog_offerings Sequence[IsVolumeCatalogOfferingArgs]
    (List) The catalog offering this volume was created from. If a virtual server instance is provisioned with a boot_volume_attachment specifying this volume, the virtual server instance will use this volume's catalog offering, including its pricing plan.If absent, this volume was not created from a catalog offering.
    crn str
    (String) The CRN for the volume.
    delete_all_snapshots bool
    Deletes all snapshots created from this volume.
    encryption_key str
    The key to use for encrypting this volume.
    encryption_type str
    (String) The type of encryption used in the volume [provider_managed, user_managed].
    health_reasons Sequence[IsVolumeHealthReasonArgs]
    (List) The reasons for the current health_state (if any).
    health_state str
    (String) The health of this resource.
    iops float

    The total input/ output operations per second (IOPS) for your storage. This value is required for custom storage profiles only.

    NOTE: iops value can be upgraded and downgraged if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume.

    This table shows how storage size affects the iops ranges:

    | Size range (GB) | IOPS range | |--------------------|----------------| | 10 - 39 | 100 - 1000 | | 40 - 79 | 100 - 2000 | | 80 - 99 | 100 - 4000 | | 100 - 499 | 100 - 6000 | | 500 - 999 | 100 - 10000 | | 1000 - 1999 | 100 - 20000 | | 2000 - 3999 | 100 - 40000 | | 4000 - 1999 | 100 - 40000 | | 8000 - 1999 | 100 - 48000 | | 10000 - 16000 | 100 - 48000 |

    is_volume_id str
    (String) The unique identifier of the volume.
    name str
    The user-defined name for this volume.No.
    operating_systems Sequence[IsVolumeOperatingSystemArgs]
    The operating system associated with this volume. If absent, this volume was notcreated from an image, or the image did not include an operating system.
    profile str

    The profile to use for this volume.

    NOTE: tiered profiles [general-purpose, 5iops-tier, 10iops-tier] can be upgraded and downgraded into each other if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume.

    resource_controller_url str
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance.
    resource_crn str
    The crn of the resource
    resource_group str
    The resource group ID for this volume.
    resource_group_name str
    The resource group name in which resource is provisioned
    resource_name str
    The name of the resource
    resource_status str
    The status of the resource
    source_snapshot str
    The ID of snapshot from which to clone the volume.
    source_snapshot_crn str
    The CRN of snapshot from which to clone the volume.
    status str
    (String) The status of volume. Supported values are available, failed, pending, unusable, or pending_deletion.
    status_reasons Sequence[IsVolumeStatusReasonArgs]
    (List) Array of reasons for the current status.
    tags Sequence[str]
    A list of user tags that you want to add to your volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
    timeouts IsVolumeTimeoutsArgs
    zone str
    The location of the volume.
    accessTags List<String>

    A list of access management tags to attach to the bare metal server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    adjustableCapacityStates List<String>
    The attachment states that support adjustable capacity for this volume. Allowable list items are: attached, unattached, unusable.
    adjustableIopsStates List<String>
    The attachment states that support adjustable IOPS for this volume. Allowable list items are: attached, unattached, unusable.
    bandwidth Number
    The maximum bandwidth (in megabits per second) for the volume
    capacity Number

    (The capacity of the volume in gigabytes. This defaults to 100, minimum to 10 and maximum to 16000.

    NOTE: Supports only expansion on update (must be attached to a running instance and must not be less than the current volume capacity). Can be updated only if volume is attached to an running virtual server instance. Stopped instance will be started on update of capacity of the volume.If source_snapshot is provided capacity must be at least the snapshot's minimum_capacity. The maximum value may increase in the future and If unspecified, the capacity will be the source snapshot's minimum_capacity.

    catalogOfferings List<Property Map>
    (List) The catalog offering this volume was created from. If a virtual server instance is provisioned with a boot_volume_attachment specifying this volume, the virtual server instance will use this volume's catalog offering, including its pricing plan.If absent, this volume was not created from a catalog offering.
    crn String
    (String) The CRN for the volume.
    deleteAllSnapshots Boolean
    Deletes all snapshots created from this volume.
    encryptionKey String
    The key to use for encrypting this volume.
    encryptionType String
    (String) The type of encryption used in the volume [provider_managed, user_managed].
    healthReasons List<Property Map>
    (List) The reasons for the current health_state (if any).
    healthState String
    (String) The health of this resource.
    iops Number

    The total input/ output operations per second (IOPS) for your storage. This value is required for custom storage profiles only.

    NOTE: iops value can be upgraded and downgraged if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume.

    This table shows how storage size affects the iops ranges:

    | Size range (GB) | IOPS range | |--------------------|----------------| | 10 - 39 | 100 - 1000 | | 40 - 79 | 100 - 2000 | | 80 - 99 | 100 - 4000 | | 100 - 499 | 100 - 6000 | | 500 - 999 | 100 - 10000 | | 1000 - 1999 | 100 - 20000 | | 2000 - 3999 | 100 - 40000 | | 4000 - 1999 | 100 - 40000 | | 8000 - 1999 | 100 - 48000 | | 10000 - 16000 | 100 - 48000 |

    isVolumeId String
    (String) The unique identifier of the volume.
    name String
    The user-defined name for this volume.No.
    operatingSystems List<Property Map>
    The operating system associated with this volume. If absent, this volume was notcreated from an image, or the image did not include an operating system.
    profile String

    The profile to use for this volume.

    NOTE: tiered profiles [general-purpose, 5iops-tier, 10iops-tier] can be upgraded and downgraded into each other if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume.

    resourceControllerUrl String
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance.
    resourceCrn String
    The crn of the resource
    resourceGroup String
    The resource group ID for this volume.
    resourceGroupName String
    The resource group name in which resource is provisioned
    resourceName String
    The name of the resource
    resourceStatus String
    The status of the resource
    sourceSnapshot String
    The ID of snapshot from which to clone the volume.
    sourceSnapshotCrn String
    The CRN of snapshot from which to clone the volume.
    status String
    (String) The status of volume. Supported values are available, failed, pending, unusable, or pending_deletion.
    statusReasons List<Property Map>
    (List) Array of reasons for the current status.
    tags List<String>
    A list of user tags that you want to add to your volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
    timeouts Property Map
    zone String
    The location of the volume.

    Supporting Types

    IsVolumeCatalogOffering, IsVolumeCatalogOfferingArgs

    Deleteds List<IsVolumeCatalogOfferingDeleted>
    (List) If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
    PlanCrn string
    (String) The CRN for this catalog offering version's billing plan
    VersionCrn string
    (String) The CRN for this version of a catalog offering
    Deleteds []IsVolumeCatalogOfferingDeleted
    (List) If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
    PlanCrn string
    (String) The CRN for this catalog offering version's billing plan
    VersionCrn string
    (String) The CRN for this version of a catalog offering
    deleteds List<IsVolumeCatalogOfferingDeleted>
    (List) If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
    planCrn String
    (String) The CRN for this catalog offering version's billing plan
    versionCrn String
    (String) The CRN for this version of a catalog offering
    deleteds IsVolumeCatalogOfferingDeleted[]
    (List) If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
    planCrn string
    (String) The CRN for this catalog offering version's billing plan
    versionCrn string
    (String) The CRN for this version of a catalog offering
    deleteds Sequence[IsVolumeCatalogOfferingDeleted]
    (List) If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
    plan_crn str
    (String) The CRN for this catalog offering version's billing plan
    version_crn str
    (String) The CRN for this version of a catalog offering
    deleteds List<Property Map>
    (List) If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
    planCrn String
    (String) The CRN for this catalog offering version's billing plan
    versionCrn String
    (String) The CRN for this version of a catalog offering

    IsVolumeCatalogOfferingDeleted, IsVolumeCatalogOfferingDeletedArgs

    MoreInfo string
    (String) Link to documentation about this status reason
    MoreInfo string
    (String) Link to documentation about this status reason
    moreInfo String
    (String) Link to documentation about this status reason
    moreInfo string
    (String) Link to documentation about this status reason
    more_info str
    (String) Link to documentation about this status reason
    moreInfo String
    (String) Link to documentation about this status reason

    IsVolumeHealthReason, IsVolumeHealthReasonArgs

    Code string
    (String) A string with an underscore as a special character identifying the status reason.
    Message string
    (String) An explanation of the status reason.
    MoreInfo string
    (String) Link to documentation about this status reason
    Code string
    (String) A string with an underscore as a special character identifying the status reason.
    Message string
    (String) An explanation of the status reason.
    MoreInfo string
    (String) Link to documentation about this status reason
    code String
    (String) A string with an underscore as a special character identifying the status reason.
    message String
    (String) An explanation of the status reason.
    moreInfo String
    (String) Link to documentation about this status reason
    code string
    (String) A string with an underscore as a special character identifying the status reason.
    message string
    (String) An explanation of the status reason.
    moreInfo string
    (String) Link to documentation about this status reason
    code str
    (String) A string with an underscore as a special character identifying the status reason.
    message str
    (String) An explanation of the status reason.
    more_info str
    (String) Link to documentation about this status reason
    code String
    (String) A string with an underscore as a special character identifying the status reason.
    message String
    (String) An explanation of the status reason.
    moreInfo String
    (String) Link to documentation about this status reason

    IsVolumeOperatingSystem, IsVolumeOperatingSystemArgs

    Architecture string
    DedicatedHostOnly bool
    DisplayName string
    Family string
    Href string
    Name string
    The user-defined name for this volume.No.
    Vendor string
    Version string
    Architecture string
    DedicatedHostOnly bool
    DisplayName string
    Family string
    Href string
    Name string
    The user-defined name for this volume.No.
    Vendor string
    Version string
    architecture String
    dedicatedHostOnly Boolean
    displayName String
    family String
    href String
    name String
    The user-defined name for this volume.No.
    vendor String
    version String
    architecture string
    dedicatedHostOnly boolean
    displayName string
    family string
    href string
    name string
    The user-defined name for this volume.No.
    vendor string
    version string
    architecture str
    dedicated_host_only bool
    display_name str
    family str
    href str
    name str
    The user-defined name for this volume.No.
    vendor str
    version str
    architecture String
    dedicatedHostOnly Boolean
    displayName String
    family String
    href String
    name String
    The user-defined name for this volume.No.
    vendor String
    version String

    IsVolumeStatusReason, IsVolumeStatusReasonArgs

    Code string
    (String) A string with an underscore as a special character identifying the status reason.
    Message string
    (String) An explanation of the status reason.
    MoreInfo string
    (String) Link to documentation about this status reason
    Code string
    (String) A string with an underscore as a special character identifying the status reason.
    Message string
    (String) An explanation of the status reason.
    MoreInfo string
    (String) Link to documentation about this status reason
    code String
    (String) A string with an underscore as a special character identifying the status reason.
    message String
    (String) An explanation of the status reason.
    moreInfo String
    (String) Link to documentation about this status reason
    code string
    (String) A string with an underscore as a special character identifying the status reason.
    message string
    (String) An explanation of the status reason.
    moreInfo string
    (String) Link to documentation about this status reason
    code str
    (String) A string with an underscore as a special character identifying the status reason.
    message str
    (String) An explanation of the status reason.
    more_info str
    (String) Link to documentation about this status reason
    code String
    (String) A string with an underscore as a special character identifying the status reason.
    message String
    (String) An explanation of the status reason.
    moreInfo String
    (String) Link to documentation about this status reason

    IsVolumeTimeouts, IsVolumeTimeoutsArgs

    Create string
    Delete string
    Create string
    Delete string
    create String
    delete String
    create string
    delete string
    create str
    delete str
    create String
    delete String

    Import

    The ibm_is_volume resource can be imported by using volume ID.

    Example

    $ pulumi import ibm:index/isVolume:IsVolume example d7bec597-4726-451f-8a63-e62e6f19c32c

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

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm