1. Packages
  2. Packages
  3. Ibm Provider
  4. API Docs
  5. IsVolumeJob
Viewing docs for ibm 2.1.0
published on Tuesday, May 5, 2026 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

ibm.IsVolumeJob

Viewing docs for ibm 2.1.0
published on Tuesday, May 5, 2026 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

    Example Usage

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

const example = new ibm.IsVolume("example", {
    name: "my-volume",
    capacity: 10,
    profile: "general-purpose",
    zone: "us-south-2",
});
const exampleIsVolumeJob = new ibm.IsVolumeJob("example", {
    volumeId: example.isVolumeId,
    jobType: "migrate",
    name: "my-volume-job",
    parameters: {
        bandwidth: 1000,
        iops: 10000,
        profile: {
            name: "sdp",
        },
    },
});

    import pulumi
import pulumi_ibm as ibm

example = ibm.IsVolume("example",
    name="my-volume",
    capacity=10,
    profile="general-purpose",
    zone="us-south-2")
example_is_volume_job = ibm.IsVolumeJob("example",
    volume_id=example.is_volume_id,
    job_type="migrate",
    name="my-volume-job",
    parameters={
        "bandwidth": 1000,
        "iops": 10000,
        "profile": {
            "name": "sdp",
        },
    })

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := ibm.NewIsVolume(ctx, "example", &ibm.IsVolumeArgs{
			Name:     pulumi.String("my-volume"),
			Capacity: pulumi.Float64(10),
			Profile:  pulumi.String("general-purpose"),
			Zone:     pulumi.String("us-south-2"),
		})
		if err != nil {
			return err
		}
		_, err = ibm.NewIsVolumeJob(ctx, "example", &ibm.IsVolumeJobArgs{
			VolumeId: example.IsVolumeId,
			JobType:  pulumi.String("migrate"),
			Name:     pulumi.String("my-volume-job"),
			Parameters: &ibm.IsVolumeJobParametersArgs{
				Bandwidth: pulumi.Float64(1000),
				Iops:      pulumi.Float64(10000),
				Profile: &ibm.IsVolumeJobParametersProfileArgs{
					Name: pulumi.String("sdp"),
				},
			},
		})
		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()
    {
        Name = "my-volume",
        Capacity = 10,
        Profile = "general-purpose",
        Zone = "us-south-2",
    });

    var exampleIsVolumeJob = new Ibm.IsVolumeJob("example", new()
    {
        VolumeId = example.IsVolumeId,
        JobType = "migrate",
        Name = "my-volume-job",
        Parameters = new Ibm.Inputs.IsVolumeJobParametersArgs
        {
            Bandwidth = 1000,
            Iops = 10000,
            Profile = new Ibm.Inputs.IsVolumeJobParametersProfileArgs
            {
                Name = "sdp",
            },
        },
    });

});

    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 com.pulumi.ibm.IsVolumeJob;
import com.pulumi.ibm.IsVolumeJobArgs;
import com.pulumi.ibm.inputs.IsVolumeJobParametersArgs;
import com.pulumi.ibm.inputs.IsVolumeJobParametersProfileArgs;
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()
            .name("my-volume")
            .capacity(10.0)
            .profile("general-purpose")
            .zone("us-south-2")
            .build());

        var exampleIsVolumeJob = new IsVolumeJob("exampleIsVolumeJob", IsVolumeJobArgs.builder()
            .volumeId(example.isVolumeId())
            .jobType("migrate")
            .name("my-volume-job")
            .parameters(IsVolumeJobParametersArgs.builder()
                .bandwidth(1000.0)
                .iops(10000.0)
                .profile(IsVolumeJobParametersProfileArgs.builder()
                    .name("sdp")
                    .build())
                .build())
            .build());

    }
}

    resources:
  example:
    type: ibm:IsVolume
    properties:
      name: my-volume
      capacity: 10
      profile: general-purpose
      zone: us-south-2
  exampleIsVolumeJob:
    type: ibm:IsVolumeJob
    name: example
    properties:
      volumeId: ${example.isVolumeId}
      jobType: migrate
      name: my-volume-job
      parameters:
        bandwidth: 1000
        iops: 10000
        profile:
          name: sdp

    Example coming soon!

    Create IsVolumeJob Resource

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

    Constructor syntax

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

@overload
def IsVolumeJob(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                job_type: Optional[str] = None,
                volume_id: Optional[str] = None,
                is_volume_job_id: Optional[str] = None,
                limit: Optional[float] = None,
                name: Optional[str] = None,
                parameters: Optional[IsVolumeJobParametersArgs] = None,
                start: Optional[str] = None,
                timeouts: Optional[IsVolumeJobTimeoutsArgs] = None)
    func NewIsVolumeJob(ctx *Context, name string, args IsVolumeJobArgs, opts ...ResourceOption) (*IsVolumeJob, error)
    public IsVolumeJob(string name, IsVolumeJobArgs args, CustomResourceOptions? opts = null)
    public IsVolumeJob(String name, IsVolumeJobArgs args)
public IsVolumeJob(String name, IsVolumeJobArgs args, CustomResourceOptions options)

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


    resource "ibm_isvolumejob" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args IsVolumeJobArgs
    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 IsVolumeJobArgs
    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 IsVolumeJobArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IsVolumeJobArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IsVolumeJobArgs
    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 isVolumeJobResource = new Ibm.IsVolumeJob("isVolumeJobResource", new()
{
    JobType = "string",
    VolumeId = "string",
    IsVolumeJobId = "string",
    Limit = 0,
    Name = "string",
    Parameters = new Ibm.Inputs.IsVolumeJobParametersArgs
    {
        Profile = new Ibm.Inputs.IsVolumeJobParametersProfileArgs
        {
            Href = "string",
            Name = "string",
        },
        Bandwidth = 0,
        Iops = 0,
    },
    Start = "string",
    Timeouts = new Ibm.Inputs.IsVolumeJobTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
});

    example, err := ibm.NewIsVolumeJob(ctx, "isVolumeJobResource", &ibm.IsVolumeJobArgs{
	JobType:       pulumi.String("string"),
	VolumeId:      pulumi.String("string"),
	IsVolumeJobId: pulumi.String("string"),
	Limit:         pulumi.Float64(0),
	Name:          pulumi.String("string"),
	Parameters: &ibm.IsVolumeJobParametersArgs{
		Profile: &ibm.IsVolumeJobParametersProfileArgs{
			Href: pulumi.String("string"),
			Name: pulumi.String("string"),
		},
		Bandwidth: pulumi.Float64(0),
		Iops:      pulumi.Float64(0),
	},
	Start: pulumi.String("string"),
	Timeouts: &ibm.IsVolumeJobTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
	},
})

    resource "ibm_isvolumejob" "isVolumeJobResource" {
  job_type         = "string"
  volume_id        = "string"
  is_volume_job_id = "string"
  limit            = 0
  name             = "string"
  parameters = {
    profile = {
      href = "string"
      name = "string"
    }
    bandwidth = 0
    iops      = 0
  }
  start = "string"
  timeouts = {
    create = "string"
    delete = "string"
  }
}

    var isVolumeJobResource = new IsVolumeJob("isVolumeJobResource", IsVolumeJobArgs.builder()
    .jobType("string")
    .volumeId("string")
    .isVolumeJobId("string")
    .limit(0.0)
    .name("string")
    .parameters(IsVolumeJobParametersArgs.builder()
        .profile(IsVolumeJobParametersProfileArgs.builder()
            .href("string")
            .name("string")
            .build())
        .bandwidth(0.0)
        .iops(0.0)
        .build())
    .start("string")
    .timeouts(IsVolumeJobTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .build());

    is_volume_job_resource = ibm.IsVolumeJob("isVolumeJobResource",
    job_type="string",
    volume_id="string",
    is_volume_job_id="string",
    limit=float(0),
    name="string",
    parameters={
        "profile": {
            "href": "string",
            "name": "string",
        },
        "bandwidth": float(0),
        "iops": float(0),
    },
    start="string",
    timeouts={
        "create": "string",
        "delete": "string",
    })

    const isVolumeJobResource = new ibm.IsVolumeJob("isVolumeJobResource", {
    jobType: "string",
    volumeId: "string",
    isVolumeJobId: "string",
    limit: 0,
    name: "string",
    parameters: {
        profile: {
            href: "string",
            name: "string",
        },
        bandwidth: 0,
        iops: 0,
    },
    start: "string",
    timeouts: {
        create: "string",
        "delete": "string",
    },
});

    type: ibm:IsVolumeJob
properties:
    isVolumeJobId: string
    jobType: string
    limit: 0
    name: string
    parameters:
        bandwidth: 0
        iops: 0
        profile:
            href: string
            name: string
    start: string
    timeouts:
        create: string
        delete: string
    volumeId: string

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

    JobType string
    The type of volume job.The enumerated values for this property may expand in the future. Constraints: Allowable values are: migrate.
    VolumeId string
    The volume identifier.
    IsVolumeJobId string
    The unique identifier of the ibm.IsVolumeJob. <volume_id>/<volume_job_id>
    Limit double
    The number of resources to return on a page.
    Name string
    The name for this volume job. The name must not be used by another volume job for this volume.
    Parameters IsVolumeJobParameters

    The parameters to use after the volume is migrated.

    Nested schema for parameters:

    Start string
    A server-provided token determining what resource to start the page on.
    Timeouts IsVolumeJobTimeouts
    JobType string
    The type of volume job.The enumerated values for this property may expand in the future. Constraints: Allowable values are: migrate.
    VolumeId string
    The volume identifier.
    IsVolumeJobId string
    The unique identifier of the ibm.IsVolumeJob. <volume_id>/<volume_job_id>
    Limit float64
    The number of resources to return on a page.
    Name string
    The name for this volume job. The name must not be used by another volume job for this volume.
    Parameters IsVolumeJobParametersArgs

    The parameters to use after the volume is migrated.

    Nested schema for parameters:

    Start string
    A server-provided token determining what resource to start the page on.
    Timeouts IsVolumeJobTimeoutsArgs
    job_type string
    The type of volume job.The enumerated values for this property may expand in the future. Constraints: Allowable values are: migrate.
    volume_id string
    The volume identifier.
    is_volume_job_id string
    The unique identifier of the ibm.IsVolumeJob. <volume_id>/<volume_job_id>
    limit number
    The number of resources to return on a page.
    name string
    The name for this volume job. The name must not be used by another volume job for this volume.
    parameters object

    The parameters to use after the volume is migrated.

    Nested schema for parameters:

    start string
    A server-provided token determining what resource to start the page on.
    timeouts object
    jobType String
    The type of volume job.The enumerated values for this property may expand in the future. Constraints: Allowable values are: migrate.
    volumeId String
    The volume identifier.
    isVolumeJobId String
    The unique identifier of the ibm.IsVolumeJob. <volume_id>/<volume_job_id>
    limit Double
    The number of resources to return on a page.
    name String
    The name for this volume job. The name must not be used by another volume job for this volume.
    parameters IsVolumeJobParameters

    The parameters to use after the volume is migrated.

    Nested schema for parameters:

    start String
    A server-provided token determining what resource to start the page on.
    timeouts IsVolumeJobTimeouts
    jobType string
    The type of volume job.The enumerated values for this property may expand in the future. Constraints: Allowable values are: migrate.
    volumeId string
    The volume identifier.
    isVolumeJobId string
    The unique identifier of the ibm.IsVolumeJob. <volume_id>/<volume_job_id>
    limit number
    The number of resources to return on a page.
    name string
    The name for this volume job. The name must not be used by another volume job for this volume.
    parameters IsVolumeJobParameters

    The parameters to use after the volume is migrated.

    Nested schema for parameters:

    start string
    A server-provided token determining what resource to start the page on.
    timeouts IsVolumeJobTimeouts
    job_type str
    The type of volume job.The enumerated values for this property may expand in the future. Constraints: Allowable values are: migrate.
    volume_id str
    The volume identifier.
    is_volume_job_id str
    The unique identifier of the ibm.IsVolumeJob. <volume_id>/<volume_job_id>
    limit float
    The number of resources to return on a page.
    name str
    The name for this volume job. The name must not be used by another volume job for this volume.
    parameters IsVolumeJobParametersArgs

    The parameters to use after the volume is migrated.

    Nested schema for parameters:

    start str
    A server-provided token determining what resource to start the page on.
    timeouts IsVolumeJobTimeoutsArgs
    jobType String
    The type of volume job.The enumerated values for this property may expand in the future. Constraints: Allowable values are: migrate.
    volumeId String
    The volume identifier.
    isVolumeJobId String
    The unique identifier of the ibm.IsVolumeJob. <volume_id>/<volume_job_id>
    limit Number
    The number of resources to return on a page.
    name String
    The name for this volume job. The name must not be used by another volume job for this volume.
    parameters Property Map

    The parameters to use after the volume is migrated.

    Nested schema for parameters:

    start String
    A server-provided token determining what resource to start the page on.
    timeouts Property Map

    Outputs

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

    AutoDelete bool
    (Boolean) Indicates whether this volume job will be automatically deleted after it completes. At present, this is always false, but may be modifiable in the future.
    CompletedAt string
    (String) The date and time that the volume job was completed.If absent, the volume job has not yet completed.
    CreatedAt string
    (String) The date and time that the volume job was created.
    EstimatedCompletionAt string
    (String) The date and time that the volume job is estimated to complete.If absent, the volume job is still queued and has not yet started.
    Href string
    (String) The URL for this volume job.
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceType string
    (String) The resource type. Constraints: Allowable values are: volume_job.
    StartedAt string
    (String) The date and time that the volume job was started.If absent, the volume job has not yet started.
    Status string
    (String) The status of this volume job:
    StatusReasons List<IsVolumeJobStatusReason>
    (List) The reasons for the current status (if any).
    VolumeJobId string
    (String) The unique identifier for this volume job.
    AutoDelete bool
    (Boolean) Indicates whether this volume job will be automatically deleted after it completes. At present, this is always false, but may be modifiable in the future.
    CompletedAt string
    (String) The date and time that the volume job was completed.If absent, the volume job has not yet completed.
    CreatedAt string
    (String) The date and time that the volume job was created.
    EstimatedCompletionAt string
    (String) The date and time that the volume job is estimated to complete.If absent, the volume job is still queued and has not yet started.
    Href string
    (String) The URL for this volume job.
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceType string
    (String) The resource type. Constraints: Allowable values are: volume_job.
    StartedAt string
    (String) The date and time that the volume job was started.If absent, the volume job has not yet started.
    Status string
    (String) The status of this volume job:
    StatusReasons []IsVolumeJobStatusReason
    (List) The reasons for the current status (if any).
    VolumeJobId string
    (String) The unique identifier for this volume job.
    auto_delete bool
    (Boolean) Indicates whether this volume job will be automatically deleted after it completes. At present, this is always false, but may be modifiable in the future.
    completed_at string
    (String) The date and time that the volume job was completed.If absent, the volume job has not yet completed.
    created_at string
    (String) The date and time that the volume job was created.
    estimated_completion_at string
    (String) The date and time that the volume job is estimated to complete.If absent, the volume job is still queued and has not yet started.
    href string
    (String) The URL for this volume job.
    id string
    The provider-assigned unique ID for this managed resource.
    resource_type string
    (String) The resource type. Constraints: Allowable values are: volume_job.
    started_at string
    (String) The date and time that the volume job was started.If absent, the volume job has not yet started.
    status string
    (String) The status of this volume job:
    status_reasons list(object)
    (List) The reasons for the current status (if any).
    volume_job_id string
    (String) The unique identifier for this volume job.
    autoDelete Boolean
    (Boolean) Indicates whether this volume job will be automatically deleted after it completes. At present, this is always false, but may be modifiable in the future.
    completedAt String
    (String) The date and time that the volume job was completed.If absent, the volume job has not yet completed.
    createdAt String
    (String) The date and time that the volume job was created.
    estimatedCompletionAt String
    (String) The date and time that the volume job is estimated to complete.If absent, the volume job is still queued and has not yet started.
    href String
    (String) The URL for this volume job.
    id String
    The provider-assigned unique ID for this managed resource.
    resourceType String
    (String) The resource type. Constraints: Allowable values are: volume_job.
    startedAt String
    (String) The date and time that the volume job was started.If absent, the volume job has not yet started.
    status String
    (String) The status of this volume job:
    statusReasons List<IsVolumeJobStatusReason>
    (List) The reasons for the current status (if any).
    volumeJobId String
    (String) The unique identifier for this volume job.
    autoDelete boolean
    (Boolean) Indicates whether this volume job will be automatically deleted after it completes. At present, this is always false, but may be modifiable in the future.
    completedAt string
    (String) The date and time that the volume job was completed.If absent, the volume job has not yet completed.
    createdAt string
    (String) The date and time that the volume job was created.
    estimatedCompletionAt string
    (String) The date and time that the volume job is estimated to complete.If absent, the volume job is still queued and has not yet started.
    href string
    (String) The URL for this volume job.
    id string
    The provider-assigned unique ID for this managed resource.
    resourceType string
    (String) The resource type. Constraints: Allowable values are: volume_job.
    startedAt string
    (String) The date and time that the volume job was started.If absent, the volume job has not yet started.
    status string
    (String) The status of this volume job:
    statusReasons IsVolumeJobStatusReason[]
    (List) The reasons for the current status (if any).
    volumeJobId string
    (String) The unique identifier for this volume job.
    auto_delete bool
    (Boolean) Indicates whether this volume job will be automatically deleted after it completes. At present, this is always false, but may be modifiable in the future.
    completed_at str
    (String) The date and time that the volume job was completed.If absent, the volume job has not yet completed.
    created_at str
    (String) The date and time that the volume job was created.
    estimated_completion_at str
    (String) The date and time that the volume job is estimated to complete.If absent, the volume job is still queued and has not yet started.
    href str
    (String) The URL for this volume job.
    id str
    The provider-assigned unique ID for this managed resource.
    resource_type str
    (String) The resource type. Constraints: Allowable values are: volume_job.
    started_at str
    (String) The date and time that the volume job was started.If absent, the volume job has not yet started.
    status str
    (String) The status of this volume job:
    status_reasons Sequence[IsVolumeJobStatusReason]
    (List) The reasons for the current status (if any).
    volume_job_id str
    (String) The unique identifier for this volume job.
    autoDelete Boolean
    (Boolean) Indicates whether this volume job will be automatically deleted after it completes. At present, this is always false, but may be modifiable in the future.
    completedAt String
    (String) The date and time that the volume job was completed.If absent, the volume job has not yet completed.
    createdAt String
    (String) The date and time that the volume job was created.
    estimatedCompletionAt String
    (String) The date and time that the volume job is estimated to complete.If absent, the volume job is still queued and has not yet started.
    href String
    (String) The URL for this volume job.
    id String
    The provider-assigned unique ID for this managed resource.
    resourceType String
    (String) The resource type. Constraints: Allowable values are: volume_job.
    startedAt String
    (String) The date and time that the volume job was started.If absent, the volume job has not yet started.
    status String
    (String) The status of this volume job:
    statusReasons List<Property Map>
    (List) The reasons for the current status (if any).
    volumeJobId String
    (String) The unique identifier for this volume job.

    Look up Existing IsVolumeJob Resource

    Get an existing IsVolumeJob 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?: IsVolumeJobState, opts?: CustomResourceOptions): IsVolumeJob
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_delete: Optional[bool] = None,
        completed_at: Optional[str] = None,
        created_at: Optional[str] = None,
        estimated_completion_at: Optional[str] = None,
        href: Optional[str] = None,
        is_volume_job_id: Optional[str] = None,
        job_type: Optional[str] = None,
        limit: Optional[float] = None,
        name: Optional[str] = None,
        parameters: Optional[IsVolumeJobParametersArgs] = None,
        resource_type: Optional[str] = None,
        start: Optional[str] = None,
        started_at: Optional[str] = None,
        status: Optional[str] = None,
        status_reasons: Optional[Sequence[IsVolumeJobStatusReasonArgs]] = None,
        timeouts: Optional[IsVolumeJobTimeoutsArgs] = None,
        volume_id: Optional[str] = None,
        volume_job_id: Optional[str] = None) -> IsVolumeJob
    func GetIsVolumeJob(ctx *Context, name string, id IDInput, state *IsVolumeJobState, opts ...ResourceOption) (*IsVolumeJob, error)
    public static IsVolumeJob Get(string name, Input<string> id, IsVolumeJobState? state, CustomResourceOptions? opts = null)
    public static IsVolumeJob get(String name, Output<String> id, IsVolumeJobState state, CustomResourceOptions options)
    resources:  _:    type: ibm:IsVolumeJob    get:      id: ${id}
    import {
  to = ibm_isvolumejob.example
  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:
    AutoDelete bool
    (Boolean) Indicates whether this volume job will be automatically deleted after it completes. At present, this is always false, but may be modifiable in the future.
    CompletedAt string
    (String) The date and time that the volume job was completed.If absent, the volume job has not yet completed.
    CreatedAt string
    (String) The date and time that the volume job was created.
    EstimatedCompletionAt string
    (String) The date and time that the volume job is estimated to complete.If absent, the volume job is still queued and has not yet started.
    Href string
    (String) The URL for this volume job.
    IsVolumeJobId string
    The unique identifier of the ibm.IsVolumeJob. <volume_id>/<volume_job_id>
    JobType string
    The type of volume job.The enumerated values for this property may expand in the future. Constraints: Allowable values are: migrate.
    Limit double
    The number of resources to return on a page.
    Name string
    The name for this volume job. The name must not be used by another volume job for this volume.
    Parameters IsVolumeJobParameters

    The parameters to use after the volume is migrated.

    Nested schema for parameters:

    ResourceType string
    (String) The resource type. Constraints: Allowable values are: volume_job.
    Start string
    A server-provided token determining what resource to start the page on.
    StartedAt string
    (String) The date and time that the volume job was started.If absent, the volume job has not yet started.
    Status string
    (String) The status of this volume job:
    StatusReasons List<IsVolumeJobStatusReason>
    (List) The reasons for the current status (if any).
    Timeouts IsVolumeJobTimeouts
    VolumeId string
    The volume identifier.
    VolumeJobId string
    (String) The unique identifier for this volume job.
    AutoDelete bool
    (Boolean) Indicates whether this volume job will be automatically deleted after it completes. At present, this is always false, but may be modifiable in the future.
    CompletedAt string
    (String) The date and time that the volume job was completed.If absent, the volume job has not yet completed.
    CreatedAt string
    (String) The date and time that the volume job was created.
    EstimatedCompletionAt string
    (String) The date and time that the volume job is estimated to complete.If absent, the volume job is still queued and has not yet started.
    Href string
    (String) The URL for this volume job.
    IsVolumeJobId string
    The unique identifier of the ibm.IsVolumeJob. <volume_id>/<volume_job_id>
    JobType string
    The type of volume job.The enumerated values for this property may expand in the future. Constraints: Allowable values are: migrate.
    Limit float64
    The number of resources to return on a page.
    Name string
    The name for this volume job. The name must not be used by another volume job for this volume.
    Parameters IsVolumeJobParametersArgs

    The parameters to use after the volume is migrated.

    Nested schema for parameters:

    ResourceType string
    (String) The resource type. Constraints: Allowable values are: volume_job.
    Start string
    A server-provided token determining what resource to start the page on.
    StartedAt string
    (String) The date and time that the volume job was started.If absent, the volume job has not yet started.
    Status string
    (String) The status of this volume job:
    StatusReasons []IsVolumeJobStatusReasonArgs
    (List) The reasons for the current status (if any).
    Timeouts IsVolumeJobTimeoutsArgs
    VolumeId string
    The volume identifier.
    VolumeJobId string
    (String) The unique identifier for this volume job.
    auto_delete bool
    (Boolean) Indicates whether this volume job will be automatically deleted after it completes. At present, this is always false, but may be modifiable in the future.
    completed_at string
    (String) The date and time that the volume job was completed.If absent, the volume job has not yet completed.
    created_at string
    (String) The date and time that the volume job was created.
    estimated_completion_at string
    (String) The date and time that the volume job is estimated to complete.If absent, the volume job is still queued and has not yet started.
    href string
    (String) The URL for this volume job.
    is_volume_job_id string
    The unique identifier of the ibm.IsVolumeJob. <volume_id>/<volume_job_id>
    job_type string
    The type of volume job.The enumerated values for this property may expand in the future. Constraints: Allowable values are: migrate.
    limit number
    The number of resources to return on a page.
    name string
    The name for this volume job. The name must not be used by another volume job for this volume.
    parameters object

    The parameters to use after the volume is migrated.

    Nested schema for parameters:

    resource_type string
    (String) The resource type. Constraints: Allowable values are: volume_job.
    start string
    A server-provided token determining what resource to start the page on.
    started_at string
    (String) The date and time that the volume job was started.If absent, the volume job has not yet started.
    status string
    (String) The status of this volume job:
    status_reasons list(object)
    (List) The reasons for the current status (if any).
    timeouts object
    volume_id string
    The volume identifier.
    volume_job_id string
    (String) The unique identifier for this volume job.
    autoDelete Boolean
    (Boolean) Indicates whether this volume job will be automatically deleted after it completes. At present, this is always false, but may be modifiable in the future.
    completedAt String
    (String) The date and time that the volume job was completed.If absent, the volume job has not yet completed.
    createdAt String
    (String) The date and time that the volume job was created.
    estimatedCompletionAt String
    (String) The date and time that the volume job is estimated to complete.If absent, the volume job is still queued and has not yet started.
    href String
    (String) The URL for this volume job.
    isVolumeJobId String
    The unique identifier of the ibm.IsVolumeJob. <volume_id>/<volume_job_id>
    jobType String
    The type of volume job.The enumerated values for this property may expand in the future. Constraints: Allowable values are: migrate.
    limit Double
    The number of resources to return on a page.
    name String
    The name for this volume job. The name must not be used by another volume job for this volume.
    parameters IsVolumeJobParameters

    The parameters to use after the volume is migrated.

    Nested schema for parameters:

    resourceType String
    (String) The resource type. Constraints: Allowable values are: volume_job.
    start String
    A server-provided token determining what resource to start the page on.
    startedAt String
    (String) The date and time that the volume job was started.If absent, the volume job has not yet started.
    status String
    (String) The status of this volume job:
    statusReasons List<IsVolumeJobStatusReason>
    (List) The reasons for the current status (if any).
    timeouts IsVolumeJobTimeouts
    volumeId String
    The volume identifier.
    volumeJobId String
    (String) The unique identifier for this volume job.
    autoDelete boolean
    (Boolean) Indicates whether this volume job will be automatically deleted after it completes. At present, this is always false, but may be modifiable in the future.
    completedAt string
    (String) The date and time that the volume job was completed.If absent, the volume job has not yet completed.
    createdAt string
    (String) The date and time that the volume job was created.
    estimatedCompletionAt string
    (String) The date and time that the volume job is estimated to complete.If absent, the volume job is still queued and has not yet started.
    href string
    (String) The URL for this volume job.
    isVolumeJobId string
    The unique identifier of the ibm.IsVolumeJob. <volume_id>/<volume_job_id>
    jobType string
    The type of volume job.The enumerated values for this property may expand in the future. Constraints: Allowable values are: migrate.
    limit number
    The number of resources to return on a page.
    name string
    The name for this volume job. The name must not be used by another volume job for this volume.
    parameters IsVolumeJobParameters

    The parameters to use after the volume is migrated.

    Nested schema for parameters:

    resourceType string
    (String) The resource type. Constraints: Allowable values are: volume_job.
    start string
    A server-provided token determining what resource to start the page on.
    startedAt string
    (String) The date and time that the volume job was started.If absent, the volume job has not yet started.
    status string
    (String) The status of this volume job:
    statusReasons IsVolumeJobStatusReason[]
    (List) The reasons for the current status (if any).
    timeouts IsVolumeJobTimeouts
    volumeId string
    The volume identifier.
    volumeJobId string
    (String) The unique identifier for this volume job.
    auto_delete bool
    (Boolean) Indicates whether this volume job will be automatically deleted after it completes. At present, this is always false, but may be modifiable in the future.
    completed_at str
    (String) The date and time that the volume job was completed.If absent, the volume job has not yet completed.
    created_at str
    (String) The date and time that the volume job was created.
    estimated_completion_at str
    (String) The date and time that the volume job is estimated to complete.If absent, the volume job is still queued and has not yet started.
    href str
    (String) The URL for this volume job.
    is_volume_job_id str
    The unique identifier of the ibm.IsVolumeJob. <volume_id>/<volume_job_id>
    job_type str
    The type of volume job.The enumerated values for this property may expand in the future. Constraints: Allowable values are: migrate.
    limit float
    The number of resources to return on a page.
    name str
    The name for this volume job. The name must not be used by another volume job for this volume.
    parameters IsVolumeJobParametersArgs

    The parameters to use after the volume is migrated.

    Nested schema for parameters:

    resource_type str
    (String) The resource type. Constraints: Allowable values are: volume_job.
    start str
    A server-provided token determining what resource to start the page on.
    started_at str
    (String) The date and time that the volume job was started.If absent, the volume job has not yet started.
    status str
    (String) The status of this volume job:
    status_reasons Sequence[IsVolumeJobStatusReasonArgs]
    (List) The reasons for the current status (if any).
    timeouts IsVolumeJobTimeoutsArgs
    volume_id str
    The volume identifier.
    volume_job_id str
    (String) The unique identifier for this volume job.
    autoDelete Boolean
    (Boolean) Indicates whether this volume job will be automatically deleted after it completes. At present, this is always false, but may be modifiable in the future.
    completedAt String
    (String) The date and time that the volume job was completed.If absent, the volume job has not yet completed.
    createdAt String
    (String) The date and time that the volume job was created.
    estimatedCompletionAt String
    (String) The date and time that the volume job is estimated to complete.If absent, the volume job is still queued and has not yet started.
    href String
    (String) The URL for this volume job.
    isVolumeJobId String
    The unique identifier of the ibm.IsVolumeJob. <volume_id>/<volume_job_id>
    jobType String
    The type of volume job.The enumerated values for this property may expand in the future. Constraints: Allowable values are: migrate.
    limit Number
    The number of resources to return on a page.
    name String
    The name for this volume job. The name must not be used by another volume job for this volume.
    parameters Property Map

    The parameters to use after the volume is migrated.

    Nested schema for parameters:

    resourceType String
    (String) The resource type. Constraints: Allowable values are: volume_job.
    start String
    A server-provided token determining what resource to start the page on.
    startedAt String
    (String) The date and time that the volume job was started.If absent, the volume job has not yet started.
    status String
    (String) The status of this volume job:
    statusReasons List<Property Map>
    (List) The reasons for the current status (if any).
    timeouts Property Map
    volumeId String
    The volume identifier.
    volumeJobId String
    (String) The unique identifier for this volume job.

    Supporting Types

    IsVolumeJobParameters, IsVolumeJobParametersArgs

    Profile IsVolumeJobParametersProfile

    Identifies a volume profile by a unique property.

    Nested schema for profile:

    Bandwidth double
    The maximum bandwidth (in megabits per second) for the volume.If specified, the volume profile must not have a bandwidth.type of dependent. Constraints: The maximum value is 8192. The minimum value is 1000.
    Iops double
    The maximum I/O operations per second (IOPS) for this volume.If specified, the volume profile must not have a iops.type of dependent.
    Profile IsVolumeJobParametersProfile

    Identifies a volume profile by a unique property.

    Nested schema for profile:

    Bandwidth float64
    The maximum bandwidth (in megabits per second) for the volume.If specified, the volume profile must not have a bandwidth.type of dependent. Constraints: The maximum value is 8192. The minimum value is 1000.
    Iops float64
    The maximum I/O operations per second (IOPS) for this volume.If specified, the volume profile must not have a iops.type of dependent.
    profile object

    Identifies a volume profile by a unique property.

    Nested schema for profile:

    bandwidth number
    The maximum bandwidth (in megabits per second) for the volume.If specified, the volume profile must not have a bandwidth.type of dependent. Constraints: The maximum value is 8192. The minimum value is 1000.
    iops number
    The maximum I/O operations per second (IOPS) for this volume.If specified, the volume profile must not have a iops.type of dependent.
    profile IsVolumeJobParametersProfile

    Identifies a volume profile by a unique property.

    Nested schema for profile:

    bandwidth Double
    The maximum bandwidth (in megabits per second) for the volume.If specified, the volume profile must not have a bandwidth.type of dependent. Constraints: The maximum value is 8192. The minimum value is 1000.
    iops Double
    The maximum I/O operations per second (IOPS) for this volume.If specified, the volume profile must not have a iops.type of dependent.
    profile IsVolumeJobParametersProfile

    Identifies a volume profile by a unique property.

    Nested schema for profile:

    bandwidth number
    The maximum bandwidth (in megabits per second) for the volume.If specified, the volume profile must not have a bandwidth.type of dependent. Constraints: The maximum value is 8192. The minimum value is 1000.
    iops number
    The maximum I/O operations per second (IOPS) for this volume.If specified, the volume profile must not have a iops.type of dependent.
    profile IsVolumeJobParametersProfile

    Identifies a volume profile by a unique property.

    Nested schema for profile:

    bandwidth float
    The maximum bandwidth (in megabits per second) for the volume.If specified, the volume profile must not have a bandwidth.type of dependent. Constraints: The maximum value is 8192. The minimum value is 1000.
    iops float
    The maximum I/O operations per second (IOPS) for this volume.If specified, the volume profile must not have a iops.type of dependent.
    profile Property Map

    Identifies a volume profile by a unique property.

    Nested schema for profile:

    bandwidth Number
    The maximum bandwidth (in megabits per second) for the volume.If specified, the volume profile must not have a bandwidth.type of dependent. Constraints: The maximum value is 8192. The minimum value is 1000.
    iops Number
    The maximum I/O operations per second (IOPS) for this volume.If specified, the volume profile must not have a iops.type of dependent.

    IsVolumeJobParametersProfile, IsVolumeJobParametersProfileArgs

    Href string
    The URL for this volume profile.
    Name string
    The globally unique name for this volume profile.
    Href string
    The URL for this volume profile.
    Name string
    The globally unique name for this volume profile.
    href string
    The URL for this volume profile.
    name string
    The globally unique name for this volume profile.
    href String
    The URL for this volume profile.
    name String
    The globally unique name for this volume profile.
    href string
    The URL for this volume profile.
    name string
    The globally unique name for this volume profile.
    href str
    The URL for this volume profile.
    name str
    The globally unique name for this volume profile.
    href String
    The URL for this volume profile.
    name String
    The globally unique name for this volume profile.

    IsVolumeJobStatusReason, IsVolumeJobStatusReasonArgs

    Code string
    (String) A snake case string succinctly identifying the status reason.The enumerated values for this property may expand in the future. Constraints: Allowable values are: internal_error, virtual_instance_powered_off, volume_detached_from_virtual_instance. T
    Message string
    (String) An explanation of the status reason.
    MoreInfo string
    (String) A link to documentation about this status reason.
    Code string
    (String) A snake case string succinctly identifying the status reason.The enumerated values for this property may expand in the future. Constraints: Allowable values are: internal_error, virtual_instance_powered_off, volume_detached_from_virtual_instance. T
    Message string
    (String) An explanation of the status reason.
    MoreInfo string
    (String) A link to documentation about this status reason.
    code string
    (String) A snake case string succinctly identifying the status reason.The enumerated values for this property may expand in the future. Constraints: Allowable values are: internal_error, virtual_instance_powered_off, volume_detached_from_virtual_instance. T
    message string
    (String) An explanation of the status reason.
    more_info string
    (String) A link to documentation about this status reason.
    code String
    (String) A snake case string succinctly identifying the status reason.The enumerated values for this property may expand in the future. Constraints: Allowable values are: internal_error, virtual_instance_powered_off, volume_detached_from_virtual_instance. T
    message String
    (String) An explanation of the status reason.
    moreInfo String
    (String) A link to documentation about this status reason.
    code string
    (String) A snake case string succinctly identifying the status reason.The enumerated values for this property may expand in the future. Constraints: Allowable values are: internal_error, virtual_instance_powered_off, volume_detached_from_virtual_instance. T
    message string
    (String) An explanation of the status reason.
    moreInfo string
    (String) A link to documentation about this status reason.
    code str
    (String) A snake case string succinctly identifying the status reason.The enumerated values for this property may expand in the future. Constraints: Allowable values are: internal_error, virtual_instance_powered_off, volume_detached_from_virtual_instance. T
    message str
    (String) An explanation of the status reason.
    more_info str
    (String) A link to documentation about this status reason.
    code String
    (String) A snake case string succinctly identifying the status reason.The enumerated values for this property may expand in the future. Constraints: Allowable values are: internal_error, virtual_instance_powered_off, volume_detached_from_virtual_instance. T
    message String
    (String) An explanation of the status reason.
    moreInfo String
    (String) A link to documentation about this status reason.

    IsVolumeJobTimeouts, IsVolumeJobTimeoutsArgs

    Create string
    Delete string
    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

    You can import the ibm_is_volume_job resource by using id.

    The id property can be formed from volume_id, and volume_job_id in the following format:

    
<volume_id>/<volume_job_id>

    • volume_id: A string. The volume identifier.

    • volume_job_id: A string in the format r006-095e9baf-01d4-4e29-986e-20d26606b82a. The unique identifier for this volume job.

    Syntax

    
```sh
$ pulumi import ibm:index/isVolumeJob:IsVolumeJob is_volume_job <volume_id>/<volume_job_id>
```

    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.
    Viewing docs for ibm 2.1.0
    published on Tuesday, May 5, 2026 by ibm-cloud
    Schema (JSON)
    ibm-cloud/terraform-provider-ibm
      Try Pulumi Cloud free. Your team will thank you.