ibm 1.78.0, Apr 30 25

ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.IsInstanceVolumeAttachment

Explore with Pulumi AI

ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

package generated_program;

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

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

    public static void stack(Context ctx) {
    }
}

{}

Example Usage

Using Capacity)

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IsVpc;
import com.pulumi.ibm.IsSubnet;
import com.pulumi.ibm.IsSubnetArgs;
import com.pulumi.ibm.IsSshKey;
import com.pulumi.ibm.IsSshKeyArgs;
import com.pulumi.ibm.IsInstance;
import com.pulumi.ibm.IsInstanceArgs;
import com.pulumi.ibm.inputs.IsInstancePrimaryNetworkInterfaceArgs;
import com.pulumi.ibm.inputs.IsInstanceNetworkInterfaceArgs;
import com.pulumi.ibm.IsInstanceVolumeAttachment;
import com.pulumi.ibm.IsInstanceVolumeAttachmentArgs;
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 exampleIsVpc = new IsVpc("exampleIsVpc");

        var exampleIsSubnet = new IsSubnet("exampleIsSubnet", IsSubnetArgs.builder()
            .vpc(exampleIsVpc.isVpcId())
            .zone("us-south-2")
            .totalIpv4AddressCount(16)
            .build());

        var exampleIsSshKey = new IsSshKey("exampleIsSshKey", IsSshKeyArgs.builder()
            .publicKey("ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCKVmnMOlHKcZK8tpt3MP1lqOLAcqcJzhsvJcjscgVERRN7/9484SOBJ3HSKxxNG5JN8owAjy5f9yYwcUg+JaUVuytn5Pv3aeYROHGGg+5G346xaq3DAwX6Y5ykr2fvjObgncQBnuU5KHWCECO/4h8uWuwh/kfniXPVjFToc+gnkqA+3RKpAecZhFXwfalQ9mMuYGFxn+fwn8cYEApsJbsEmb0iJwPiZ5hjFC8wREuiTlhPHDgkBLOiycd20op2nXzDbHfCHInquEe/gYxEitALONxm0swBOwJZwlTDOB7C6y2dzlrtxr1L59m7pCkWI4EtTRLvleehBoj3u7jB4usR")
            .build());

        var exampleIsInstance = new IsInstance("exampleIsInstance", IsInstanceArgs.builder()
            .image(ibm_is_image.example().id())
            .profile("bx2-2x8")
            .primaryNetworkInterface(IsInstancePrimaryNetworkInterfaceArgs.builder()
                .subnet(exampleIsSubnet.isSubnetId())
                .build())
            .vpc(exampleIsVpc.isVpcId())
            .zone("us-south-2")
            .keys(exampleIsSshKey.isSshKeyId())
            .networkInterfaces(IsInstanceNetworkInterfaceArgs.builder()
                .subnet(exampleIsSubnet.isSubnetId())
                .name("eth1")
                .build())
            .build());

        var exampleIsInstanceVolumeAttachment = new IsInstanceVolumeAttachment("exampleIsInstanceVolumeAttachment", IsInstanceVolumeAttachmentArgs.builder()
            .instance(exampleIsInstance.isInstanceId())
            .profile("general-purpose")
            .capacity("20")
            .deleteVolumeOnAttachmentDelete(true)
            .deleteVolumeOnInstanceDelete(true)
            .volumeName("example-vol-1")
            .timeouts(IsInstanceVolumeAttachmentTimeoutsArgs.builder()
                .create("15m")
                .update("15m")
                .delete("15m")
                .build())
            .build());

    }
}

resources:
  exampleIsVpc:
    type: ibm:IsVpc
  exampleIsSubnet:
    type: ibm:IsSubnet
    properties:
      vpc: ${exampleIsVpc.isVpcId}
      zone: us-south-2
      totalIpv4AddressCount: 16
  exampleIsSshKey:
    type: ibm:IsSshKey
    properties:
      publicKey: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCKVmnMOlHKcZK8tpt3MP1lqOLAcqcJzhsvJcjscgVERRN7/9484SOBJ3HSKxxNG5JN8owAjy5f9yYwcUg+JaUVuytn5Pv3aeYROHGGg+5G346xaq3DAwX6Y5ykr2fvjObgncQBnuU5KHWCECO/4h8uWuwh/kfniXPVjFToc+gnkqA+3RKpAecZhFXwfalQ9mMuYGFxn+fwn8cYEApsJbsEmb0iJwPiZ5hjFC8wREuiTlhPHDgkBLOiycd20op2nXzDbHfCHInquEe/gYxEitALONxm0swBOwJZwlTDOB7C6y2dzlrtxr1L59m7pCkWI4EtTRLvleehBoj3u7jB4usR
  exampleIsInstance:
    type: ibm:IsInstance
    properties:
      image: ${ibm_is_image.example.id}
      profile: bx2-2x8
      primaryNetworkInterface:
        subnet: ${exampleIsSubnet.isSubnetId}
      vpc: ${exampleIsVpc.isVpcId}
      zone: us-south-2
      keys:
        - ${exampleIsSshKey.isSshKeyId}
      networkInterfaces:
        - subnet: ${exampleIsSubnet.isSubnetId}
          name: eth1
  exampleIsInstanceVolumeAttachment:
    type: ibm:IsInstanceVolumeAttachment
    properties:
      instance: ${exampleIsInstance.isInstanceId}
      profile: general-purpose
      capacity: '20'
      deleteVolumeOnAttachmentDelete: true
      deleteVolumeOnInstanceDelete: true
      volumeName: example-vol-1
      # User can configure timeouts
      timeouts:
        - create: 15m
          update: 15m
          delete: 15m

Using Existing Volume)

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

const exampleIsVolume = new ibm.IsVolume("exampleIsVolume", {
    profile: "10iops-tier",
    zone: "us-south-2",
});
const exampleIsInstanceVolumeAttachment = new ibm.IsInstanceVolumeAttachment("exampleIsInstanceVolumeAttachment", {
    instance: ibm_is_instance.example.id,
    volume: exampleIsVolume.isVolumeId,
    deleteVolumeOnAttachmentDelete: false,
    deleteVolumeOnInstanceDelete: false,
});

import pulumi
import pulumi_ibm as ibm

example_is_volume = ibm.IsVolume("exampleIsVolume",
    profile="10iops-tier",
    zone="us-south-2")
example_is_instance_volume_attachment = ibm.IsInstanceVolumeAttachment("exampleIsInstanceVolumeAttachment",
    instance=ibm_is_instance["example"]["id"],
    volume=example_is_volume.is_volume_id,
    delete_volume_on_attachment_delete=False,
    delete_volume_on_instance_delete=False)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleIsVolume, err := ibm.NewIsVolume(ctx, "exampleIsVolume", &ibm.IsVolumeArgs{
			Profile: pulumi.String("10iops-tier"),
			Zone:    pulumi.String("us-south-2"),
		})
		if err != nil {
			return err
		}
		_, err = ibm.NewIsInstanceVolumeAttachment(ctx, "exampleIsInstanceVolumeAttachment", &ibm.IsInstanceVolumeAttachmentArgs{
			Instance:                       pulumi.Any(ibm_is_instance.Example.Id),
			Volume:                         exampleIsVolume.IsVolumeId,
			DeleteVolumeOnAttachmentDelete: pulumi.Bool(false),
			DeleteVolumeOnInstanceDelete:   pulumi.Bool(false),
		})
		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 exampleIsVolume = new Ibm.IsVolume("exampleIsVolume", new()
    {
        Profile = "10iops-tier",
        Zone = "us-south-2",
    });

    var exampleIsInstanceVolumeAttachment = new Ibm.IsInstanceVolumeAttachment("exampleIsInstanceVolumeAttachment", new()
    {
        Instance = ibm_is_instance.Example.Id,
        Volume = exampleIsVolume.IsVolumeId,
        DeleteVolumeOnAttachmentDelete = false,
        DeleteVolumeOnInstanceDelete = false,
    });

});

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.IsInstanceVolumeAttachment;
import com.pulumi.ibm.IsInstanceVolumeAttachmentArgs;
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 exampleIsVolume = new IsVolume("exampleIsVolume", IsVolumeArgs.builder()
            .profile("10iops-tier")
            .zone("us-south-2")
            .build());

        var exampleIsInstanceVolumeAttachment = new IsInstanceVolumeAttachment("exampleIsInstanceVolumeAttachment", IsInstanceVolumeAttachmentArgs.builder()
            .instance(ibm_is_instance.example().id())
            .volume(exampleIsVolume.isVolumeId())
            .deleteVolumeOnAttachmentDelete(false)
            .deleteVolumeOnInstanceDelete(false)
            .build());

    }
}

resources:
  exampleIsVolume:
    type: ibm:IsVolume
    properties:
      profile: 10iops-tier
      zone: us-south-2
  exampleIsInstanceVolumeAttachment:
    type: ibm:IsInstanceVolumeAttachment
    properties:
      instance: ${ibm_is_instance.example.id}
      volume: ${exampleIsVolume.isVolumeId} # it is recommended to keep the delete_volume_on_attachment_delete as false here otherwise on deleting attachment, existing volume will also get deleted
      deleteVolumeOnAttachmentDelete: false
      deleteVolumeOnInstanceDelete: false

Creating New Volume)

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IsInstanceVolumeAttachment;
import com.pulumi.ibm.IsInstanceVolumeAttachmentArgs;
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 IsInstanceVolumeAttachment("example", IsInstanceVolumeAttachmentArgs.builder()
            .instance(ibm_is_instance.example().id())
            .iops(100)
            .capacity(50)
            .deleteVolumeOnAttachmentDelete(true)
            .deleteVolumeOnInstanceDelete(true)
            .volumeName("example-vol-3")
            .timeouts(IsInstanceVolumeAttachmentTimeoutsArgs.builder()
                .create("15m")
                .update("15m")
                .delete("15m")
                .build())
            .build());

    }
}

resources:
  example:
    type: ibm:IsInstanceVolumeAttachment
    properties:
      instance: ${ibm_is_instance.example.id}
      iops: 100
      capacity: 50
      deleteVolumeOnAttachmentDelete: true
      deleteVolumeOnInstanceDelete: true
      volumeName: example-vol-3
      # User can configure timeouts
      timeouts:
        - create: 15m
          update: 15m
          delete: 15m

Restoring Using Snapshot)

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IsInstanceVolumeAttachment;
import com.pulumi.ibm.IsInstanceVolumeAttachmentArgs;
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_vol_3 = new IsInstanceVolumeAttachment("example-vol-3", IsInstanceVolumeAttachmentArgs.builder()
            .instance(ibm_is_instance.example().id())
            .profile("general-purpose")
            .snapshot(xxxx_xx_x_xxxxx)
            .deleteVolumeOnAttachmentDelete(true)
            .deleteVolumeOnInstanceDelete(true)
            .volumeName("example-vol-4")
            .timeouts(IsInstanceVolumeAttachmentTimeoutsArgs.builder()
                .create("15m")
                .update("15m")
                .delete("15m")
                .build())
            .build());

    }
}

resources:
  example-vol-3:
    type: ibm:IsInstanceVolumeAttachment
    properties:
      instance: ${ibm_is_instance.example.id}
      profile: general-purpose
      snapshot: ${["xxxx-xx-x-xxxxx"]}
      deleteVolumeOnAttachmentDelete: true
      deleteVolumeOnInstanceDelete: true
      volumeName: example-vol-4
      # User can configure timeouts
      timeouts:
        - create: 15m
          update: 15m
          delete: 15m

Create IsInstanceVolumeAttachment Resource

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

Constructor syntax

new IsInstanceVolumeAttachment(name: string, args: IsInstanceVolumeAttachmentArgs, opts?: CustomResourceOptions);

@overload
def IsInstanceVolumeAttachment(resource_name: str,
                               args: IsInstanceVolumeAttachmentInitArgs,
                               opts: Optional[ResourceOptions] = None)

@overload
def IsInstanceVolumeAttachment(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               instance: Optional[str] = None,
                               name: Optional[str] = None,
                               snapshot_crn: Optional[str] = None,
                               delete_volume_on_instance_delete: Optional[bool] = None,
                               encryption_key: Optional[str] = None,
                               capacity: Optional[float] = None,
                               iops: Optional[float] = None,
                               delete_volume_on_attachment_delete: Optional[bool] = None,
                               profile: Optional[str] = None,
                               is_instance_volume_attachment_id: Optional[str] = None,
                               snapshot: Optional[str] = None,
                               bandwidth: Optional[float] = None,
                               tags: Optional[Sequence[str]] = None,
                               timeouts: Optional[IsInstanceVolumeAttachmentTimeoutsArgs] = None,
                               volume: Optional[str] = None,
                               volume_name: Optional[str] = None)

func NewIsInstanceVolumeAttachment(ctx *Context, name string, args IsInstanceVolumeAttachmentArgs, opts ...ResourceOption) (*IsInstanceVolumeAttachment, error)

public IsInstanceVolumeAttachment(string name, IsInstanceVolumeAttachmentArgs args, CustomResourceOptions? opts = null)

public IsInstanceVolumeAttachment(String name, IsInstanceVolumeAttachmentArgs args)
public IsInstanceVolumeAttachment(String name, IsInstanceVolumeAttachmentArgs args, CustomResourceOptions options)

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

Parameters

name string: The unique name of the resource.
args IsInstanceVolumeAttachmentArgs: 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 IsInstanceVolumeAttachmentInitArgs: 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 IsInstanceVolumeAttachmentArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args IsInstanceVolumeAttachmentArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args IsInstanceVolumeAttachmentArgs: 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 isInstanceVolumeAttachmentResource = new Ibm.IsInstanceVolumeAttachment("isInstanceVolumeAttachmentResource", new()
{
    Instance = "string",
    Name = "string",
    SnapshotCrn = "string",
    DeleteVolumeOnInstanceDelete = false,
    EncryptionKey = "string",
    Capacity = 0,
    Iops = 0,
    DeleteVolumeOnAttachmentDelete = false,
    Profile = "string",
    IsInstanceVolumeAttachmentId = "string",
    Snapshot = "string",
    Bandwidth = 0,
    Tags = new[]
    {
        "string",
    },
    Timeouts = new Ibm.Inputs.IsInstanceVolumeAttachmentTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
    Volume = "string",
    VolumeName = "string",
});

example, err := ibm.NewIsInstanceVolumeAttachment(ctx, "isInstanceVolumeAttachmentResource", &ibm.IsInstanceVolumeAttachmentArgs{
	Instance:                       pulumi.String("string"),
	Name:                           pulumi.String("string"),
	SnapshotCrn:                    pulumi.String("string"),
	DeleteVolumeOnInstanceDelete:   pulumi.Bool(false),
	EncryptionKey:                  pulumi.String("string"),
	Capacity:                       pulumi.Float64(0),
	Iops:                           pulumi.Float64(0),
	DeleteVolumeOnAttachmentDelete: pulumi.Bool(false),
	Profile:                        pulumi.String("string"),
	IsInstanceVolumeAttachmentId:   pulumi.String("string"),
	Snapshot:                       pulumi.String("string"),
	Bandwidth:                      pulumi.Float64(0),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Timeouts: &ibm.IsInstanceVolumeAttachmentTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
	Volume:     pulumi.String("string"),
	VolumeName: pulumi.String("string"),
})

var isInstanceVolumeAttachmentResource = new IsInstanceVolumeAttachment("isInstanceVolumeAttachmentResource", IsInstanceVolumeAttachmentArgs.builder()
    .instance("string")
    .name("string")
    .snapshotCrn("string")
    .deleteVolumeOnInstanceDelete(false)
    .encryptionKey("string")
    .capacity(0)
    .iops(0)
    .deleteVolumeOnAttachmentDelete(false)
    .profile("string")
    .isInstanceVolumeAttachmentId("string")
    .snapshot("string")
    .bandwidth(0)
    .tags("string")
    .timeouts(IsInstanceVolumeAttachmentTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .volume("string")
    .volumeName("string")
    .build());

is_instance_volume_attachment_resource = ibm.IsInstanceVolumeAttachment("isInstanceVolumeAttachmentResource",
    instance="string",
    name="string",
    snapshot_crn="string",
    delete_volume_on_instance_delete=False,
    encryption_key="string",
    capacity=0,
    iops=0,
    delete_volume_on_attachment_delete=False,
    profile="string",
    is_instance_volume_attachment_id="string",
    snapshot="string",
    bandwidth=0,
    tags=["string"],
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    },
    volume="string",
    volume_name="string")

const isInstanceVolumeAttachmentResource = new ibm.IsInstanceVolumeAttachment("isInstanceVolumeAttachmentResource", {
    instance: "string",
    name: "string",
    snapshotCrn: "string",
    deleteVolumeOnInstanceDelete: false,
    encryptionKey: "string",
    capacity: 0,
    iops: 0,
    deleteVolumeOnAttachmentDelete: false,
    profile: "string",
    isInstanceVolumeAttachmentId: "string",
    snapshot: "string",
    bandwidth: 0,
    tags: ["string"],
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
    volume: "string",
    volumeName: "string",
});

type: ibm:IsInstanceVolumeAttachment
properties:
    bandwidth: 0
    capacity: 0
    deleteVolumeOnAttachmentDelete: false
    deleteVolumeOnInstanceDelete: false
    encryptionKey: string
    instance: string
    iops: 0
    isInstanceVolumeAttachmentId: string
    name: string
    profile: string
    snapshot: string
    snapshotCrn: string
    tags:
        - string
    timeouts:
        create: string
        delete: string
        update: string
    volume: string
    volumeName: string

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

Instance string

The id of the instance.

Bandwidth double

The maximum bandwidth (in megabits per second) for the volume. For this property to be specified, the volume storage_generation must be 2.

Capacity double

The capacity of the volume in gigabytes.

NOTE • The specified minimum and maximum capacity values for creating or updating volumes may expand in the future. Accepted value is in [10-16000]. **•** If unspecified, the capacity will be the source snapshot's minimum_capacity when snapshot is provided.**•** Supports only expansion on update (must not be less than the current volume capacity)**•** Can be updated only if volume is attached to an running virtual server instance.**•** Stopped instance will be started on update of capacity of the volume.

DeleteVolumeOnAttachmentDelete bool

If set to true, when deleting the attachment, the volume will also be deleted. By default it is true

DeleteVolumeOnInstanceDelete bool

If set to true, when deleting the instance, the volume will also be deleted. By default it is false

EncryptionKey string

The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource. If this property is not provided but the image is encrypted, the image's encryption_key will be used. Otherwise, the encryption type for the volume will be provider_managed.

Iops double

The bandwidth for the new volume. This value is required for custom storage profiles only.

NOTE • iops value can be upgraded and downgraged if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume. • This table shows how storage size affects the iops ranges:

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

IsInstanceVolumeAttachmentId string

(String) The ID of the instance volume attachment. The ID is composed of <instance_id>/<volume_attachment_id>.

Name string

The name of the volume attachment.

Profile string

The globally unique name for this volume profile.

NOTE • Allowed values are : [general-purpose, 5iops-tier, 10iops-tier, custom]. • If iops is not present, general-purpose is taken as the volume profile. • If iops is present, custom is taken as the volume profile. • Tiered profiles [general-purpose, 5iops-tier, 10iops-tier] can be upgraded and downgraded into each other. • Can be updated only if volume is attached to an running virtual server instance. • Stopped instances will be started on update of volume.

Snapshot string

The unique identifier for this snapshot from which to clone the new volume.

NOTE • one of capacity or snapshot must be present for volume creation. • If capacity is not present or less than minimum_capacity of the snapshot, minimum_capacity is taken as the volume capacity.

SnapshotCrn string

The CRN for this snapshot from which to clone the new volume.

NOTE • one of capacity or snapshot must be present for volume creation. • If capacity is not present or less than minimum_capacity of the snapshot, minimum_capacity is taken as the volume capacity.

Tags List<string>

A list of user tags that you want to add to your volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)

Timeouts IsInstanceVolumeAttachmentTimeouts

Volume string

The unique identifier for the existing volume

VolumeName string

The unique user-defined name for this new volume.

Instance string

The id of the instance.

Bandwidth float64

The maximum bandwidth (in megabits per second) for the volume. For this property to be specified, the volume storage_generation must be 2.

Capacity float64

The capacity of the volume in gigabytes.

NOTE • The specified minimum and maximum capacity values for creating or updating volumes may expand in the future. Accepted value is in [10-16000]. **•** If unspecified, the capacity will be the source snapshot's minimum_capacity when snapshot is provided.**•** Supports only expansion on update (must not be less than the current volume capacity)**•** Can be updated only if volume is attached to an running virtual server instance.**•** Stopped instance will be started on update of capacity of the volume.

DeleteVolumeOnAttachmentDelete bool

If set to true, when deleting the attachment, the volume will also be deleted. By default it is true

DeleteVolumeOnInstanceDelete bool

If set to true, when deleting the instance, the volume will also be deleted. By default it is false

EncryptionKey string

Iops float64

The bandwidth for the new volume. This value is required for custom storage profiles only.

NOTE • iops value can be upgraded and downgraged if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume. • This table shows how storage size affects the iops ranges:

IsInstanceVolumeAttachmentId string

(String) The ID of the instance volume attachment. The ID is composed of <instance_id>/<volume_attachment_id>.

Name string

The name of the volume attachment.

Profile string

The globally unique name for this volume profile.

NOTE • Allowed values are : [general-purpose, 5iops-tier, 10iops-tier, custom]. • If iops is not present, general-purpose is taken as the volume profile. • If iops is present, custom is taken as the volume profile. • Tiered profiles [general-purpose, 5iops-tier, 10iops-tier] can be upgraded and downgraded into each other. • Can be updated only if volume is attached to an running virtual server instance. • Stopped instances will be started on update of volume.

Snapshot string

The unique identifier for this snapshot from which to clone the new volume.

NOTE • one of capacity or snapshot must be present for volume creation. • If capacity is not present or less than minimum_capacity of the snapshot, minimum_capacity is taken as the volume capacity.

SnapshotCrn string

The CRN for this snapshot from which to clone the new volume.

NOTE • one of capacity or snapshot must be present for volume creation. • If capacity is not present or less than minimum_capacity of the snapshot, minimum_capacity is taken as the volume capacity.

Tags []string

A list of user tags that you want to add to your volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)

Timeouts IsInstanceVolumeAttachmentTimeoutsArgs

Volume string

The unique identifier for the existing volume

VolumeName string

The unique user-defined name for this new volume.

instance String

The id of the instance.

bandwidth Double

The maximum bandwidth (in megabits per second) for the volume. For this property to be specified, the volume storage_generation must be 2.

capacity Double

The capacity of the volume in gigabytes.

NOTE • The specified minimum and maximum capacity values for creating or updating volumes may expand in the future. Accepted value is in [10-16000]. **•** If unspecified, the capacity will be the source snapshot's minimum_capacity when snapshot is provided.**•** Supports only expansion on update (must not be less than the current volume capacity)**•** Can be updated only if volume is attached to an running virtual server instance.**•** Stopped instance will be started on update of capacity of the volume.

deleteVolumeOnAttachmentDelete Boolean

If set to true, when deleting the attachment, the volume will also be deleted. By default it is true

deleteVolumeOnInstanceDelete Boolean

If set to true, when deleting the instance, the volume will also be deleted. By default it is false

encryptionKey String

iops Double

The bandwidth for the new volume. This value is required for custom storage profiles only.

NOTE • iops value can be upgraded and downgraged if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume. • This table shows how storage size affects the iops ranges:

isInstanceVolumeAttachmentId String

(String) The ID of the instance volume attachment. The ID is composed of <instance_id>/<volume_attachment_id>.

name String

The name of the volume attachment.

profile String

The globally unique name for this volume profile.

NOTE • Allowed values are : [general-purpose, 5iops-tier, 10iops-tier, custom]. • If iops is not present, general-purpose is taken as the volume profile. • If iops is present, custom is taken as the volume profile. • Tiered profiles [general-purpose, 5iops-tier, 10iops-tier] can be upgraded and downgraded into each other. • Can be updated only if volume is attached to an running virtual server instance. • Stopped instances will be started on update of volume.

snapshot String

The unique identifier for this snapshot from which to clone the new volume.

NOTE • one of capacity or snapshot must be present for volume creation. • If capacity is not present or less than minimum_capacity of the snapshot, minimum_capacity is taken as the volume capacity.

snapshotCrn String

The CRN for this snapshot from which to clone the new volume.

NOTE • one of capacity or snapshot must be present for volume creation. • If capacity is not present or less than minimum_capacity of the snapshot, minimum_capacity is taken as the volume capacity.

tags List<String>

A list of user tags that you want to add to your volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)

timeouts IsInstanceVolumeAttachmentTimeouts

volume String

The unique identifier for the existing volume

volumeName String

The unique user-defined name for this new volume.

instance string

The id of the instance.

bandwidth number

The maximum bandwidth (in megabits per second) for the volume. For this property to be specified, the volume storage_generation must be 2.

capacity number

The capacity of the volume in gigabytes.

NOTE • The specified minimum and maximum capacity values for creating or updating volumes may expand in the future. Accepted value is in [10-16000]. **•** If unspecified, the capacity will be the source snapshot's minimum_capacity when snapshot is provided.**•** Supports only expansion on update (must not be less than the current volume capacity)**•** Can be updated only if volume is attached to an running virtual server instance.**•** Stopped instance will be started on update of capacity of the volume.

deleteVolumeOnAttachmentDelete boolean

If set to true, when deleting the attachment, the volume will also be deleted. By default it is true

deleteVolumeOnInstanceDelete boolean

If set to true, when deleting the instance, the volume will also be deleted. By default it is false

encryptionKey string

iops number

The bandwidth for the new volume. This value is required for custom storage profiles only.

NOTE • iops value can be upgraded and downgraged if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume. • This table shows how storage size affects the iops ranges:

isInstanceVolumeAttachmentId string

(String) The ID of the instance volume attachment. The ID is composed of <instance_id>/<volume_attachment_id>.

name string

The name of the volume attachment.

profile string

The globally unique name for this volume profile.

NOTE • Allowed values are : [general-purpose, 5iops-tier, 10iops-tier, custom]. • If iops is not present, general-purpose is taken as the volume profile. • If iops is present, custom is taken as the volume profile. • Tiered profiles [general-purpose, 5iops-tier, 10iops-tier] can be upgraded and downgraded into each other. • Can be updated only if volume is attached to an running virtual server instance. • Stopped instances will be started on update of volume.

snapshot string

The unique identifier for this snapshot from which to clone the new volume.

NOTE • one of capacity or snapshot must be present for volume creation. • If capacity is not present or less than minimum_capacity of the snapshot, minimum_capacity is taken as the volume capacity.

snapshotCrn string

The CRN for this snapshot from which to clone the new volume.

NOTE • one of capacity or snapshot must be present for volume creation. • If capacity is not present or less than minimum_capacity of the snapshot, minimum_capacity is taken as the volume capacity.

tags string[]

A list of user tags that you want to add to your volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)

timeouts IsInstanceVolumeAttachmentTimeouts

volume string

The unique identifier for the existing volume

volumeName string

The unique user-defined name for this new volume.

instance str

The id of the instance.

bandwidth float

The maximum bandwidth (in megabits per second) for the volume. For this property to be specified, the volume storage_generation must be 2.

capacity float

The capacity of the volume in gigabytes.

NOTE • The specified minimum and maximum capacity values for creating or updating volumes may expand in the future. Accepted value is in [10-16000]. **•** If unspecified, the capacity will be the source snapshot's minimum_capacity when snapshot is provided.**•** Supports only expansion on update (must not be less than the current volume capacity)**•** Can be updated only if volume is attached to an running virtual server instance.**•** Stopped instance will be started on update of capacity of the volume.

delete_volume_on_attachment_delete bool

If set to true, when deleting the attachment, the volume will also be deleted. By default it is true

delete_volume_on_instance_delete bool

If set to true, when deleting the instance, the volume will also be deleted. By default it is false

encryption_key str

iops float

The bandwidth for the new volume. This value is required for custom storage profiles only.

NOTE • iops value can be upgraded and downgraged if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume. • This table shows how storage size affects the iops ranges:

is_instance_volume_attachment_id str

(String) The ID of the instance volume attachment. The ID is composed of <instance_id>/<volume_attachment_id>.

name str

The name of the volume attachment.

profile str

The globally unique name for this volume profile.

NOTE • Allowed values are : [general-purpose, 5iops-tier, 10iops-tier, custom]. • If iops is not present, general-purpose is taken as the volume profile. • If iops is present, custom is taken as the volume profile. • Tiered profiles [general-purpose, 5iops-tier, 10iops-tier] can be upgraded and downgraded into each other. • Can be updated only if volume is attached to an running virtual server instance. • Stopped instances will be started on update of volume.

snapshot str

The unique identifier for this snapshot from which to clone the new volume.

NOTE • one of capacity or snapshot must be present for volume creation. • If capacity is not present or less than minimum_capacity of the snapshot, minimum_capacity is taken as the volume capacity.

snapshot_crn str

The CRN for this snapshot from which to clone the new volume.

NOTE • one of capacity or snapshot must be present for volume creation. • If capacity is not present or less than minimum_capacity of the snapshot, minimum_capacity is taken as the volume capacity.

tags Sequence[str]

A list of user tags that you want to add to your volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)

timeouts IsInstanceVolumeAttachmentTimeoutsArgs

volume str

The unique identifier for the existing volume

volume_name str

The unique user-defined name for this new volume.

instance String

The id of the instance.

bandwidth Number

The maximum bandwidth (in megabits per second) for the volume. For this property to be specified, the volume storage_generation must be 2.

capacity Number

The capacity of the volume in gigabytes.

NOTE • The specified minimum and maximum capacity values for creating or updating volumes may expand in the future. Accepted value is in [10-16000]. **•** If unspecified, the capacity will be the source snapshot's minimum_capacity when snapshot is provided.**•** Supports only expansion on update (must not be less than the current volume capacity)**•** Can be updated only if volume is attached to an running virtual server instance.**•** Stopped instance will be started on update of capacity of the volume.

deleteVolumeOnAttachmentDelete Boolean

If set to true, when deleting the attachment, the volume will also be deleted. By default it is true

deleteVolumeOnInstanceDelete Boolean

If set to true, when deleting the instance, the volume will also be deleted. By default it is false

encryptionKey String

iops Number

The bandwidth for the new volume. This value is required for custom storage profiles only.

NOTE • iops value can be upgraded and downgraged if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume. • This table shows how storage size affects the iops ranges:

isInstanceVolumeAttachmentId String

(String) The ID of the instance volume attachment. The ID is composed of <instance_id>/<volume_attachment_id>.

name String

The name of the volume attachment.

profile String

The globally unique name for this volume profile.

NOTE • Allowed values are : [general-purpose, 5iops-tier, 10iops-tier, custom]. • If iops is not present, general-purpose is taken as the volume profile. • If iops is present, custom is taken as the volume profile. • Tiered profiles [general-purpose, 5iops-tier, 10iops-tier] can be upgraded and downgraded into each other. • Can be updated only if volume is attached to an running virtual server instance. • Stopped instances will be started on update of volume.

snapshot String

The unique identifier for this snapshot from which to clone the new volume.

NOTE • one of capacity or snapshot must be present for volume creation. • If capacity is not present or less than minimum_capacity of the snapshot, minimum_capacity is taken as the volume capacity.

snapshotCrn String

The CRN for this snapshot from which to clone the new volume.

NOTE • one of capacity or snapshot must be present for volume creation. • If capacity is not present or less than minimum_capacity of the snapshot, minimum_capacity is taken as the volume capacity.

tags List<String>

A list of user tags that you want to add to your volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)

timeouts Property Map

volume String

The unique identifier for the existing volume

volumeName String

The unique user-defined name for this new volume.

Outputs

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

Device string: (String) A unique identifier for the device which is exposed to the instance operating system.
Href string: (String) The URL for this volume attachment.
Id string: The provider-assigned unique ID for this managed resource.
Status string: (String) The status of this volume attachment. Supported values are attached, attaching, deleting, detaching.
Type string: (String) The type of volume attachment. Supported values are boot, data.
Version string
VolumeAttachmentId string: (String) The unique identifier for this volume attachment.
VolumeCrn string: (String) The CRN for this volume.
VolumeDeleted string: (String) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
VolumeHref string: (String) The URL for this volume.

Device string: (String) A unique identifier for the device which is exposed to the instance operating system.
Href string: (String) The URL for this volume attachment.
Id string: The provider-assigned unique ID for this managed resource.
Status string: (String) The status of this volume attachment. Supported values are attached, attaching, deleting, detaching.
Type string: (String) The type of volume attachment. Supported values are boot, data.
Version string
VolumeAttachmentId string: (String) The unique identifier for this volume attachment.
VolumeCrn string: (String) The CRN for this volume.
VolumeDeleted string: (String) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
VolumeHref string: (String) The URL for this volume.

device String: (String) A unique identifier for the device which is exposed to the instance operating system.
href String: (String) The URL for this volume attachment.
id String: The provider-assigned unique ID for this managed resource.
status String: (String) The status of this volume attachment. Supported values are attached, attaching, deleting, detaching.
type String: (String) The type of volume attachment. Supported values are boot, data.
version String
volumeAttachmentId String: (String) The unique identifier for this volume attachment.
volumeCrn String: (String) The CRN for this volume.
volumeDeleted String: (String) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
volumeHref String: (String) The URL for this volume.

device string: (String) A unique identifier for the device which is exposed to the instance operating system.
href string: (String) The URL for this volume attachment.
id string: The provider-assigned unique ID for this managed resource.
status string: (String) The status of this volume attachment. Supported values are attached, attaching, deleting, detaching.
type string: (String) The type of volume attachment. Supported values are boot, data.
version string
volumeAttachmentId string: (String) The unique identifier for this volume attachment.
volumeCrn string: (String) The CRN for this volume.
volumeDeleted string: (String) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
volumeHref string: (String) The URL for this volume.

device str: (String) A unique identifier for the device which is exposed to the instance operating system.
href str: (String) The URL for this volume attachment.
id str: The provider-assigned unique ID for this managed resource.
status str: (String) The status of this volume attachment. Supported values are attached, attaching, deleting, detaching.
type str: (String) The type of volume attachment. Supported values are boot, data.
version str
volume_attachment_id str: (String) The unique identifier for this volume attachment.
volume_crn str: (String) The CRN for this volume.
volume_deleted str: (String) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
volume_href str: (String) The URL for this volume.

device String: (String) A unique identifier for the device which is exposed to the instance operating system.
href String: (String) The URL for this volume attachment.
id String: The provider-assigned unique ID for this managed resource.
status String: (String) The status of this volume attachment. Supported values are attached, attaching, deleting, detaching.
type String: (String) The type of volume attachment. Supported values are boot, data.
version String
volumeAttachmentId String: (String) The unique identifier for this volume attachment.
volumeCrn String: (String) The CRN for this volume.
volumeDeleted String: (String) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
volumeHref String: (String) The URL for this volume.

Look up Existing IsInstanceVolumeAttachment Resource

Get an existing IsInstanceVolumeAttachment 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?: IsInstanceVolumeAttachmentState, opts?: CustomResourceOptions): IsInstanceVolumeAttachment

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bandwidth: Optional[float] = None,
        capacity: Optional[float] = None,
        delete_volume_on_attachment_delete: Optional[bool] = None,
        delete_volume_on_instance_delete: Optional[bool] = None,
        device: Optional[str] = None,
        encryption_key: Optional[str] = None,
        href: Optional[str] = None,
        instance: Optional[str] = None,
        iops: Optional[float] = None,
        is_instance_volume_attachment_id: Optional[str] = None,
        name: Optional[str] = None,
        profile: Optional[str] = None,
        snapshot: Optional[str] = None,
        snapshot_crn: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        timeouts: Optional[IsInstanceVolumeAttachmentTimeoutsArgs] = None,
        type: Optional[str] = None,
        version: Optional[str] = None,
        volume: Optional[str] = None,
        volume_attachment_id: Optional[str] = None,
        volume_crn: Optional[str] = None,
        volume_deleted: Optional[str] = None,
        volume_href: Optional[str] = None,
        volume_name: Optional[str] = None) -> IsInstanceVolumeAttachment

func GetIsInstanceVolumeAttachment(ctx *Context, name string, id IDInput, state *IsInstanceVolumeAttachmentState, opts ...ResourceOption) (*IsInstanceVolumeAttachment, error)

public static IsInstanceVolumeAttachment Get(string name, Input<string> id, IsInstanceVolumeAttachmentState? state, CustomResourceOptions? opts = null)

public static IsInstanceVolumeAttachment get(String name, Output<String> id, IsInstanceVolumeAttachmentState state, CustomResourceOptions options)

resources:  _:    type: ibm:IsInstanceVolumeAttachment    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Bandwidth double

The maximum bandwidth (in megabits per second) for the volume. For this property to be specified, the volume storage_generation must be 2.

Capacity double

The capacity of the volume in gigabytes.

NOTE • The specified minimum and maximum capacity values for creating or updating volumes may expand in the future. Accepted value is in [10-16000]. **•** If unspecified, the capacity will be the source snapshot's minimum_capacity when snapshot is provided.**•** Supports only expansion on update (must not be less than the current volume capacity)**•** Can be updated only if volume is attached to an running virtual server instance.**•** Stopped instance will be started on update of capacity of the volume.

DeleteVolumeOnAttachmentDelete bool

If set to true, when deleting the attachment, the volume will also be deleted. By default it is true

DeleteVolumeOnInstanceDelete bool

If set to true, when deleting the instance, the volume will also be deleted. By default it is false

Device string

(String) A unique identifier for the device which is exposed to the instance operating system.

EncryptionKey string

Href string

(String) The URL for this volume attachment.

Instance string

The id of the instance.

Iops double

The bandwidth for the new volume. This value is required for custom storage profiles only.

NOTE • iops value can be upgraded and downgraged if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume. • This table shows how storage size affects the iops ranges:

IsInstanceVolumeAttachmentId string

(String) The ID of the instance volume attachment. The ID is composed of <instance_id>/<volume_attachment_id>.

Name string

The name of the volume attachment.

Profile string

The globally unique name for this volume profile.

NOTE • Allowed values are : [general-purpose, 5iops-tier, 10iops-tier, custom]. • If iops is not present, general-purpose is taken as the volume profile. • If iops is present, custom is taken as the volume profile. • Tiered profiles [general-purpose, 5iops-tier, 10iops-tier] can be upgraded and downgraded into each other. • Can be updated only if volume is attached to an running virtual server instance. • Stopped instances will be started on update of volume.

Snapshot string

The unique identifier for this snapshot from which to clone the new volume.

NOTE • one of capacity or snapshot must be present for volume creation. • If capacity is not present or less than minimum_capacity of the snapshot, minimum_capacity is taken as the volume capacity.

SnapshotCrn string

The CRN for this snapshot from which to clone the new volume.

NOTE • one of capacity or snapshot must be present for volume creation. • If capacity is not present or less than minimum_capacity of the snapshot, minimum_capacity is taken as the volume capacity.

Status string

(String) The status of this volume attachment. Supported values are attached, attaching, deleting, detaching.

Tags List<string>

A list of user tags that you want to add to your volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)

Timeouts IsInstanceVolumeAttachmentTimeouts

Type string

(String) The type of volume attachment. Supported values are boot, data.

Version string

Volume string

The unique identifier for the existing volume

VolumeAttachmentId string

(String) The unique identifier for this volume attachment.

VolumeCrn string

(String) The CRN for this volume.

VolumeDeleted string

(String) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.

VolumeHref string

(String) The URL for this volume.

VolumeName string

The unique user-defined name for this new volume.

Bandwidth float64

The maximum bandwidth (in megabits per second) for the volume. For this property to be specified, the volume storage_generation must be 2.

Capacity float64

The capacity of the volume in gigabytes.

NOTE • The specified minimum and maximum capacity values for creating or updating volumes may expand in the future. Accepted value is in [10-16000]. **•** If unspecified, the capacity will be the source snapshot's minimum_capacity when snapshot is provided.**•** Supports only expansion on update (must not be less than the current volume capacity)**•** Can be updated only if volume is attached to an running virtual server instance.**•** Stopped instance will be started on update of capacity of the volume.

DeleteVolumeOnAttachmentDelete bool

If set to true, when deleting the attachment, the volume will also be deleted. By default it is true

DeleteVolumeOnInstanceDelete bool

If set to true, when deleting the instance, the volume will also be deleted. By default it is false

Device string

(String) A unique identifier for the device which is exposed to the instance operating system.

EncryptionKey string

Href string

(String) The URL for this volume attachment.

Instance string

The id of the instance.

Iops float64

The bandwidth for the new volume. This value is required for custom storage profiles only.

NOTE • iops value can be upgraded and downgraged if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume. • This table shows how storage size affects the iops ranges:

IsInstanceVolumeAttachmentId string

(String) The ID of the instance volume attachment. The ID is composed of <instance_id>/<volume_attachment_id>.

Name string

The name of the volume attachment.

Profile string

The globally unique name for this volume profile.

NOTE • Allowed values are : [general-purpose, 5iops-tier, 10iops-tier, custom]. • If iops is not present, general-purpose is taken as the volume profile. • If iops is present, custom is taken as the volume profile. • Tiered profiles [general-purpose, 5iops-tier, 10iops-tier] can be upgraded and downgraded into each other. • Can be updated only if volume is attached to an running virtual server instance. • Stopped instances will be started on update of volume.

Snapshot string

The unique identifier for this snapshot from which to clone the new volume.

NOTE • one of capacity or snapshot must be present for volume creation. • If capacity is not present or less than minimum_capacity of the snapshot, minimum_capacity is taken as the volume capacity.

SnapshotCrn string

The CRN for this snapshot from which to clone the new volume.

NOTE • one of capacity or snapshot must be present for volume creation. • If capacity is not present or less than minimum_capacity of the snapshot, minimum_capacity is taken as the volume capacity.

Status string

(String) The status of this volume attachment. Supported values are attached, attaching, deleting, detaching.

Tags []string

A list of user tags that you want to add to your volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)

Timeouts IsInstanceVolumeAttachmentTimeoutsArgs

Type string

(String) The type of volume attachment. Supported values are boot, data.

Version string

Volume string

The unique identifier for the existing volume

VolumeAttachmentId string

(String) The unique identifier for this volume attachment.

VolumeCrn string

(String) The CRN for this volume.

VolumeDeleted string

(String) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.

VolumeHref string

(String) The URL for this volume.

VolumeName string

The unique user-defined name for this new volume.

bandwidth Double

The maximum bandwidth (in megabits per second) for the volume. For this property to be specified, the volume storage_generation must be 2.

capacity Double

The capacity of the volume in gigabytes.

NOTE • The specified minimum and maximum capacity values for creating or updating volumes may expand in the future. Accepted value is in [10-16000]. **•** If unspecified, the capacity will be the source snapshot's minimum_capacity when snapshot is provided.**•** Supports only expansion on update (must not be less than the current volume capacity)**•** Can be updated only if volume is attached to an running virtual server instance.**•** Stopped instance will be started on update of capacity of the volume.

deleteVolumeOnAttachmentDelete Boolean

If set to true, when deleting the attachment, the volume will also be deleted. By default it is true

deleteVolumeOnInstanceDelete Boolean

If set to true, when deleting the instance, the volume will also be deleted. By default it is false

device String

(String) A unique identifier for the device which is exposed to the instance operating system.

encryptionKey String

href String

(String) The URL for this volume attachment.

instance String

The id of the instance.

iops Double

The bandwidth for the new volume. This value is required for custom storage profiles only.

NOTE • iops value can be upgraded and downgraged if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume. • This table shows how storage size affects the iops ranges:

isInstanceVolumeAttachmentId String

(String) The ID of the instance volume attachment. The ID is composed of <instance_id>/<volume_attachment_id>.

name String

The name of the volume attachment.

profile String

The globally unique name for this volume profile.

NOTE • Allowed values are : [general-purpose, 5iops-tier, 10iops-tier, custom]. • If iops is not present, general-purpose is taken as the volume profile. • If iops is present, custom is taken as the volume profile. • Tiered profiles [general-purpose, 5iops-tier, 10iops-tier] can be upgraded and downgraded into each other. • Can be updated only if volume is attached to an running virtual server instance. • Stopped instances will be started on update of volume.

snapshot String

The unique identifier for this snapshot from which to clone the new volume.

NOTE • one of capacity or snapshot must be present for volume creation. • If capacity is not present or less than minimum_capacity of the snapshot, minimum_capacity is taken as the volume capacity.

snapshotCrn String

The CRN for this snapshot from which to clone the new volume.

NOTE • one of capacity or snapshot must be present for volume creation. • If capacity is not present or less than minimum_capacity of the snapshot, minimum_capacity is taken as the volume capacity.

status String

(String) The status of this volume attachment. Supported values are attached, attaching, deleting, detaching.

tags List<String>

A list of user tags that you want to add to your volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)

timeouts IsInstanceVolumeAttachmentTimeouts

type String

(String) The type of volume attachment. Supported values are boot, data.

version String

volume String

The unique identifier for the existing volume

volumeAttachmentId String

(String) The unique identifier for this volume attachment.

volumeCrn String

(String) The CRN for this volume.

volumeDeleted String

(String) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.

volumeHref String

(String) The URL for this volume.

volumeName String

The unique user-defined name for this new volume.

bandwidth number

The maximum bandwidth (in megabits per second) for the volume. For this property to be specified, the volume storage_generation must be 2.

capacity number

The capacity of the volume in gigabytes.

NOTE • The specified minimum and maximum capacity values for creating or updating volumes may expand in the future. Accepted value is in [10-16000]. **•** If unspecified, the capacity will be the source snapshot's minimum_capacity when snapshot is provided.**•** Supports only expansion on update (must not be less than the current volume capacity)**•** Can be updated only if volume is attached to an running virtual server instance.**•** Stopped instance will be started on update of capacity of the volume.

deleteVolumeOnAttachmentDelete boolean

If set to true, when deleting the attachment, the volume will also be deleted. By default it is true

deleteVolumeOnInstanceDelete boolean

If set to true, when deleting the instance, the volume will also be deleted. By default it is false

device string

(String) A unique identifier for the device which is exposed to the instance operating system.

encryptionKey string

href string

(String) The URL for this volume attachment.

instance string

The id of the instance.

iops number

The bandwidth for the new volume. This value is required for custom storage profiles only.

NOTE • iops value can be upgraded and downgraged if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume. • This table shows how storage size affects the iops ranges:

isInstanceVolumeAttachmentId string

(String) The ID of the instance volume attachment. The ID is composed of <instance_id>/<volume_attachment_id>.

name string

The name of the volume attachment.

profile string

The globally unique name for this volume profile.

NOTE • Allowed values are : [general-purpose, 5iops-tier, 10iops-tier, custom]. • If iops is not present, general-purpose is taken as the volume profile. • If iops is present, custom is taken as the volume profile. • Tiered profiles [general-purpose, 5iops-tier, 10iops-tier] can be upgraded and downgraded into each other. • Can be updated only if volume is attached to an running virtual server instance. • Stopped instances will be started on update of volume.

snapshot string

The unique identifier for this snapshot from which to clone the new volume.

NOTE • one of capacity or snapshot must be present for volume creation. • If capacity is not present or less than minimum_capacity of the snapshot, minimum_capacity is taken as the volume capacity.

snapshotCrn string

The CRN for this snapshot from which to clone the new volume.

NOTE • one of capacity or snapshot must be present for volume creation. • If capacity is not present or less than minimum_capacity of the snapshot, minimum_capacity is taken as the volume capacity.

status string

(String) The status of this volume attachment. Supported values are attached, attaching, deleting, detaching.

tags string[]

A list of user tags that you want to add to your volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)

timeouts IsInstanceVolumeAttachmentTimeouts

type string

(String) The type of volume attachment. Supported values are boot, data.

version string

volume string

The unique identifier for the existing volume

volumeAttachmentId string

(String) The unique identifier for this volume attachment.

volumeCrn string

(String) The CRN for this volume.

volumeDeleted string

(String) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.

volumeHref string

(String) The URL for this volume.

volumeName string

The unique user-defined name for this new volume.

bandwidth float

The maximum bandwidth (in megabits per second) for the volume. For this property to be specified, the volume storage_generation must be 2.

capacity float

The capacity of the volume in gigabytes.

NOTE • The specified minimum and maximum capacity values for creating or updating volumes may expand in the future. Accepted value is in [10-16000]. **•** If unspecified, the capacity will be the source snapshot's minimum_capacity when snapshot is provided.**•** Supports only expansion on update (must not be less than the current volume capacity)**•** Can be updated only if volume is attached to an running virtual server instance.**•** Stopped instance will be started on update of capacity of the volume.

delete_volume_on_attachment_delete bool

If set to true, when deleting the attachment, the volume will also be deleted. By default it is true

delete_volume_on_instance_delete bool

If set to true, when deleting the instance, the volume will also be deleted. By default it is false

device str

(String) A unique identifier for the device which is exposed to the instance operating system.

encryption_key str

href str

(String) The URL for this volume attachment.

instance str

The id of the instance.

iops float

The bandwidth for the new volume. This value is required for custom storage profiles only.

NOTE • iops value can be upgraded and downgraged if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume. • This table shows how storage size affects the iops ranges:

is_instance_volume_attachment_id str

(String) The ID of the instance volume attachment. The ID is composed of <instance_id>/<volume_attachment_id>.

name str

The name of the volume attachment.

profile str

The globally unique name for this volume profile.

NOTE • Allowed values are : [general-purpose, 5iops-tier, 10iops-tier, custom]. • If iops is not present, general-purpose is taken as the volume profile. • If iops is present, custom is taken as the volume profile. • Tiered profiles [general-purpose, 5iops-tier, 10iops-tier] can be upgraded and downgraded into each other. • Can be updated only if volume is attached to an running virtual server instance. • Stopped instances will be started on update of volume.

snapshot str

The unique identifier for this snapshot from which to clone the new volume.

NOTE • one of capacity or snapshot must be present for volume creation. • If capacity is not present or less than minimum_capacity of the snapshot, minimum_capacity is taken as the volume capacity.

snapshot_crn str

The CRN for this snapshot from which to clone the new volume.

NOTE • one of capacity or snapshot must be present for volume creation. • If capacity is not present or less than minimum_capacity of the snapshot, minimum_capacity is taken as the volume capacity.

status str

(String) The status of this volume attachment. Supported values are attached, attaching, deleting, detaching.

tags Sequence[str]

A list of user tags that you want to add to your volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)

timeouts IsInstanceVolumeAttachmentTimeoutsArgs

type str

(String) The type of volume attachment. Supported values are boot, data.

version str

volume str

The unique identifier for the existing volume

volume_attachment_id str

(String) The unique identifier for this volume attachment.

volume_crn str

(String) The CRN for this volume.

volume_deleted str

(String) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.

volume_href str

(String) The URL for this volume.

volume_name str

The unique user-defined name for this new volume.

bandwidth Number

The maximum bandwidth (in megabits per second) for the volume. For this property to be specified, the volume storage_generation must be 2.

capacity Number

The capacity of the volume in gigabytes.

NOTE • The specified minimum and maximum capacity values for creating or updating volumes may expand in the future. Accepted value is in [10-16000]. **•** If unspecified, the capacity will be the source snapshot's minimum_capacity when snapshot is provided.**•** Supports only expansion on update (must not be less than the current volume capacity)**•** Can be updated only if volume is attached to an running virtual server instance.**•** Stopped instance will be started on update of capacity of the volume.

deleteVolumeOnAttachmentDelete Boolean

If set to true, when deleting the attachment, the volume will also be deleted. By default it is true

deleteVolumeOnInstanceDelete Boolean

If set to true, when deleting the instance, the volume will also be deleted. By default it is false

device String

(String) A unique identifier for the device which is exposed to the instance operating system.

encryptionKey String

href String

(String) The URL for this volume attachment.

instance String

The id of the instance.

iops Number

The bandwidth for the new volume. This value is required for custom storage profiles only.

NOTE • iops value can be upgraded and downgraged if volume is attached to an running virtual server instance. Stopped instances will be started on update of volume. • This table shows how storage size affects the iops ranges:

isInstanceVolumeAttachmentId String

(String) The ID of the instance volume attachment. The ID is composed of <instance_id>/<volume_attachment_id>.

name String

The name of the volume attachment.

profile String

The globally unique name for this volume profile.

NOTE • Allowed values are : [general-purpose, 5iops-tier, 10iops-tier, custom]. • If iops is not present, general-purpose is taken as the volume profile. • If iops is present, custom is taken as the volume profile. • Tiered profiles [general-purpose, 5iops-tier, 10iops-tier] can be upgraded and downgraded into each other. • Can be updated only if volume is attached to an running virtual server instance. • Stopped instances will be started on update of volume.

snapshot String

The unique identifier for this snapshot from which to clone the new volume.

NOTE • one of capacity or snapshot must be present for volume creation. • If capacity is not present or less than minimum_capacity of the snapshot, minimum_capacity is taken as the volume capacity.

snapshotCrn String

The CRN for this snapshot from which to clone the new volume.

NOTE • one of capacity or snapshot must be present for volume creation. • If capacity is not present or less than minimum_capacity of the snapshot, minimum_capacity is taken as the volume capacity.

status String

(String) The status of this volume attachment. Supported values are attached, attaching, deleting, detaching.

tags List<String>

A list of user tags that you want to add to your volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)

timeouts Property Map

type String

(String) The type of volume attachment. Supported values are boot, data.

version String

volume String

The unique identifier for the existing volume

volumeAttachmentId String

(String) The unique identifier for this volume attachment.

volumeCrn String

(String) The CRN for this volume.

volumeDeleted String

(String) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.

volumeHref String

(String) The URL for this volume.

volumeName String

The unique user-defined name for this new volume.

Supporting Types

IsInstanceVolumeAttachmentTimeouts, IsInstanceVolumeAttachmentTimeoutsArgs

Create string
Delete string
Update string

Create string
Delete string
Update string

create String
delete String
update String

create string
delete string
update string

create str
delete str
update str

create String
delete String
update String

Import

The ibm_is_instance_volume_attachment resource can be imported by using the instance id and volume attachment id.

Syntax

$ pulumi import ibm:index/isInstanceVolumeAttachment:IsInstanceVolumeAttachment example <instance_id>/<volume_attachment_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.

ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm-cloud/terraform-provider-ibm

ibm.IsInstanceVolumeAttachment

On this page

On this page

Example Usage

Using Capacity)

Using Existing Volume)

Creating New Volume)

Restoring Using Snapshot)

Create IsInstanceVolumeAttachment Resource

Constructor syntax

Parameters

Constructor example

IsInstanceVolumeAttachment Resource Properties

Inputs

Outputs

Look up Existing IsInstanceVolumeAttachment Resource

Supporting Types

IsInstanceVolumeAttachmentTimeouts, IsInstanceVolumeAttachmentTimeoutsArgs

Import

Package Details

On this page

On this page