/** * Core Services API * Use the Core Services API to manage resources such as virtual cloud networks (VCNs), compute instances, and block storage volumes. For more information, see the console documentation for the [Networking](https://docs.oracle.com/iaas/Content/Network/Concepts/overview.htm), [Compute](https://docs.oracle.com/iaas/Content/Compute/Concepts/computeoverview.htm), and [Block Volume](https://docs.oracle.com/iaas/Content/Block/Concepts/overview.htm) services. The required permissions are documented in the [Details for the Core Services](https://docs.oracle.com/iaas/Content/Identity/Reference/corepolicyreference.htm) article. * OpenAPI spec version: 20160918 * * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ /** * A base object for all types of attachments between a storage volume and an instance. * For specific details about iSCSI attachments, see * {@link IScsiVolumeAttachment}. *
For general information about volume attachments, see * [Overview of Block Volume Storage](https://docs.oracle.com/iaas/Content/Block/Concepts/overview.htm). *
**Warning:** Oracle recommends that you avoid using any confidential information when you * supply string values using the API. * */ export interface VolumeAttachment { /** * The availability domain of an instance. *
Example: {@code Uocm:PHX-AD-1} * */ "availabilityDomain": string; /** * The OCID of the compartment. */ "compartmentId": string; /** * The device name. */ "device"?: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. * Avoid entering confidential information. * */ "displayName"?: string; /** * The OCID of the volume attachment. */ "id": string; /** * The OCID of the instance the volume is attached to. */ "instanceId": string; /** * Whether the attachment was created in read-only mode. */ "isReadOnly"?: 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. * */ "isShareable"?: boolean; /** * The current state of the volume attachment. */ "lifecycleState": VolumeAttachment.LifecycleState; /** * The date and time the volume was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). *
Example: {@code 2016-08-25T21:10:29.600Z} * */ "timeCreated": Date; /** * The OCID of the volume. */ "volumeId": string; /** * Deprecated. Use {@code isEncryptionInTransitEnabled} instead. * */ "isPvEncryptionInTransitEnabled"?: boolean; /** * Whether in-transit encryption for the data volume's attachment is enabled or not. */ "isEncryptionInTransitEnabled"?: boolean; /** * Whether the Iscsi or Paravirtualized attachment is multipath or not, it is not applicable to NVMe attachment. */ "isMultipath"?: boolean; /** * 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. * */ "iscsiLoginState"?: VolumeAttachment.IscsiLoginState; /** * Flag indicating if this volume was created for the customer as part of a simplified launch. * Used to determine whether the volume requires deletion on instance termination. * */ "isVolumeCreatedDuringLaunch"?: boolean; "attachmentType": string; } export declare namespace VolumeAttachment { enum LifecycleState { Attaching = "ATTACHING", Attached = "ATTACHED", Detaching = "DETACHING", Detached = "DETACHED", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } enum IscsiLoginState { Unknown = "UNKNOWN", LoggingIn = "LOGGING_IN", LoginSucceeded = "LOGIN_SUCCEEDED", LoginFailed = "LOGIN_FAILED", LoggingOut = "LOGGING_OUT", LogoutSucceeded = "LOGOUT_SUCCEEDED", LogoutFailed = "LOGOUT_FAILED", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } function getJsonObj(obj: VolumeAttachment): object; function getDeserializedJsonObj(obj: VolumeAttachment): object; }