1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. VolumeAttachment
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

oci.Core.VolumeAttachment

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

    This resource provides the Volume Attachment resource in Oracle Cloud Infrastructure Core service.

    Attaches the specified storage volume to the specified instance.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testVolumeAttachment = new oci.core.VolumeAttachment("testVolumeAttachment", {
        attachmentType: _var.volume_attachment_attachment_type,
        instanceId: oci_core_instance.test_instance.id,
        volumeId: oci_core_volume.test_volume.id,
        device: _var.volume_attachment_device,
        displayName: _var.volume_attachment_display_name,
        encryptionInTransitType: _var.volume_attachment_encryption_in_transit_type,
        isAgentAutoIscsiLoginEnabled: _var.volume_attachment_is_agent_auto_iscsi_login_enabled,
        isPvEncryptionInTransitEnabled: _var.volume_attachment_is_pv_encryption_in_transit_enabled,
        isReadOnly: _var.volume_attachment_is_read_only,
        isShareable: _var.volume_attachment_is_shareable,
        useChap: _var.volume_attachment_use_chap,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_volume_attachment = oci.core.VolumeAttachment("testVolumeAttachment",
        attachment_type=var["volume_attachment_attachment_type"],
        instance_id=oci_core_instance["test_instance"]["id"],
        volume_id=oci_core_volume["test_volume"]["id"],
        device=var["volume_attachment_device"],
        display_name=var["volume_attachment_display_name"],
        encryption_in_transit_type=var["volume_attachment_encryption_in_transit_type"],
        is_agent_auto_iscsi_login_enabled=var["volume_attachment_is_agent_auto_iscsi_login_enabled"],
        is_pv_encryption_in_transit_enabled=var["volume_attachment_is_pv_encryption_in_transit_enabled"],
        is_read_only=var["volume_attachment_is_read_only"],
        is_shareable=var["volume_attachment_is_shareable"],
        use_chap=var["volume_attachment_use_chap"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/Core"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Core.NewVolumeAttachment(ctx, "testVolumeAttachment", &Core.VolumeAttachmentArgs{
    			AttachmentType:                 pulumi.Any(_var.Volume_attachment_attachment_type),
    			InstanceId:                     pulumi.Any(oci_core_instance.Test_instance.Id),
    			VolumeId:                       pulumi.Any(oci_core_volume.Test_volume.Id),
    			Device:                         pulumi.Any(_var.Volume_attachment_device),
    			DisplayName:                    pulumi.Any(_var.Volume_attachment_display_name),
    			EncryptionInTransitType:        pulumi.Any(_var.Volume_attachment_encryption_in_transit_type),
    			IsAgentAutoIscsiLoginEnabled:   pulumi.Any(_var.Volume_attachment_is_agent_auto_iscsi_login_enabled),
    			IsPvEncryptionInTransitEnabled: pulumi.Any(_var.Volume_attachment_is_pv_encryption_in_transit_enabled),
    			IsReadOnly:                     pulumi.Any(_var.Volume_attachment_is_read_only),
    			IsShareable:                    pulumi.Any(_var.Volume_attachment_is_shareable),
    			UseChap:                        pulumi.Any(_var.Volume_attachment_use_chap),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testVolumeAttachment = new Oci.Core.VolumeAttachment("testVolumeAttachment", new()
        {
            AttachmentType = @var.Volume_attachment_attachment_type,
            InstanceId = oci_core_instance.Test_instance.Id,
            VolumeId = oci_core_volume.Test_volume.Id,
            Device = @var.Volume_attachment_device,
            DisplayName = @var.Volume_attachment_display_name,
            EncryptionInTransitType = @var.Volume_attachment_encryption_in_transit_type,
            IsAgentAutoIscsiLoginEnabled = @var.Volume_attachment_is_agent_auto_iscsi_login_enabled,
            IsPvEncryptionInTransitEnabled = @var.Volume_attachment_is_pv_encryption_in_transit_enabled,
            IsReadOnly = @var.Volume_attachment_is_read_only,
            IsShareable = @var.Volume_attachment_is_shareable,
            UseChap = @var.Volume_attachment_use_chap,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Core.VolumeAttachment;
    import com.pulumi.oci.Core.VolumeAttachmentArgs;
    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 testVolumeAttachment = new VolumeAttachment("testVolumeAttachment", VolumeAttachmentArgs.builder()        
                .attachmentType(var_.volume_attachment_attachment_type())
                .instanceId(oci_core_instance.test_instance().id())
                .volumeId(oci_core_volume.test_volume().id())
                .device(var_.volume_attachment_device())
                .displayName(var_.volume_attachment_display_name())
                .encryptionInTransitType(var_.volume_attachment_encryption_in_transit_type())
                .isAgentAutoIscsiLoginEnabled(var_.volume_attachment_is_agent_auto_iscsi_login_enabled())
                .isPvEncryptionInTransitEnabled(var_.volume_attachment_is_pv_encryption_in_transit_enabled())
                .isReadOnly(var_.volume_attachment_is_read_only())
                .isShareable(var_.volume_attachment_is_shareable())
                .useChap(var_.volume_attachment_use_chap())
                .build());
    
        }
    }
    
    resources:
      testVolumeAttachment:
        type: oci:Core:VolumeAttachment
        properties:
          #Required
          attachmentType: ${var.volume_attachment_attachment_type}
          instanceId: ${oci_core_instance.test_instance.id}
          volumeId: ${oci_core_volume.test_volume.id}
          #Optional
          device: ${var.volume_attachment_device}
          displayName: ${var.volume_attachment_display_name}
          encryptionInTransitType: ${var.volume_attachment_encryption_in_transit_type}
          isAgentAutoIscsiLoginEnabled: ${var.volume_attachment_is_agent_auto_iscsi_login_enabled}
          isPvEncryptionInTransitEnabled: ${var.volume_attachment_is_pv_encryption_in_transit_enabled}
          isReadOnly: ${var.volume_attachment_is_read_only}
          isShareable: ${var.volume_attachment_is_shareable}
          useChap: ${var.volume_attachment_use_chap}
    

    Create VolumeAttachment Resource

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

    Constructor syntax

    new VolumeAttachment(name: string, args: VolumeAttachmentArgs, opts?: CustomResourceOptions);
    @overload
    def VolumeAttachment(resource_name: str,
                         args: VolumeAttachmentArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def VolumeAttachment(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         attachment_type: Optional[str] = None,
                         instance_id: Optional[str] = None,
                         volume_id: Optional[str] = None,
                         compartment_id: Optional[str] = None,
                         device: Optional[str] = None,
                         display_name: Optional[str] = None,
                         encryption_in_transit_type: Optional[str] = None,
                         is_agent_auto_iscsi_login_enabled: Optional[bool] = None,
                         is_pv_encryption_in_transit_enabled: Optional[bool] = None,
                         is_read_only: Optional[bool] = None,
                         is_shareable: Optional[bool] = None,
                         use_chap: Optional[bool] = None)
    func NewVolumeAttachment(ctx *Context, name string, args VolumeAttachmentArgs, opts ...ResourceOption) (*VolumeAttachment, error)
    public VolumeAttachment(string name, VolumeAttachmentArgs args, CustomResourceOptions? opts = null)
    public VolumeAttachment(String name, VolumeAttachmentArgs args)
    public VolumeAttachment(String name, VolumeAttachmentArgs args, CustomResourceOptions options)
    
    type: oci:Core:VolumeAttachment
    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 VolumeAttachmentArgs
    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 VolumeAttachmentArgs
    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 VolumeAttachmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VolumeAttachmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VolumeAttachmentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var volumeAttachmentResource = new Oci.Core.VolumeAttachment("volumeAttachmentResource", new()
    {
        AttachmentType = "string",
        InstanceId = "string",
        VolumeId = "string",
        Device = "string",
        DisplayName = "string",
        EncryptionInTransitType = "string",
        IsAgentAutoIscsiLoginEnabled = false,
        IsPvEncryptionInTransitEnabled = false,
        IsReadOnly = false,
        IsShareable = false,
        UseChap = false,
    });
    
    example, err := Core.NewVolumeAttachment(ctx, "volumeAttachmentResource", &Core.VolumeAttachmentArgs{
    	AttachmentType:                 pulumi.String("string"),
    	InstanceId:                     pulumi.String("string"),
    	VolumeId:                       pulumi.String("string"),
    	Device:                         pulumi.String("string"),
    	DisplayName:                    pulumi.String("string"),
    	EncryptionInTransitType:        pulumi.String("string"),
    	IsAgentAutoIscsiLoginEnabled:   pulumi.Bool(false),
    	IsPvEncryptionInTransitEnabled: pulumi.Bool(false),
    	IsReadOnly:                     pulumi.Bool(false),
    	IsShareable:                    pulumi.Bool(false),
    	UseChap:                        pulumi.Bool(false),
    })
    
    var volumeAttachmentResource = new VolumeAttachment("volumeAttachmentResource", VolumeAttachmentArgs.builder()        
        .attachmentType("string")
        .instanceId("string")
        .volumeId("string")
        .device("string")
        .displayName("string")
        .encryptionInTransitType("string")
        .isAgentAutoIscsiLoginEnabled(false)
        .isPvEncryptionInTransitEnabled(false)
        .isReadOnly(false)
        .isShareable(false)
        .useChap(false)
        .build());
    
    volume_attachment_resource = oci.core.VolumeAttachment("volumeAttachmentResource",
        attachment_type="string",
        instance_id="string",
        volume_id="string",
        device="string",
        display_name="string",
        encryption_in_transit_type="string",
        is_agent_auto_iscsi_login_enabled=False,
        is_pv_encryption_in_transit_enabled=False,
        is_read_only=False,
        is_shareable=False,
        use_chap=False)
    
    const volumeAttachmentResource = new oci.core.VolumeAttachment("volumeAttachmentResource", {
        attachmentType: "string",
        instanceId: "string",
        volumeId: "string",
        device: "string",
        displayName: "string",
        encryptionInTransitType: "string",
        isAgentAutoIscsiLoginEnabled: false,
        isPvEncryptionInTransitEnabled: false,
        isReadOnly: false,
        isShareable: false,
        useChap: false,
    });
    
    type: oci:Core:VolumeAttachment
    properties:
        attachmentType: string
        device: string
        displayName: string
        encryptionInTransitType: string
        instanceId: string
        isAgentAutoIscsiLoginEnabled: false
        isPvEncryptionInTransitEnabled: false
        isReadOnly: false
        isShareable: false
        useChap: false
        volumeId: string
    

    VolumeAttachment Resource Properties

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

    Inputs

    The VolumeAttachment resource accepts the following input properties:

    AttachmentType string
    The type of volume. The only supported values are "iscsi" and "paravirtualized".
    InstanceId string
    The OCID of the instance.
    VolumeId string

    The OCID of the volume.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    CompartmentId string
    The OCID of the compartment.

    Deprecated: The 'compartment_id' field has been deprecated and may be removed in a future version. Do not use this field.

    Device string
    The device name. To retrieve a list of devices for a given instance, see ListInstanceDevices.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    EncryptionInTransitType string
    Refer the top-level definition of encryptionInTransitType. The default value is NONE.
    IsAgentAutoIscsiLoginEnabled bool
    Whether to enable Oracle Cloud Agent to perform the iSCSI login and logout commands after the volume attach or detach operations for non multipath-enabled iSCSI attachments.
    IsPvEncryptionInTransitEnabled bool
    Whether to enable in-transit encryption for the data volume's paravirtualized attachment. The default value is false.
    IsReadOnly bool
    Whether the attachment was created in read-only mode.
    IsShareable bool
    Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.
    UseChap bool
    Whether to use CHAP authentication for the volume attachment. Defaults to false.
    AttachmentType string
    The type of volume. The only supported values are "iscsi" and "paravirtualized".
    InstanceId string
    The OCID of the instance.
    VolumeId string

    The OCID of the volume.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    CompartmentId string
    The OCID of the compartment.

    Deprecated: The 'compartment_id' field has been deprecated and may be removed in a future version. Do not use this field.

    Device string
    The device name. To retrieve a list of devices for a given instance, see ListInstanceDevices.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    EncryptionInTransitType string
    Refer the top-level definition of encryptionInTransitType. The default value is NONE.
    IsAgentAutoIscsiLoginEnabled bool
    Whether to enable Oracle Cloud Agent to perform the iSCSI login and logout commands after the volume attach or detach operations for non multipath-enabled iSCSI attachments.
    IsPvEncryptionInTransitEnabled bool
    Whether to enable in-transit encryption for the data volume's paravirtualized attachment. The default value is false.
    IsReadOnly bool
    Whether the attachment was created in read-only mode.
    IsShareable bool
    Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.
    UseChap bool
    Whether to use CHAP authentication for the volume attachment. Defaults to false.
    attachmentType String
    The type of volume. The only supported values are "iscsi" and "paravirtualized".
    instanceId String
    The OCID of the instance.
    volumeId String

    The OCID of the volume.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    The OCID of the compartment.

    Deprecated: The 'compartment_id' field has been deprecated and may be removed in a future version. Do not use this field.

    device String
    The device name. To retrieve a list of devices for a given instance, see ListInstanceDevices.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    encryptionInTransitType String
    Refer the top-level definition of encryptionInTransitType. The default value is NONE.
    isAgentAutoIscsiLoginEnabled Boolean
    Whether to enable Oracle Cloud Agent to perform the iSCSI login and logout commands after the volume attach or detach operations for non multipath-enabled iSCSI attachments.
    isPvEncryptionInTransitEnabled Boolean
    Whether to enable in-transit encryption for the data volume's paravirtualized attachment. The default value is false.
    isReadOnly Boolean
    Whether the attachment was created in read-only mode.
    isShareable Boolean
    Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.
    useChap Boolean
    Whether to use CHAP authentication for the volume attachment. Defaults to false.
    attachmentType string
    The type of volume. The only supported values are "iscsi" and "paravirtualized".
    instanceId string
    The OCID of the instance.
    volumeId string

    The OCID of the volume.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId string
    The OCID of the compartment.

    Deprecated: The 'compartment_id' field has been deprecated and may be removed in a future version. Do not use this field.

    device string
    The device name. To retrieve a list of devices for a given instance, see ListInstanceDevices.
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    encryptionInTransitType string
    Refer the top-level definition of encryptionInTransitType. The default value is NONE.
    isAgentAutoIscsiLoginEnabled boolean
    Whether to enable Oracle Cloud Agent to perform the iSCSI login and logout commands after the volume attach or detach operations for non multipath-enabled iSCSI attachments.
    isPvEncryptionInTransitEnabled boolean
    Whether to enable in-transit encryption for the data volume's paravirtualized attachment. The default value is false.
    isReadOnly boolean
    Whether the attachment was created in read-only mode.
    isShareable boolean
    Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.
    useChap boolean
    Whether to use CHAP authentication for the volume attachment. Defaults to false.
    attachment_type str
    The type of volume. The only supported values are "iscsi" and "paravirtualized".
    instance_id str
    The OCID of the instance.
    volume_id str

    The OCID of the volume.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartment_id str
    The OCID of the compartment.

    Deprecated: The 'compartment_id' field has been deprecated and may be removed in a future version. Do not use this field.

    device str
    The device name. To retrieve a list of devices for a given instance, see ListInstanceDevices.
    display_name str
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    encryption_in_transit_type str
    Refer the top-level definition of encryptionInTransitType. The default value is NONE.
    is_agent_auto_iscsi_login_enabled bool
    Whether to enable Oracle Cloud Agent to perform the iSCSI login and logout commands after the volume attach or detach operations for non multipath-enabled iSCSI attachments.
    is_pv_encryption_in_transit_enabled bool
    Whether to enable in-transit encryption for the data volume's paravirtualized attachment. The default value is false.
    is_read_only bool
    Whether the attachment was created in read-only mode.
    is_shareable bool
    Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.
    use_chap bool
    Whether to use CHAP authentication for the volume attachment. Defaults to false.
    attachmentType String
    The type of volume. The only supported values are "iscsi" and "paravirtualized".
    instanceId String
    The OCID of the instance.
    volumeId String

    The OCID of the volume.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    The OCID of the compartment.

    Deprecated: The 'compartment_id' field has been deprecated and may be removed in a future version. Do not use this field.

    device String
    The device name. To retrieve a list of devices for a given instance, see ListInstanceDevices.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    encryptionInTransitType String
    Refer the top-level definition of encryptionInTransitType. The default value is NONE.
    isAgentAutoIscsiLoginEnabled Boolean
    Whether to enable Oracle Cloud Agent to perform the iSCSI login and logout commands after the volume attach or detach operations for non multipath-enabled iSCSI attachments.
    isPvEncryptionInTransitEnabled Boolean
    Whether to enable in-transit encryption for the data volume's paravirtualized attachment. The default value is false.
    isReadOnly Boolean
    Whether the attachment was created in read-only mode.
    isShareable Boolean
    Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.
    useChap Boolean
    Whether to use CHAP authentication for the volume attachment. Defaults to false.

    Outputs

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

    AvailabilityDomain string
    The availability domain of an instance. Example: Uocm:PHX-AD-1
    ChapSecret string
    The Challenge-Handshake-Authentication-Protocol (CHAP) secret valid for the associated CHAP user name. (Also called the "CHAP password".)
    ChapUsername string
    The volume's system-generated Challenge-Handshake-Authentication-Protocol (CHAP) user name. See RFC 1994 for more on CHAP. Example: ocid1.volume.oc1.phx.<unique_ID>
    Id string
    The provider-assigned unique ID for this managed resource.
    Ipv4 string
    The volume's iSCSI IP address. Example: 169.254.2.2
    Iqn string
    The target volume's iSCSI Qualified Name in the format defined by RFC 3720. Example: iqn.2015-12.com.oracleiaas:40b7ee03-883f-46c6-a951-63d2841d2195
    IsMultipath bool
    Whether the Iscsi or Paravirtualized attachment is multipath or not, it is not applicable to NVMe attachment.
    IscsiLoginState string
    The iscsi login state of the volume attachment. For a Iscsi volume attachment, all iscsi sessions need to be all logged-in or logged-out to be in logged-in or logged-out state.
    MultipathDevices List<VolumeAttachmentMultipathDevice>
    A list of secondary multipath devices
    Port int
    The volume's iSCSI port, usually port 860 or 3260. Example: 3260
    State string
    The current state of the volume attachment.
    TimeCreated string
    The date and time the volume was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    AvailabilityDomain string
    The availability domain of an instance. Example: Uocm:PHX-AD-1
    ChapSecret string
    The Challenge-Handshake-Authentication-Protocol (CHAP) secret valid for the associated CHAP user name. (Also called the "CHAP password".)
    ChapUsername string
    The volume's system-generated Challenge-Handshake-Authentication-Protocol (CHAP) user name. See RFC 1994 for more on CHAP. Example: ocid1.volume.oc1.phx.<unique_ID>
    Id string
    The provider-assigned unique ID for this managed resource.
    Ipv4 string
    The volume's iSCSI IP address. Example: 169.254.2.2
    Iqn string
    The target volume's iSCSI Qualified Name in the format defined by RFC 3720. Example: iqn.2015-12.com.oracleiaas:40b7ee03-883f-46c6-a951-63d2841d2195
    IsMultipath bool
    Whether the Iscsi or Paravirtualized attachment is multipath or not, it is not applicable to NVMe attachment.
    IscsiLoginState string
    The iscsi login state of the volume attachment. For a Iscsi volume attachment, all iscsi sessions need to be all logged-in or logged-out to be in logged-in or logged-out state.
    MultipathDevices []VolumeAttachmentMultipathDevice
    A list of secondary multipath devices
    Port int
    The volume's iSCSI port, usually port 860 or 3260. Example: 3260
    State string
    The current state of the volume attachment.
    TimeCreated string
    The date and time the volume was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    availabilityDomain String
    The availability domain of an instance. Example: Uocm:PHX-AD-1
    chapSecret String
    The Challenge-Handshake-Authentication-Protocol (CHAP) secret valid for the associated CHAP user name. (Also called the "CHAP password".)
    chapUsername String
    The volume's system-generated Challenge-Handshake-Authentication-Protocol (CHAP) user name. See RFC 1994 for more on CHAP. Example: ocid1.volume.oc1.phx.<unique_ID>
    id String
    The provider-assigned unique ID for this managed resource.
    ipv4 String
    The volume's iSCSI IP address. Example: 169.254.2.2
    iqn String
    The target volume's iSCSI Qualified Name in the format defined by RFC 3720. Example: iqn.2015-12.com.oracleiaas:40b7ee03-883f-46c6-a951-63d2841d2195
    isMultipath Boolean
    Whether the Iscsi or Paravirtualized attachment is multipath or not, it is not applicable to NVMe attachment.
    iscsiLoginState String
    The iscsi login state of the volume attachment. For a Iscsi volume attachment, all iscsi sessions need to be all logged-in or logged-out to be in logged-in or logged-out state.
    multipathDevices List<VolumeAttachmentMultipathDevice>
    A list of secondary multipath devices
    port Integer
    The volume's iSCSI port, usually port 860 or 3260. Example: 3260
    state String
    The current state of the volume attachment.
    timeCreated String
    The date and time the volume was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    availabilityDomain string
    The availability domain of an instance. Example: Uocm:PHX-AD-1
    chapSecret string
    The Challenge-Handshake-Authentication-Protocol (CHAP) secret valid for the associated CHAP user name. (Also called the "CHAP password".)
    chapUsername string
    The volume's system-generated Challenge-Handshake-Authentication-Protocol (CHAP) user name. See RFC 1994 for more on CHAP. Example: ocid1.volume.oc1.phx.<unique_ID>
    id string
    The provider-assigned unique ID for this managed resource.
    ipv4 string
    The volume's iSCSI IP address. Example: 169.254.2.2
    iqn string
    The target volume's iSCSI Qualified Name in the format defined by RFC 3720. Example: iqn.2015-12.com.oracleiaas:40b7ee03-883f-46c6-a951-63d2841d2195
    isMultipath boolean
    Whether the Iscsi or Paravirtualized attachment is multipath or not, it is not applicable to NVMe attachment.
    iscsiLoginState string
    The iscsi login state of the volume attachment. For a Iscsi volume attachment, all iscsi sessions need to be all logged-in or logged-out to be in logged-in or logged-out state.
    multipathDevices VolumeAttachmentMultipathDevice[]
    A list of secondary multipath devices
    port number
    The volume's iSCSI port, usually port 860 or 3260. Example: 3260
    state string
    The current state of the volume attachment.
    timeCreated string
    The date and time the volume was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    availability_domain str
    The availability domain of an instance. Example: Uocm:PHX-AD-1
    chap_secret str
    The Challenge-Handshake-Authentication-Protocol (CHAP) secret valid for the associated CHAP user name. (Also called the "CHAP password".)
    chap_username str
    The volume's system-generated Challenge-Handshake-Authentication-Protocol (CHAP) user name. See RFC 1994 for more on CHAP. Example: ocid1.volume.oc1.phx.<unique_ID>
    id str
    The provider-assigned unique ID for this managed resource.
    ipv4 str
    The volume's iSCSI IP address. Example: 169.254.2.2
    iqn str
    The target volume's iSCSI Qualified Name in the format defined by RFC 3720. Example: iqn.2015-12.com.oracleiaas:40b7ee03-883f-46c6-a951-63d2841d2195
    is_multipath bool
    Whether the Iscsi or Paravirtualized attachment is multipath or not, it is not applicable to NVMe attachment.
    iscsi_login_state str
    The iscsi login state of the volume attachment. For a Iscsi volume attachment, all iscsi sessions need to be all logged-in or logged-out to be in logged-in or logged-out state.
    multipath_devices Sequence[core.VolumeAttachmentMultipathDevice]
    A list of secondary multipath devices
    port int
    The volume's iSCSI port, usually port 860 or 3260. Example: 3260
    state str
    The current state of the volume attachment.
    time_created str
    The date and time the volume was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    availabilityDomain String
    The availability domain of an instance. Example: Uocm:PHX-AD-1
    chapSecret String
    The Challenge-Handshake-Authentication-Protocol (CHAP) secret valid for the associated CHAP user name. (Also called the "CHAP password".)
    chapUsername String
    The volume's system-generated Challenge-Handshake-Authentication-Protocol (CHAP) user name. See RFC 1994 for more on CHAP. Example: ocid1.volume.oc1.phx.<unique_ID>
    id String
    The provider-assigned unique ID for this managed resource.
    ipv4 String
    The volume's iSCSI IP address. Example: 169.254.2.2
    iqn String
    The target volume's iSCSI Qualified Name in the format defined by RFC 3720. Example: iqn.2015-12.com.oracleiaas:40b7ee03-883f-46c6-a951-63d2841d2195
    isMultipath Boolean
    Whether the Iscsi or Paravirtualized attachment is multipath or not, it is not applicable to NVMe attachment.
    iscsiLoginState String
    The iscsi login state of the volume attachment. For a Iscsi volume attachment, all iscsi sessions need to be all logged-in or logged-out to be in logged-in or logged-out state.
    multipathDevices List<Property Map>
    A list of secondary multipath devices
    port Number
    The volume's iSCSI port, usually port 860 or 3260. Example: 3260
    state String
    The current state of the volume attachment.
    timeCreated String
    The date and time the volume was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

    Look up Existing VolumeAttachment Resource

    Get an existing VolumeAttachment 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?: VolumeAttachmentState, opts?: CustomResourceOptions): VolumeAttachment
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            attachment_type: Optional[str] = None,
            availability_domain: Optional[str] = None,
            chap_secret: Optional[str] = None,
            chap_username: Optional[str] = None,
            compartment_id: Optional[str] = None,
            device: Optional[str] = None,
            display_name: Optional[str] = None,
            encryption_in_transit_type: Optional[str] = None,
            instance_id: Optional[str] = None,
            ipv4: Optional[str] = None,
            iqn: Optional[str] = None,
            is_agent_auto_iscsi_login_enabled: Optional[bool] = None,
            is_multipath: Optional[bool] = None,
            is_pv_encryption_in_transit_enabled: Optional[bool] = None,
            is_read_only: Optional[bool] = None,
            is_shareable: Optional[bool] = None,
            iscsi_login_state: Optional[str] = None,
            multipath_devices: Optional[Sequence[_core.VolumeAttachmentMultipathDeviceArgs]] = None,
            port: Optional[int] = None,
            state: Optional[str] = None,
            time_created: Optional[str] = None,
            use_chap: Optional[bool] = None,
            volume_id: Optional[str] = None) -> VolumeAttachment
    func GetVolumeAttachment(ctx *Context, name string, id IDInput, state *VolumeAttachmentState, opts ...ResourceOption) (*VolumeAttachment, error)
    public static VolumeAttachment Get(string name, Input<string> id, VolumeAttachmentState? state, CustomResourceOptions? opts = null)
    public static VolumeAttachment get(String name, Output<String> id, VolumeAttachmentState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    AttachmentType string
    The type of volume. The only supported values are "iscsi" and "paravirtualized".
    AvailabilityDomain string
    The availability domain of an instance. Example: Uocm:PHX-AD-1
    ChapSecret string
    The Challenge-Handshake-Authentication-Protocol (CHAP) secret valid for the associated CHAP user name. (Also called the "CHAP password".)
    ChapUsername string
    The volume's system-generated Challenge-Handshake-Authentication-Protocol (CHAP) user name. See RFC 1994 for more on CHAP. Example: ocid1.volume.oc1.phx.<unique_ID>
    CompartmentId string
    The OCID of the compartment.

    Deprecated: The 'compartment_id' field has been deprecated and may be removed in a future version. Do not use this field.

    Device string
    The device name. To retrieve a list of devices for a given instance, see ListInstanceDevices.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    EncryptionInTransitType string
    Refer the top-level definition of encryptionInTransitType. The default value is NONE.
    InstanceId string
    The OCID of the instance.
    Ipv4 string
    The volume's iSCSI IP address. Example: 169.254.2.2
    Iqn string
    The target volume's iSCSI Qualified Name in the format defined by RFC 3720. Example: iqn.2015-12.com.oracleiaas:40b7ee03-883f-46c6-a951-63d2841d2195
    IsAgentAutoIscsiLoginEnabled bool
    Whether to enable Oracle Cloud Agent to perform the iSCSI login and logout commands after the volume attach or detach operations for non multipath-enabled iSCSI attachments.
    IsMultipath bool
    Whether the Iscsi or Paravirtualized attachment is multipath or not, it is not applicable to NVMe attachment.
    IsPvEncryptionInTransitEnabled bool
    Whether to enable in-transit encryption for the data volume's paravirtualized attachment. The default value is false.
    IsReadOnly bool
    Whether the attachment was created in read-only mode.
    IsShareable bool
    Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.
    IscsiLoginState string
    The iscsi login state of the volume attachment. For a Iscsi volume attachment, all iscsi sessions need to be all logged-in or logged-out to be in logged-in or logged-out state.
    MultipathDevices List<VolumeAttachmentMultipathDevice>
    A list of secondary multipath devices
    Port int
    The volume's iSCSI port, usually port 860 or 3260. Example: 3260
    State string
    The current state of the volume attachment.
    TimeCreated string
    The date and time the volume was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    UseChap bool
    Whether to use CHAP authentication for the volume attachment. Defaults to false.
    VolumeId string

    The OCID of the volume.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    AttachmentType string
    The type of volume. The only supported values are "iscsi" and "paravirtualized".
    AvailabilityDomain string
    The availability domain of an instance. Example: Uocm:PHX-AD-1
    ChapSecret string
    The Challenge-Handshake-Authentication-Protocol (CHAP) secret valid for the associated CHAP user name. (Also called the "CHAP password".)
    ChapUsername string
    The volume's system-generated Challenge-Handshake-Authentication-Protocol (CHAP) user name. See RFC 1994 for more on CHAP. Example: ocid1.volume.oc1.phx.<unique_ID>
    CompartmentId string
    The OCID of the compartment.

    Deprecated: The 'compartment_id' field has been deprecated and may be removed in a future version. Do not use this field.

    Device string
    The device name. To retrieve a list of devices for a given instance, see ListInstanceDevices.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    EncryptionInTransitType string
    Refer the top-level definition of encryptionInTransitType. The default value is NONE.
    InstanceId string
    The OCID of the instance.
    Ipv4 string
    The volume's iSCSI IP address. Example: 169.254.2.2
    Iqn string
    The target volume's iSCSI Qualified Name in the format defined by RFC 3720. Example: iqn.2015-12.com.oracleiaas:40b7ee03-883f-46c6-a951-63d2841d2195
    IsAgentAutoIscsiLoginEnabled bool
    Whether to enable Oracle Cloud Agent to perform the iSCSI login and logout commands after the volume attach or detach operations for non multipath-enabled iSCSI attachments.
    IsMultipath bool
    Whether the Iscsi or Paravirtualized attachment is multipath or not, it is not applicable to NVMe attachment.
    IsPvEncryptionInTransitEnabled bool
    Whether to enable in-transit encryption for the data volume's paravirtualized attachment. The default value is false.
    IsReadOnly bool
    Whether the attachment was created in read-only mode.
    IsShareable bool
    Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.
    IscsiLoginState string
    The iscsi login state of the volume attachment. For a Iscsi volume attachment, all iscsi sessions need to be all logged-in or logged-out to be in logged-in or logged-out state.
    MultipathDevices []VolumeAttachmentMultipathDeviceArgs
    A list of secondary multipath devices
    Port int
    The volume's iSCSI port, usually port 860 or 3260. Example: 3260
    State string
    The current state of the volume attachment.
    TimeCreated string
    The date and time the volume was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    UseChap bool
    Whether to use CHAP authentication for the volume attachment. Defaults to false.
    VolumeId string

    The OCID of the volume.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    attachmentType String
    The type of volume. The only supported values are "iscsi" and "paravirtualized".
    availabilityDomain String
    The availability domain of an instance. Example: Uocm:PHX-AD-1
    chapSecret String
    The Challenge-Handshake-Authentication-Protocol (CHAP) secret valid for the associated CHAP user name. (Also called the "CHAP password".)
    chapUsername String
    The volume's system-generated Challenge-Handshake-Authentication-Protocol (CHAP) user name. See RFC 1994 for more on CHAP. Example: ocid1.volume.oc1.phx.<unique_ID>
    compartmentId String
    The OCID of the compartment.

    Deprecated: The 'compartment_id' field has been deprecated and may be removed in a future version. Do not use this field.

    device String
    The device name. To retrieve a list of devices for a given instance, see ListInstanceDevices.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    encryptionInTransitType String
    Refer the top-level definition of encryptionInTransitType. The default value is NONE.
    instanceId String
    The OCID of the instance.
    ipv4 String
    The volume's iSCSI IP address. Example: 169.254.2.2
    iqn String
    The target volume's iSCSI Qualified Name in the format defined by RFC 3720. Example: iqn.2015-12.com.oracleiaas:40b7ee03-883f-46c6-a951-63d2841d2195
    isAgentAutoIscsiLoginEnabled Boolean
    Whether to enable Oracle Cloud Agent to perform the iSCSI login and logout commands after the volume attach or detach operations for non multipath-enabled iSCSI attachments.
    isMultipath Boolean
    Whether the Iscsi or Paravirtualized attachment is multipath or not, it is not applicable to NVMe attachment.
    isPvEncryptionInTransitEnabled Boolean
    Whether to enable in-transit encryption for the data volume's paravirtualized attachment. The default value is false.
    isReadOnly Boolean
    Whether the attachment was created in read-only mode.
    isShareable Boolean
    Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.
    iscsiLoginState String
    The iscsi login state of the volume attachment. For a Iscsi volume attachment, all iscsi sessions need to be all logged-in or logged-out to be in logged-in or logged-out state.
    multipathDevices List<VolumeAttachmentMultipathDevice>
    A list of secondary multipath devices
    port Integer
    The volume's iSCSI port, usually port 860 or 3260. Example: 3260
    state String
    The current state of the volume attachment.
    timeCreated String
    The date and time the volume was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    useChap Boolean
    Whether to use CHAP authentication for the volume attachment. Defaults to false.
    volumeId String

    The OCID of the volume.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    attachmentType string
    The type of volume. The only supported values are "iscsi" and "paravirtualized".
    availabilityDomain string
    The availability domain of an instance. Example: Uocm:PHX-AD-1
    chapSecret string
    The Challenge-Handshake-Authentication-Protocol (CHAP) secret valid for the associated CHAP user name. (Also called the "CHAP password".)
    chapUsername string
    The volume's system-generated Challenge-Handshake-Authentication-Protocol (CHAP) user name. See RFC 1994 for more on CHAP. Example: ocid1.volume.oc1.phx.<unique_ID>
    compartmentId string
    The OCID of the compartment.

    Deprecated: The 'compartment_id' field has been deprecated and may be removed in a future version. Do not use this field.

    device string
    The device name. To retrieve a list of devices for a given instance, see ListInstanceDevices.
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    encryptionInTransitType string
    Refer the top-level definition of encryptionInTransitType. The default value is NONE.
    instanceId string
    The OCID of the instance.
    ipv4 string
    The volume's iSCSI IP address. Example: 169.254.2.2
    iqn string
    The target volume's iSCSI Qualified Name in the format defined by RFC 3720. Example: iqn.2015-12.com.oracleiaas:40b7ee03-883f-46c6-a951-63d2841d2195
    isAgentAutoIscsiLoginEnabled boolean
    Whether to enable Oracle Cloud Agent to perform the iSCSI login and logout commands after the volume attach or detach operations for non multipath-enabled iSCSI attachments.
    isMultipath boolean
    Whether the Iscsi or Paravirtualized attachment is multipath or not, it is not applicable to NVMe attachment.
    isPvEncryptionInTransitEnabled boolean
    Whether to enable in-transit encryption for the data volume's paravirtualized attachment. The default value is false.
    isReadOnly boolean
    Whether the attachment was created in read-only mode.
    isShareable boolean
    Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.
    iscsiLoginState string
    The iscsi login state of the volume attachment. For a Iscsi volume attachment, all iscsi sessions need to be all logged-in or logged-out to be in logged-in or logged-out state.
    multipathDevices VolumeAttachmentMultipathDevice[]
    A list of secondary multipath devices
    port number
    The volume's iSCSI port, usually port 860 or 3260. Example: 3260
    state string
    The current state of the volume attachment.
    timeCreated string
    The date and time the volume was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    useChap boolean
    Whether to use CHAP authentication for the volume attachment. Defaults to false.
    volumeId string

    The OCID of the volume.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    attachment_type str
    The type of volume. The only supported values are "iscsi" and "paravirtualized".
    availability_domain str
    The availability domain of an instance. Example: Uocm:PHX-AD-1
    chap_secret str
    The Challenge-Handshake-Authentication-Protocol (CHAP) secret valid for the associated CHAP user name. (Also called the "CHAP password".)
    chap_username str
    The volume's system-generated Challenge-Handshake-Authentication-Protocol (CHAP) user name. See RFC 1994 for more on CHAP. Example: ocid1.volume.oc1.phx.<unique_ID>
    compartment_id str
    The OCID of the compartment.

    Deprecated: The 'compartment_id' field has been deprecated and may be removed in a future version. Do not use this field.

    device str
    The device name. To retrieve a list of devices for a given instance, see ListInstanceDevices.
    display_name str
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    encryption_in_transit_type str
    Refer the top-level definition of encryptionInTransitType. The default value is NONE.
    instance_id str
    The OCID of the instance.
    ipv4 str
    The volume's iSCSI IP address. Example: 169.254.2.2
    iqn str
    The target volume's iSCSI Qualified Name in the format defined by RFC 3720. Example: iqn.2015-12.com.oracleiaas:40b7ee03-883f-46c6-a951-63d2841d2195
    is_agent_auto_iscsi_login_enabled bool
    Whether to enable Oracle Cloud Agent to perform the iSCSI login and logout commands after the volume attach or detach operations for non multipath-enabled iSCSI attachments.
    is_multipath bool
    Whether the Iscsi or Paravirtualized attachment is multipath or not, it is not applicable to NVMe attachment.
    is_pv_encryption_in_transit_enabled bool
    Whether to enable in-transit encryption for the data volume's paravirtualized attachment. The default value is false.
    is_read_only bool
    Whether the attachment was created in read-only mode.
    is_shareable bool
    Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.
    iscsi_login_state str
    The iscsi login state of the volume attachment. For a Iscsi volume attachment, all iscsi sessions need to be all logged-in or logged-out to be in logged-in or logged-out state.
    multipath_devices Sequence[core.VolumeAttachmentMultipathDeviceArgs]
    A list of secondary multipath devices
    port int
    The volume's iSCSI port, usually port 860 or 3260. Example: 3260
    state str
    The current state of the volume attachment.
    time_created str
    The date and time the volume was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    use_chap bool
    Whether to use CHAP authentication for the volume attachment. Defaults to false.
    volume_id str

    The OCID of the volume.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    attachmentType String
    The type of volume. The only supported values are "iscsi" and "paravirtualized".
    availabilityDomain String
    The availability domain of an instance. Example: Uocm:PHX-AD-1
    chapSecret String
    The Challenge-Handshake-Authentication-Protocol (CHAP) secret valid for the associated CHAP user name. (Also called the "CHAP password".)
    chapUsername String
    The volume's system-generated Challenge-Handshake-Authentication-Protocol (CHAP) user name. See RFC 1994 for more on CHAP. Example: ocid1.volume.oc1.phx.<unique_ID>
    compartmentId String
    The OCID of the compartment.

    Deprecated: The 'compartment_id' field has been deprecated and may be removed in a future version. Do not use this field.

    device String
    The device name. To retrieve a list of devices for a given instance, see ListInstanceDevices.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    encryptionInTransitType String
    Refer the top-level definition of encryptionInTransitType. The default value is NONE.
    instanceId String
    The OCID of the instance.
    ipv4 String
    The volume's iSCSI IP address. Example: 169.254.2.2
    iqn String
    The target volume's iSCSI Qualified Name in the format defined by RFC 3720. Example: iqn.2015-12.com.oracleiaas:40b7ee03-883f-46c6-a951-63d2841d2195
    isAgentAutoIscsiLoginEnabled Boolean
    Whether to enable Oracle Cloud Agent to perform the iSCSI login and logout commands after the volume attach or detach operations for non multipath-enabled iSCSI attachments.
    isMultipath Boolean
    Whether the Iscsi or Paravirtualized attachment is multipath or not, it is not applicable to NVMe attachment.
    isPvEncryptionInTransitEnabled Boolean
    Whether to enable in-transit encryption for the data volume's paravirtualized attachment. The default value is false.
    isReadOnly Boolean
    Whether the attachment was created in read-only mode.
    isShareable Boolean
    Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.
    iscsiLoginState String
    The iscsi login state of the volume attachment. For a Iscsi volume attachment, all iscsi sessions need to be all logged-in or logged-out to be in logged-in or logged-out state.
    multipathDevices List<Property Map>
    A list of secondary multipath devices
    port Number
    The volume's iSCSI port, usually port 860 or 3260. Example: 3260
    state String
    The current state of the volume attachment.
    timeCreated String
    The date and time the volume was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    useChap Boolean
    Whether to use CHAP authentication for the volume attachment. Defaults to false.
    volumeId String

    The OCID of the volume.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Supporting Types

    VolumeAttachmentMultipathDevice, VolumeAttachmentMultipathDeviceArgs

    Ipv4 string
    The volume's iSCSI IP address. Example: 169.254.2.2
    Iqn string
    The target volume's iSCSI Qualified Name in the format defined by RFC 3720. Example: iqn.2015-12.com.oracleiaas:40b7ee03-883f-46c6-a951-63d2841d2195
    Port int
    The volume's iSCSI port, usually port 860 or 3260. Example: 3260
    Ipv4 string
    The volume's iSCSI IP address. Example: 169.254.2.2
    Iqn string
    The target volume's iSCSI Qualified Name in the format defined by RFC 3720. Example: iqn.2015-12.com.oracleiaas:40b7ee03-883f-46c6-a951-63d2841d2195
    Port int
    The volume's iSCSI port, usually port 860 or 3260. Example: 3260
    ipv4 String
    The volume's iSCSI IP address. Example: 169.254.2.2
    iqn String
    The target volume's iSCSI Qualified Name in the format defined by RFC 3720. Example: iqn.2015-12.com.oracleiaas:40b7ee03-883f-46c6-a951-63d2841d2195
    port Integer
    The volume's iSCSI port, usually port 860 or 3260. Example: 3260
    ipv4 string
    The volume's iSCSI IP address. Example: 169.254.2.2
    iqn string
    The target volume's iSCSI Qualified Name in the format defined by RFC 3720. Example: iqn.2015-12.com.oracleiaas:40b7ee03-883f-46c6-a951-63d2841d2195
    port number
    The volume's iSCSI port, usually port 860 or 3260. Example: 3260
    ipv4 str
    The volume's iSCSI IP address. Example: 169.254.2.2
    iqn str
    The target volume's iSCSI Qualified Name in the format defined by RFC 3720. Example: iqn.2015-12.com.oracleiaas:40b7ee03-883f-46c6-a951-63d2841d2195
    port int
    The volume's iSCSI port, usually port 860 or 3260. Example: 3260
    ipv4 String
    The volume's iSCSI IP address. Example: 169.254.2.2
    iqn String
    The target volume's iSCSI Qualified Name in the format defined by RFC 3720. Example: iqn.2015-12.com.oracleiaas:40b7ee03-883f-46c6-a951-63d2841d2195
    port Number
    The volume's iSCSI port, usually port 860 or 3260. Example: 3260

    Import

    VolumeAttachments can be imported using the id, e.g.

    $ pulumi import oci:Core/volumeAttachment:VolumeAttachment test_volume_attachment "id"
    

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

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi