BootVolume

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/oracle/json-schema/oracle-boot-volume-schema.json",
  "title": "BootVolume",
  "description": "A detachable boot volume device that contains the image used to boot a Compute instance. For more information, see\n[Overview of Boot Volumes](/iaas/Content/Block/Concepts/bootvolumes.htm).\n\nTo use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,\ntalk to an administrator. If you're an administrator who needs to write policies to give users access, see\n[Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm).\n\n**Warning:** Oracle recommends that you avoid using any confidential information when you\nsupply string values using the API.\n",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-blockstorage-api-openapi.yml#/components/schemas/BootVolume",
  "properties": {
    "autoTunedVpusPerGB": {
      "description": "The number of Volume Performance Units per GB that this boot volume is effectively tuned to.\n",
      "format": "int64",
      "type": "integer"
    },
    "autotunePolicies": {
      "description": "The list of autotune policies enabled for this volume.",
      "items": {
        "$ref": "#/$defs/AutotunePolicy"
      },
      "type": "array",
      "uniqueItems": true
    },
    "availabilityDomain": {
      "description": "The availability domain of the boot volume.\n\nExample: `Uocm:PHX-AD-1`\n",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "bootVolumeReplicas": {
      "description": "The list of boot volume replicas of this boot volume",
      "items": {
        "$ref": "#/$defs/BootVolumeReplicaInfo"
      },
      "type": "array"
    },
    "clusterPlacementGroupId": {
      "description": "The clusterPlacementGroup Id of the volume for volume placement.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "compartmentId": {
      "description": "The OCID of the compartment that contains the boot volume.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "definedTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only the String type is supported.\n",
          "type": "object"
        },
        "description": "Key-value pair representing a defined tag key and value, scoped to a namespace.\n\nExample: `{\"CostCenter\": \"42\"}`\n",
        "type": "object"
      },
      "description": "Defined tags for this resource. Each key is predefined and scoped to a\nnamespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Operations\": {\"CostCenter\": \"42\"}}`\n",
      "type": "object"
    },
    "displayName": {
      "description": "A user-friendly name. Does not have to be unique, and it's changeable.\nAvoid entering confidential information.\n",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "freeformTags": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no\npredefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Department\": \"Finance\"}`\n",
      "type": "object"
    },
    "id": {
      "description": "The boot volume's Oracle ID (OCID).",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "imageId": {
      "description": "The image OCID used to create the boot volume.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "isAutoTuneEnabled": {
      "description": "Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated.\nUse the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune.\n",
      "type": "boolean"
    },
    "isHydrated": {
      "description": "Specifies whether the boot volume's data has finished copying\nfrom the source boot volume or boot volume backup.\n",
      "type": "boolean"
    },
    "kmsKeyId": {
      "description": "The OCID of the Vault service master encryption key assigned to the boot volume.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "lifecycleState": {
      "description": "The current state of a boot volume.",
      "enum": [
        "PROVISIONING",
        "RESTORING",
        "AVAILABLE",
        "TERMINATING",
        "TERMINATED",
        "FAULTY"
      ],
      "type": "string"
    },
    "sizeInGBs": {
      "description": "The size of the boot volume in GBs.",
      "format": "int64",
      "type": "integer"
    },
    "sizeInMBs": {
      "description": "The size of the volume in MBs. The value must be a multiple of 1024.\nThis field is deprecated. Please use sizeInGBs.\n",
      "format": "int64",
      "type": "integer"
    },
    "sourceDetails": {
      "$ref": "#/$defs/BootVolumeSourceDetails"
    },
    "timeCreated": {
      "description": "The date and time the boot volume was created. Format defined\nby [RFC3339](https://tools.ietf.org/html/rfc3339).\n",
      "format": "date-time",
      "type": "string"
    },
    "volumeGroupId": {
      "description": "The OCID of the source volume group.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "vpusPerGB": {
      "description": "The number of volume performance units (VPUs) that will be applied to this boot volume per GB,\nrepresenting the Block Volume service's elastic performance options.\nSee [Block Volume Performance Levels](/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n\nAllowed values:\n\n  * `10`: Represents Balanced option.\n\n  * `20`: Represents Higher Performance option.\n\n  * `30`-`120`: Represents the Ultra High Performance option.\n\nFor performance autotune enabled volumes, it would be the Default(Minimum) VPUs/GB.\n",
      "format": "int64",
      "type": "integer"
    }
  },
  "required": [
    "id",
    "availabilityDomain",
    "sizeInMBs",
    "compartmentId",
    "timeCreated",
    "lifecycleState"
  ],
  "$defs": {
    "AutotunePolicy": {
      "description": "An autotune policy automatically tunes the volume's performace based on the type of the policy.",
      "properties": {
        "autotuneType": {
          "description": "This specifies the type of autotunes supported by OCI.",
          "enum": [
            "DETACHED_VOLUME",
            "PERFORMANCE_BASED"
          ],
          "type": "string"
        }
      },
      "required": [
        "autotuneType"
      ]
    },
    "BootVolumeReplicaInfo": {
      "description": "Information about the boot volume replica in the destination availability domain.",
      "properties": {
        "availabilityDomain": {
          "description": "The availability domain of the boot volume replica.\n\nExample: `Uocm:PHX-AD-1`\n",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "bootVolumeReplicaId": {
          "description": "The boot volume replica's Oracle ID (OCID).",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "displayName": {
          "description": "A user-friendly name. Does not have to be unique, and it's changeable.\nAvoid entering confidential information.\n",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        }
      },
      "required": [
        "bootVolumeReplicaId",
        "availabilityDomain",
        "displayName"
      ]
    },
    "BootVolumeSourceDetails": {
      "properties": {
        "type": {
          "type": "string"
        }
      },
      "required": [
        "type"
      ]
    }
  }
}