1. Packages
  2. Packages
  3. Ibm Provider
  4. API Docs
  5. IsVolumeJobCancel
Viewing docs for ibm 2.1.0
published on Tuesday, May 5, 2026 by ibm-cloud
Viewing docs for ibm 2.1.0
published on Tuesday, May 5, 2026 by ibm-cloud

    Cancel ibm.IsVolumeJob with this resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const example = new ibm.IsVolumeJob("example", {
        volumeId: exampleIbmIsVolume.id,
        jobType: "migrate",
        name: "my-volume-job",
        parameters: {
            bandwidth: 1000,
            iops: 10000,
            profile: {
                name: "sdp",
            },
        },
    });
    const cancelMigration = new ibm.IsVolumeJobCancel("cancel_migration", {
        volumeId: example.volumeId,
        volumeJobId: example.volumeJobId,
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    example = ibm.IsVolumeJob("example",
        volume_id=example_ibm_is_volume["id"],
        job_type="migrate",
        name="my-volume-job",
        parameters={
            "bandwidth": 1000,
            "iops": 10000,
            "profile": {
                "name": "sdp",
            },
        })
    cancel_migration = ibm.IsVolumeJobCancel("cancel_migration",
        volume_id=example.volume_id,
        volume_job_id=example.volume_job_id)
    
    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.NewIsVolumeJob(ctx, "example", &ibm.IsVolumeJobArgs{
    			VolumeId: pulumi.Any(exampleIbmIsVolume.Id),
    			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
    		}
    		_, err = ibm.NewIsVolumeJobCancel(ctx, "cancel_migration", &ibm.IsVolumeJobCancelArgs{
    			VolumeId:    example.VolumeId,
    			VolumeJobId: example.VolumeJobId,
    		})
    		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.IsVolumeJob("example", new()
        {
            VolumeId = exampleIbmIsVolume.Id,
            JobType = "migrate",
            Name = "my-volume-job",
            Parameters = new Ibm.Inputs.IsVolumeJobParametersArgs
            {
                Bandwidth = 1000,
                Iops = 10000,
                Profile = new Ibm.Inputs.IsVolumeJobParametersProfileArgs
                {
                    Name = "sdp",
                },
            },
        });
    
        var cancelMigration = new Ibm.IsVolumeJobCancel("cancel_migration", new()
        {
            VolumeId = example.VolumeId,
            VolumeJobId = example.VolumeJobId,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IsVolumeJob;
    import com.pulumi.ibm.IsVolumeJobArgs;
    import com.pulumi.ibm.inputs.IsVolumeJobParametersArgs;
    import com.pulumi.ibm.inputs.IsVolumeJobParametersProfileArgs;
    import com.pulumi.ibm.IsVolumeJobCancel;
    import com.pulumi.ibm.IsVolumeJobCancelArgs;
    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 IsVolumeJob("example", IsVolumeJobArgs.builder()
                .volumeId(exampleIbmIsVolume.id())
                .jobType("migrate")
                .name("my-volume-job")
                .parameters(IsVolumeJobParametersArgs.builder()
                    .bandwidth(1000.0)
                    .iops(10000.0)
                    .profile(IsVolumeJobParametersProfileArgs.builder()
                        .name("sdp")
                        .build())
                    .build())
                .build());
    
            var cancelMigration = new IsVolumeJobCancel("cancelMigration", IsVolumeJobCancelArgs.builder()
                .volumeId(example.volumeId())
                .volumeJobId(example.volumeJobId())
                .build());
    
        }
    }
    
    resources:
      example:
        type: ibm:IsVolumeJob
        properties:
          volumeId: ${exampleIbmIsVolume.id}
          jobType: migrate
          name: my-volume-job
          parameters:
            bandwidth: 1000
            iops: 10000
            profile:
              name: sdp
      cancelMigration:
        type: ibm:IsVolumeJobCancel
        name: cancel_migration
        properties:
          volumeId: ${example.volumeId}
          volumeJobId: ${example.volumeJobId}
    
    Example coming soon!
    

    Create IsVolumeJobCancel Resource

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

    Constructor syntax

    new IsVolumeJobCancel(name: string, args: IsVolumeJobCancelArgs, opts?: CustomResourceOptions);
    @overload
    def IsVolumeJobCancel(resource_name: str,
                          args: IsVolumeJobCancelArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def IsVolumeJobCancel(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          volume_id: Optional[str] = None,
                          volume_job_id: Optional[str] = None,
                          is_volume_job_cancel_id: Optional[str] = None)
    func NewIsVolumeJobCancel(ctx *Context, name string, args IsVolumeJobCancelArgs, opts ...ResourceOption) (*IsVolumeJobCancel, error)
    public IsVolumeJobCancel(string name, IsVolumeJobCancelArgs args, CustomResourceOptions? opts = null)
    public IsVolumeJobCancel(String name, IsVolumeJobCancelArgs args)
    public IsVolumeJobCancel(String name, IsVolumeJobCancelArgs args, CustomResourceOptions options)
    
    type: ibm:IsVolumeJobCancel
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "ibm_isvolumejobcancel" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args IsVolumeJobCancelArgs
    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 IsVolumeJobCancelArgs
    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 IsVolumeJobCancelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IsVolumeJobCancelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IsVolumeJobCancelArgs
    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 isVolumeJobCancelResource = new Ibm.IsVolumeJobCancel("isVolumeJobCancelResource", new()
    {
        VolumeId = "string",
        VolumeJobId = "string",
        IsVolumeJobCancelId = "string",
    });
    
    example, err := ibm.NewIsVolumeJobCancel(ctx, "isVolumeJobCancelResource", &ibm.IsVolumeJobCancelArgs{
    	VolumeId:            pulumi.String("string"),
    	VolumeJobId:         pulumi.String("string"),
    	IsVolumeJobCancelId: pulumi.String("string"),
    })
    
    resource "ibm_isvolumejobcancel" "isVolumeJobCancelResource" {
      volume_id               = "string"
      volume_job_id           = "string"
      is_volume_job_cancel_id = "string"
    }
    
    var isVolumeJobCancelResource = new IsVolumeJobCancel("isVolumeJobCancelResource", IsVolumeJobCancelArgs.builder()
        .volumeId("string")
        .volumeJobId("string")
        .isVolumeJobCancelId("string")
        .build());
    
    is_volume_job_cancel_resource = ibm.IsVolumeJobCancel("isVolumeJobCancelResource",
        volume_id="string",
        volume_job_id="string",
        is_volume_job_cancel_id="string")
    
    const isVolumeJobCancelResource = new ibm.IsVolumeJobCancel("isVolumeJobCancelResource", {
        volumeId: "string",
        volumeJobId: "string",
        isVolumeJobCancelId: "string",
    });
    
    type: ibm:IsVolumeJobCancel
    properties:
        isVolumeJobCancelId: string
        volumeId: string
        volumeJobId: string
    

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

    VolumeId string
    The volume identifier.
    VolumeJobId string
    The volume job identifier.
    IsVolumeJobCancelId string
    The unique identifier of the is_volume_job_cancel.
    VolumeId string
    The volume identifier.
    VolumeJobId string
    The volume job identifier.
    IsVolumeJobCancelId string
    The unique identifier of the is_volume_job_cancel.
    volume_id string
    The volume identifier.
    volume_job_id string
    The volume job identifier.
    is_volume_job_cancel_id string
    The unique identifier of the is_volume_job_cancel.
    volumeId String
    The volume identifier.
    volumeJobId String
    The volume job identifier.
    isVolumeJobCancelId String
    The unique identifier of the is_volume_job_cancel.
    volumeId string
    The volume identifier.
    volumeJobId string
    The volume job identifier.
    isVolumeJobCancelId string
    The unique identifier of the is_volume_job_cancel.
    volume_id str
    The volume identifier.
    volume_job_id str
    The volume job identifier.
    is_volume_job_cancel_id str
    The unique identifier of the is_volume_job_cancel.
    volumeId String
    The volume identifier.
    volumeJobId String
    The volume job identifier.
    isVolumeJobCancelId String
    The unique identifier of the is_volume_job_cancel.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IsVolumeJobCancel 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.
    JobType string
    (String) The type of volume job. Constraints: Allowable values are: migrate.
    Name string
    (String) The globally unique name for this volume profile.
    Parameters List<IsVolumeJobCancelParameter>
    (List) The parameters to use after the volume is migrated.
    ResourceType string
    (String) The resource type. Constraints: Allowable values are: volume_job. T
    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<IsVolumeJobCancelStatusReason>
    (List) The reasons for the current status (if any).

    • Constraints: The minimum length is 0 items. Nested schema for status_reasons:
    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.
    JobType string
    (String) The type of volume job. Constraints: Allowable values are: migrate.
    Name string
    (String) The globally unique name for this volume profile.
    Parameters []IsVolumeJobCancelParameter
    (List) The parameters to use after the volume is migrated.
    ResourceType string
    (String) The resource type. Constraints: Allowable values are: volume_job. T
    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 []IsVolumeJobCancelStatusReason
    (List) The reasons for the current status (if any).

    • Constraints: The minimum length is 0 items. Nested schema for status_reasons:
    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.
    job_type string
    (String) The type of volume job. Constraints: Allowable values are: migrate.
    name string
    (String) The globally unique name for this volume profile.
    parameters list(object)
    (List) The parameters to use after the volume is migrated.
    resource_type string
    (String) The resource type. Constraints: Allowable values are: volume_job. T
    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).

    • Constraints: The minimum length is 0 items. Nested schema for status_reasons:
    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.
    jobType String
    (String) The type of volume job. Constraints: Allowable values are: migrate.
    name String
    (String) The globally unique name for this volume profile.
    parameters List<IsVolumeJobCancelParameter>
    (List) The parameters to use after the volume is migrated.
    resourceType String
    (String) The resource type. Constraints: Allowable values are: volume_job. T
    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<IsVolumeJobCancelStatusReason>
    (List) The reasons for the current status (if any).

    • Constraints: The minimum length is 0 items. Nested schema for status_reasons:
    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.
    jobType string
    (String) The type of volume job. Constraints: Allowable values are: migrate.
    name string
    (String) The globally unique name for this volume profile.
    parameters IsVolumeJobCancelParameter[]
    (List) The parameters to use after the volume is migrated.
    resourceType string
    (String) The resource type. Constraints: Allowable values are: volume_job. T
    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 IsVolumeJobCancelStatusReason[]
    (List) The reasons for the current status (if any).

    • Constraints: The minimum length is 0 items. Nested schema for status_reasons:
    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.
    job_type str
    (String) The type of volume job. Constraints: Allowable values are: migrate.
    name str
    (String) The globally unique name for this volume profile.
    parameters Sequence[IsVolumeJobCancelParameter]
    (List) The parameters to use after the volume is migrated.
    resource_type str
    (String) The resource type. Constraints: Allowable values are: volume_job. T
    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[IsVolumeJobCancelStatusReason]
    (List) The reasons for the current status (if any).

    • Constraints: The minimum length is 0 items. Nested schema for status_reasons:
    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.
    jobType String
    (String) The type of volume job. Constraints: Allowable values are: migrate.
    name String
    (String) The globally unique name for this volume profile.
    parameters List<Property Map>
    (List) The parameters to use after the volume is migrated.
    resourceType String
    (String) The resource type. Constraints: Allowable values are: volume_job. T
    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).

    • Constraints: The minimum length is 0 items. Nested schema for status_reasons:

    Look up Existing IsVolumeJobCancel Resource

    Get an existing IsVolumeJobCancel 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?: IsVolumeJobCancelState, opts?: CustomResourceOptions): IsVolumeJobCancel
    @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_cancel_id: Optional[str] = None,
            job_type: Optional[str] = None,
            name: Optional[str] = None,
            parameters: Optional[Sequence[IsVolumeJobCancelParameterArgs]] = None,
            resource_type: Optional[str] = None,
            started_at: Optional[str] = None,
            status: Optional[str] = None,
            status_reasons: Optional[Sequence[IsVolumeJobCancelStatusReasonArgs]] = None,
            volume_id: Optional[str] = None,
            volume_job_id: Optional[str] = None) -> IsVolumeJobCancel
    func GetIsVolumeJobCancel(ctx *Context, name string, id IDInput, state *IsVolumeJobCancelState, opts ...ResourceOption) (*IsVolumeJobCancel, error)
    public static IsVolumeJobCancel Get(string name, Input<string> id, IsVolumeJobCancelState? state, CustomResourceOptions? opts = null)
    public static IsVolumeJobCancel get(String name, Output<String> id, IsVolumeJobCancelState state, CustomResourceOptions options)
    resources:  _:    type: ibm:IsVolumeJobCancel    get:      id: ${id}
    import {
      to = ibm_isvolumejobcancel.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.
    IsVolumeJobCancelId string
    The unique identifier of the is_volume_job_cancel.
    JobType string
    (String) The type of volume job. Constraints: Allowable values are: migrate.
    Name string
    (String) The globally unique name for this volume profile.
    Parameters List<IsVolumeJobCancelParameter>
    (List) The parameters to use after the volume is migrated.
    ResourceType string
    (String) The resource type. Constraints: Allowable values are: volume_job. T
    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<IsVolumeJobCancelStatusReason>
    (List) The reasons for the current status (if any).

    • Constraints: The minimum length is 0 items. Nested schema for status_reasons:
    VolumeId string
    The volume identifier.
    VolumeJobId string
    The volume job identifier.
    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.
    IsVolumeJobCancelId string
    The unique identifier of the is_volume_job_cancel.
    JobType string
    (String) The type of volume job. Constraints: Allowable values are: migrate.
    Name string
    (String) The globally unique name for this volume profile.
    Parameters []IsVolumeJobCancelParameterArgs
    (List) The parameters to use after the volume is migrated.
    ResourceType string
    (String) The resource type. Constraints: Allowable values are: volume_job. T
    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 []IsVolumeJobCancelStatusReasonArgs
    (List) The reasons for the current status (if any).

    • Constraints: The minimum length is 0 items. Nested schema for status_reasons:
    VolumeId string
    The volume identifier.
    VolumeJobId string
    The volume job identifier.
    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_cancel_id string
    The unique identifier of the is_volume_job_cancel.
    job_type string
    (String) The type of volume job. Constraints: Allowable values are: migrate.
    name string
    (String) The globally unique name for this volume profile.
    parameters list(object)
    (List) The parameters to use after the volume is migrated.
    resource_type string
    (String) The resource type. Constraints: Allowable values are: volume_job. T
    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).

    • Constraints: The minimum length is 0 items. Nested schema for status_reasons:
    volume_id string
    The volume identifier.
    volume_job_id string
    The volume job identifier.
    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.
    isVolumeJobCancelId String
    The unique identifier of the is_volume_job_cancel.
    jobType String
    (String) The type of volume job. Constraints: Allowable values are: migrate.
    name String
    (String) The globally unique name for this volume profile.
    parameters List<IsVolumeJobCancelParameter>
    (List) The parameters to use after the volume is migrated.
    resourceType String
    (String) The resource type. Constraints: Allowable values are: volume_job. T
    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<IsVolumeJobCancelStatusReason>
    (List) The reasons for the current status (if any).

    • Constraints: The minimum length is 0 items. Nested schema for status_reasons:
    volumeId String
    The volume identifier.
    volumeJobId String
    The volume job identifier.
    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.
    isVolumeJobCancelId string
    The unique identifier of the is_volume_job_cancel.
    jobType string
    (String) The type of volume job. Constraints: Allowable values are: migrate.
    name string
    (String) The globally unique name for this volume profile.
    parameters IsVolumeJobCancelParameter[]
    (List) The parameters to use after the volume is migrated.
    resourceType string
    (String) The resource type. Constraints: Allowable values are: volume_job. T
    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 IsVolumeJobCancelStatusReason[]
    (List) The reasons for the current status (if any).

    • Constraints: The minimum length is 0 items. Nested schema for status_reasons:
    volumeId string
    The volume identifier.
    volumeJobId string
    The volume job identifier.
    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_cancel_id str
    The unique identifier of the is_volume_job_cancel.
    job_type str
    (String) The type of volume job. Constraints: Allowable values are: migrate.
    name str
    (String) The globally unique name for this volume profile.
    parameters Sequence[IsVolumeJobCancelParameterArgs]
    (List) The parameters to use after the volume is migrated.
    resource_type str
    (String) The resource type. Constraints: Allowable values are: volume_job. T
    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[IsVolumeJobCancelStatusReasonArgs]
    (List) The reasons for the current status (if any).

    • Constraints: The minimum length is 0 items. Nested schema for status_reasons:
    volume_id str
    The volume identifier.
    volume_job_id str
    The volume job identifier.
    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.
    isVolumeJobCancelId String
    The unique identifier of the is_volume_job_cancel.
    jobType String
    (String) The type of volume job. Constraints: Allowable values are: migrate.
    name String
    (String) The globally unique name for this volume profile.
    parameters List<Property Map>
    (List) The parameters to use after the volume is migrated.
    resourceType String
    (String) The resource type. Constraints: Allowable values are: volume_job. T
    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).

    • Constraints: The minimum length is 0 items. Nested schema for status_reasons:
    volumeId String
    The volume identifier.
    volumeJobId String
    The volume job identifier.

    Supporting Types

    IsVolumeJobCancelParameter, IsVolumeJobCancelParameterArgs

    Bandwidth double
    (Integer) The maximum bandwidth (in megabits per second) for the volume.
    Iops double
    (Integer) The maximum I/O operations per second (IOPS) for this volume.
    Profiles List<IsVolumeJobCancelParameterProfile>
    (List) Identifies a volume profile by a unique property.
    Bandwidth float64
    (Integer) The maximum bandwidth (in megabits per second) for the volume.
    Iops float64
    (Integer) The maximum I/O operations per second (IOPS) for this volume.
    Profiles []IsVolumeJobCancelParameterProfile
    (List) Identifies a volume profile by a unique property.
    bandwidth number
    (Integer) The maximum bandwidth (in megabits per second) for the volume.
    iops number
    (Integer) The maximum I/O operations per second (IOPS) for this volume.
    profiles list(object)
    (List) Identifies a volume profile by a unique property.
    bandwidth Double
    (Integer) The maximum bandwidth (in megabits per second) for the volume.
    iops Double
    (Integer) The maximum I/O operations per second (IOPS) for this volume.
    profiles List<IsVolumeJobCancelParameterProfile>
    (List) Identifies a volume profile by a unique property.
    bandwidth number
    (Integer) The maximum bandwidth (in megabits per second) for the volume.
    iops number
    (Integer) The maximum I/O operations per second (IOPS) for this volume.
    profiles IsVolumeJobCancelParameterProfile[]
    (List) Identifies a volume profile by a unique property.
    bandwidth float
    (Integer) The maximum bandwidth (in megabits per second) for the volume.
    iops float
    (Integer) The maximum I/O operations per second (IOPS) for this volume.
    profiles Sequence[IsVolumeJobCancelParameterProfile]
    (List) Identifies a volume profile by a unique property.
    bandwidth Number
    (Integer) The maximum bandwidth (in megabits per second) for the volume.
    iops Number
    (Integer) The maximum I/O operations per second (IOPS) for this volume.
    profiles List<Property Map>
    (List) Identifies a volume profile by a unique property.

    IsVolumeJobCancelParameterProfile, IsVolumeJobCancelParameterProfileArgs

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

    IsVolumeJobCancelStatusReason, IsVolumeJobCancelStatusReasonArgs

    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.
    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.
    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.
    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.
    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.
    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.
    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.
    message String
    (String) An explanation of the status reason.
    moreInfo String
    (String) A link to documentation about this status reason.

    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
      Try Pulumi Cloud free. Your team will thank you.