Oracle Cloud Infrastructure v2.33.0, May 1 25

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

oci.Core.Volume

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

A volume and instance can be in separate compartments but must be in the same availability domain. For information about access control and compartments, see Overview of the IAM Service. For information about availability domains, see Regions and Availability Domains. To get a list of availability domains, use the ListAvailabilityDomains operation in the Identity and Access Management Service API.

You may optionally specify a display name for the volume, which is simply a friendly name or description. It does not have to be unique, and you can change it. Avoid entering confidential information.

Example Usage

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

const testVolume = new oci.core.Volume("test_volume", {
    compartmentId: compartmentId,
    autotunePolicies: [{
        autotuneType: volumeAutotunePoliciesAutotuneType,
        maxVpusPerGb: volumeAutotunePoliciesMaxVpusPerGb,
    }],
    availabilityDomain: volumeAvailabilityDomain,
    backupPolicyId: testVolumeBackupPolicies.volumeBackupPolicies[0].id,
    blockVolumeReplicas: [{
        availabilityDomain: volumeBlockVolumeReplicasAvailabilityDomain,
        displayName: volumeBlockVolumeReplicasDisplayName,
        xrrKmsKeyId: testKey.id,
    }],
    clusterPlacementGroupId: testGroup.id,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    displayName: volumeDisplayName,
    freeformTags: {
        Department: "Finance",
    },
    isAutoTuneEnabled: volumeIsAutoTuneEnabled,
    isReservationsEnabled: volumeIsReservationsEnabled,
    kmsKeyId: testKey.id,
    sizeInGbs: volumeSizeInGbs,
    sizeInMbs: volumeSizeInMbs,
    sourceDetails: {
        type: volumeSourceDetailsType,
        changeBlockSizeInBytes: volumeSourceDetailsChangeBlockSizeInBytes,
        firstBackupId: testBackup.id,
        id: volumeSourceDetailsId,
        secondBackupId: testBackup.id,
    },
    vpusPerGb: volumeVpusPerGb,
    xrcKmsKeyId: testKey.id,
    blockVolumeReplicasDeletion: true,
});

import pulumi
import pulumi_oci as oci

test_volume = oci.core.Volume("test_volume",
    compartment_id=compartment_id,
    autotune_policies=[{
        "autotune_type": volume_autotune_policies_autotune_type,
        "max_vpus_per_gb": volume_autotune_policies_max_vpus_per_gb,
    }],
    availability_domain=volume_availability_domain,
    backup_policy_id=test_volume_backup_policies["volumeBackupPolicies"][0]["id"],
    block_volume_replicas=[{
        "availability_domain": volume_block_volume_replicas_availability_domain,
        "display_name": volume_block_volume_replicas_display_name,
        "xrr_kms_key_id": test_key["id"],
    }],
    cluster_placement_group_id=test_group["id"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    display_name=volume_display_name,
    freeform_tags={
        "Department": "Finance",
    },
    is_auto_tune_enabled=volume_is_auto_tune_enabled,
    is_reservations_enabled=volume_is_reservations_enabled,
    kms_key_id=test_key["id"],
    size_in_gbs=volume_size_in_gbs,
    size_in_mbs=volume_size_in_mbs,
    source_details={
        "type": volume_source_details_type,
        "change_block_size_in_bytes": volume_source_details_change_block_size_in_bytes,
        "first_backup_id": test_backup["id"],
        "id": volume_source_details_id,
        "second_backup_id": test_backup["id"],
    },
    vpus_per_gb=volume_vpus_per_gb,
    xrc_kms_key_id=test_key["id"],
    block_volume_replicas_deletion=True)

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := core.NewVolume(ctx, "test_volume", &core.VolumeArgs{
			CompartmentId: pulumi.Any(compartmentId),
			AutotunePolicies: core.VolumeAutotunePolicyArray{
				&core.VolumeAutotunePolicyArgs{
					AutotuneType: pulumi.Any(volumeAutotunePoliciesAutotuneType),
					MaxVpusPerGb: pulumi.Any(volumeAutotunePoliciesMaxVpusPerGb),
				},
			},
			AvailabilityDomain: pulumi.Any(volumeAvailabilityDomain),
			BackupPolicyId:     pulumi.Any(testVolumeBackupPolicies.VolumeBackupPolicies[0].Id),
			BlockVolumeReplicas: core.VolumeBlockVolumeReplicaArray{
				&core.VolumeBlockVolumeReplicaArgs{
					AvailabilityDomain: pulumi.Any(volumeBlockVolumeReplicasAvailabilityDomain),
					DisplayName:        pulumi.Any(volumeBlockVolumeReplicasDisplayName),
					XrrKmsKeyId:        pulumi.Any(testKey.Id),
				},
			},
			ClusterPlacementGroupId: pulumi.Any(testGroup.Id),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			DisplayName: pulumi.Any(volumeDisplayName),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			IsAutoTuneEnabled:     pulumi.Any(volumeIsAutoTuneEnabled),
			IsReservationsEnabled: pulumi.Any(volumeIsReservationsEnabled),
			KmsKeyId:              pulumi.Any(testKey.Id),
			SizeInGbs:             pulumi.Any(volumeSizeInGbs),
			SizeInMbs:             pulumi.Any(volumeSizeInMbs),
			SourceDetails: &core.VolumeSourceDetailsArgs{
				Type:                   pulumi.Any(volumeSourceDetailsType),
				ChangeBlockSizeInBytes: pulumi.Any(volumeSourceDetailsChangeBlockSizeInBytes),
				FirstBackupId:          pulumi.Any(testBackup.Id),
				Id:                     pulumi.Any(volumeSourceDetailsId),
				SecondBackupId:         pulumi.Any(testBackup.Id),
			},
			VpusPerGb:                   pulumi.Any(volumeVpusPerGb),
			XrcKmsKeyId:                 pulumi.Any(testKey.Id),
			BlockVolumeReplicasDeletion: pulumi.Bool(true),
		})
		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 testVolume = new Oci.Core.Volume("test_volume", new()
    {
        CompartmentId = compartmentId,
        AutotunePolicies = new[]
        {
            new Oci.Core.Inputs.VolumeAutotunePolicyArgs
            {
                AutotuneType = volumeAutotunePoliciesAutotuneType,
                MaxVpusPerGb = volumeAutotunePoliciesMaxVpusPerGb,
            },
        },
        AvailabilityDomain = volumeAvailabilityDomain,
        BackupPolicyId = testVolumeBackupPolicies.VolumeBackupPolicies[0].Id,
        BlockVolumeReplicas = new[]
        {
            new Oci.Core.Inputs.VolumeBlockVolumeReplicaArgs
            {
                AvailabilityDomain = volumeBlockVolumeReplicasAvailabilityDomain,
                DisplayName = volumeBlockVolumeReplicasDisplayName,
                XrrKmsKeyId = testKey.Id,
            },
        },
        ClusterPlacementGroupId = testGroup.Id,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        DisplayName = volumeDisplayName,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        IsAutoTuneEnabled = volumeIsAutoTuneEnabled,
        IsReservationsEnabled = volumeIsReservationsEnabled,
        KmsKeyId = testKey.Id,
        SizeInGbs = volumeSizeInGbs,
        SizeInMbs = volumeSizeInMbs,
        SourceDetails = new Oci.Core.Inputs.VolumeSourceDetailsArgs
        {
            Type = volumeSourceDetailsType,
            ChangeBlockSizeInBytes = volumeSourceDetailsChangeBlockSizeInBytes,
            FirstBackupId = testBackup.Id,
            Id = volumeSourceDetailsId,
            SecondBackupId = testBackup.Id,
        },
        VpusPerGb = volumeVpusPerGb,
        XrcKmsKeyId = testKey.Id,
        BlockVolumeReplicasDeletion = true,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.Volume;
import com.pulumi.oci.Core.VolumeArgs;
import com.pulumi.oci.Core.inputs.VolumeAutotunePolicyArgs;
import com.pulumi.oci.Core.inputs.VolumeBlockVolumeReplicaArgs;
import com.pulumi.oci.Core.inputs.VolumeSourceDetailsArgs;
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 testVolume = new Volume("testVolume", VolumeArgs.builder()
            .compartmentId(compartmentId)
            .autotunePolicies(VolumeAutotunePolicyArgs.builder()
                .autotuneType(volumeAutotunePoliciesAutotuneType)
                .maxVpusPerGb(volumeAutotunePoliciesMaxVpusPerGb)
                .build())
            .availabilityDomain(volumeAvailabilityDomain)
            .backupPolicyId(testVolumeBackupPolicies.volumeBackupPolicies()[0].id())
            .blockVolumeReplicas(VolumeBlockVolumeReplicaArgs.builder()
                .availabilityDomain(volumeBlockVolumeReplicasAvailabilityDomain)
                .displayName(volumeBlockVolumeReplicasDisplayName)
                .xrrKmsKeyId(testKey.id())
                .build())
            .clusterPlacementGroupId(testGroup.id())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .displayName(volumeDisplayName)
            .freeformTags(Map.of("Department", "Finance"))
            .isAutoTuneEnabled(volumeIsAutoTuneEnabled)
            .isReservationsEnabled(volumeIsReservationsEnabled)
            .kmsKeyId(testKey.id())
            .sizeInGbs(volumeSizeInGbs)
            .sizeInMbs(volumeSizeInMbs)
            .sourceDetails(VolumeSourceDetailsArgs.builder()
                .type(volumeSourceDetailsType)
                .changeBlockSizeInBytes(volumeSourceDetailsChangeBlockSizeInBytes)
                .firstBackupId(testBackup.id())
                .id(volumeSourceDetailsId)
                .secondBackupId(testBackup.id())
                .build())
            .vpusPerGb(volumeVpusPerGb)
            .xrcKmsKeyId(testKey.id())
            .blockVolumeReplicasDeletion(true)
            .build());

    }
}

resources:
  testVolume:
    type: oci:Core:Volume
    name: test_volume
    properties:
      compartmentId: ${compartmentId}
      autotunePolicies:
        - autotuneType: ${volumeAutotunePoliciesAutotuneType}
          maxVpusPerGb: ${volumeAutotunePoliciesMaxVpusPerGb}
      availabilityDomain: ${volumeAvailabilityDomain}
      backupPolicyId: ${testVolumeBackupPolicies.volumeBackupPolicies[0].id}
      blockVolumeReplicas:
        - availabilityDomain: ${volumeBlockVolumeReplicasAvailabilityDomain}
          displayName: ${volumeBlockVolumeReplicasDisplayName}
          xrrKmsKeyId: ${testKey.id}
      clusterPlacementGroupId: ${testGroup.id}
      definedTags:
        Operations.CostCenter: '42'
      displayName: ${volumeDisplayName}
      freeformTags:
        Department: Finance
      isAutoTuneEnabled: ${volumeIsAutoTuneEnabled}
      isReservationsEnabled: ${volumeIsReservationsEnabled}
      kmsKeyId: ${testKey.id}
      sizeInGbs: ${volumeSizeInGbs}
      sizeInMbs: ${volumeSizeInMbs}
      sourceDetails:
        type: ${volumeSourceDetailsType}
        changeBlockSizeInBytes: ${volumeSourceDetailsChangeBlockSizeInBytes}
        firstBackupId: ${testBackup.id}
        id: ${volumeSourceDetailsId}
        secondBackupId: ${testBackup.id}
      vpusPerGb: ${volumeVpusPerGb}
      xrcKmsKeyId: ${testKey.id}
      blockVolumeReplicasDeletion: true

Create Volume Resource

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

Constructor syntax

new Volume(name: string, args: VolumeArgs, opts?: CustomResourceOptions);

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

@overload
def Volume(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           compartment_id: Optional[str] = None,
           availability_domain: Optional[str] = None,
           display_name: Optional[str] = None,
           is_reservations_enabled: Optional[bool] = None,
           block_volume_replicas_deletion: Optional[bool] = None,
           cluster_placement_group_id: Optional[str] = None,
           backup_policy_id: Optional[str] = None,
           defined_tags: Optional[Mapping[str, str]] = None,
           autotune_policies: Optional[Sequence[VolumeAutotunePolicyArgs]] = None,
           freeform_tags: Optional[Mapping[str, str]] = None,
           is_auto_tune_enabled: Optional[bool] = None,
           block_volume_replicas: Optional[Sequence[VolumeBlockVolumeReplicaArgs]] = None,
           kms_key_id: Optional[str] = None,
           size_in_gbs: Optional[str] = None,
           size_in_mbs: Optional[str] = None,
           source_details: Optional[VolumeSourceDetailsArgs] = None,
           volume_backup_id: Optional[str] = None,
           vpus_per_gb: Optional[str] = None,
           xrc_kms_key_id: Optional[str] = None)

func NewVolume(ctx *Context, name string, args VolumeArgs, opts ...ResourceOption) (*Volume, error)

public Volume(string name, VolumeArgs args, CustomResourceOptions? opts = null)

public Volume(String name, VolumeArgs args)
public Volume(String name, VolumeArgs args, CustomResourceOptions options)

type: oci:Core:Volume
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 VolumeArgs: 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 VolumeArgs: 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 VolumeArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args VolumeArgs: 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 volumeResource = new Oci.Core.Volume("volumeResource", new()
{
    CompartmentId = "string",
    AvailabilityDomain = "string",
    DisplayName = "string",
    IsReservationsEnabled = false,
    BlockVolumeReplicasDeletion = false,
    ClusterPlacementGroupId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    AutotunePolicies = new[]
    {
        new Oci.Core.Inputs.VolumeAutotunePolicyArgs
        {
            AutotuneType = "string",
            MaxVpusPerGb = "string",
        },
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
    IsAutoTuneEnabled = false,
    BlockVolumeReplicas = new[]
    {
        new Oci.Core.Inputs.VolumeBlockVolumeReplicaArgs
        {
            AvailabilityDomain = "string",
            BlockVolumeReplicaId = "string",
            DisplayName = "string",
            KmsKeyId = "string",
            XrrKmsKeyId = "string",
        },
    },
    KmsKeyId = "string",
    SizeInGbs = "string",
    SourceDetails = new Oci.Core.Inputs.VolumeSourceDetailsArgs
    {
        Type = "string",
        ChangeBlockSizeInBytes = "string",
        FirstBackupId = "string",
        Id = "string",
        SecondBackupId = "string",
    },
    VolumeBackupId = "string",
    VpusPerGb = "string",
    XrcKmsKeyId = "string",
});

example, err := core.NewVolume(ctx, "volumeResource", &core.VolumeArgs{
	CompartmentId:               pulumi.String("string"),
	AvailabilityDomain:          pulumi.String("string"),
	DisplayName:                 pulumi.String("string"),
	IsReservationsEnabled:       pulumi.Bool(false),
	BlockVolumeReplicasDeletion: pulumi.Bool(false),
	ClusterPlacementGroupId:     pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	AutotunePolicies: core.VolumeAutotunePolicyArray{
		&core.VolumeAutotunePolicyArgs{
			AutotuneType: pulumi.String("string"),
			MaxVpusPerGb: pulumi.String("string"),
		},
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	IsAutoTuneEnabled: pulumi.Bool(false),
	BlockVolumeReplicas: core.VolumeBlockVolumeReplicaArray{
		&core.VolumeBlockVolumeReplicaArgs{
			AvailabilityDomain:   pulumi.String("string"),
			BlockVolumeReplicaId: pulumi.String("string"),
			DisplayName:          pulumi.String("string"),
			KmsKeyId:             pulumi.String("string"),
			XrrKmsKeyId:          pulumi.String("string"),
		},
	},
	KmsKeyId:  pulumi.String("string"),
	SizeInGbs: pulumi.String("string"),
	SourceDetails: &core.VolumeSourceDetailsArgs{
		Type:                   pulumi.String("string"),
		ChangeBlockSizeInBytes: pulumi.String("string"),
		FirstBackupId:          pulumi.String("string"),
		Id:                     pulumi.String("string"),
		SecondBackupId:         pulumi.String("string"),
	},
	VolumeBackupId: pulumi.String("string"),
	VpusPerGb:      pulumi.String("string"),
	XrcKmsKeyId:    pulumi.String("string"),
})

var volumeResource = new Volume("volumeResource", VolumeArgs.builder()
    .compartmentId("string")
    .availabilityDomain("string")
    .displayName("string")
    .isReservationsEnabled(false)
    .blockVolumeReplicasDeletion(false)
    .clusterPlacementGroupId("string")
    .definedTags(Map.of("string", "string"))
    .autotunePolicies(VolumeAutotunePolicyArgs.builder()
        .autotuneType("string")
        .maxVpusPerGb("string")
        .build())
    .freeformTags(Map.of("string", "string"))
    .isAutoTuneEnabled(false)
    .blockVolumeReplicas(VolumeBlockVolumeReplicaArgs.builder()
        .availabilityDomain("string")
        .blockVolumeReplicaId("string")
        .displayName("string")
        .kmsKeyId("string")
        .xrrKmsKeyId("string")
        .build())
    .kmsKeyId("string")
    .sizeInGbs("string")
    .sourceDetails(VolumeSourceDetailsArgs.builder()
        .type("string")
        .changeBlockSizeInBytes("string")
        .firstBackupId("string")
        .id("string")
        .secondBackupId("string")
        .build())
    .volumeBackupId("string")
    .vpusPerGb("string")
    .xrcKmsKeyId("string")
    .build());

volume_resource = oci.core.Volume("volumeResource",
    compartment_id="string",
    availability_domain="string",
    display_name="string",
    is_reservations_enabled=False,
    block_volume_replicas_deletion=False,
    cluster_placement_group_id="string",
    defined_tags={
        "string": "string",
    },
    autotune_policies=[{
        "autotune_type": "string",
        "max_vpus_per_gb": "string",
    }],
    freeform_tags={
        "string": "string",
    },
    is_auto_tune_enabled=False,
    block_volume_replicas=[{
        "availability_domain": "string",
        "block_volume_replica_id": "string",
        "display_name": "string",
        "kms_key_id": "string",
        "xrr_kms_key_id": "string",
    }],
    kms_key_id="string",
    size_in_gbs="string",
    source_details={
        "type": "string",
        "change_block_size_in_bytes": "string",
        "first_backup_id": "string",
        "id": "string",
        "second_backup_id": "string",
    },
    volume_backup_id="string",
    vpus_per_gb="string",
    xrc_kms_key_id="string")

const volumeResource = new oci.core.Volume("volumeResource", {
    compartmentId: "string",
    availabilityDomain: "string",
    displayName: "string",
    isReservationsEnabled: false,
    blockVolumeReplicasDeletion: false,
    clusterPlacementGroupId: "string",
    definedTags: {
        string: "string",
    },
    autotunePolicies: [{
        autotuneType: "string",
        maxVpusPerGb: "string",
    }],
    freeformTags: {
        string: "string",
    },
    isAutoTuneEnabled: false,
    blockVolumeReplicas: [{
        availabilityDomain: "string",
        blockVolumeReplicaId: "string",
        displayName: "string",
        kmsKeyId: "string",
        xrrKmsKeyId: "string",
    }],
    kmsKeyId: "string",
    sizeInGbs: "string",
    sourceDetails: {
        type: "string",
        changeBlockSizeInBytes: "string",
        firstBackupId: "string",
        id: "string",
        secondBackupId: "string",
    },
    volumeBackupId: "string",
    vpusPerGb: "string",
    xrcKmsKeyId: "string",
});

type: oci:Core:Volume
properties:
    autotunePolicies:
        - autotuneType: string
          maxVpusPerGb: string
    availabilityDomain: string
    blockVolumeReplicas:
        - availabilityDomain: string
          blockVolumeReplicaId: string
          displayName: string
          kmsKeyId: string
          xrrKmsKeyId: string
    blockVolumeReplicasDeletion: false
    clusterPlacementGroupId: string
    compartmentId: string
    definedTags:
        string: string
    displayName: string
    freeformTags:
        string: string
    isAutoTuneEnabled: false
    isReservationsEnabled: false
    kmsKeyId: string
    sizeInGbs: string
    sourceDetails:
        changeBlockSizeInBytes: string
        firstBackupId: string
        id: string
        secondBackupId: string
        type: string
    volumeBackupId: string
    vpusPerGb: string
    xrcKmsKeyId: string

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

AvailabilityDomain string

The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example: Uocm:PHX-AD-1

CompartmentId string

(Updatable) The OCID of the compartment that contains the volume.

AutotunePolicies List<VolumeAutotunePolicy>

(Updatable) The list of autotune policies to be enabled for this volume.

BackupPolicyId string

If provided, specifies the ID of the volume backup policy to assign to the newly created volume. If omitted, no policy will be assigned. This field is deprecated. Use the oci.Core.getVolumeBackupPolicyAssignments instead to assign a backup policy to a volume.

Deprecated: The 'backup_policy_id' field has been deprecated. Please use the 'oci_core_volume_backup_policy_assignment' resource instead.

BlockVolumeReplicas List<VolumeBlockVolumeReplica>

(Updatable) The list of block volume replicas to be enabled for this volume in the specified destination availability domains.

BlockVolumeReplicasDeletion bool

ClusterPlacementGroupId string

The clusterPlacementGroup Id of the volume for volume placement.

DefinedTags Dictionary<string, string>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

FreeformTags Dictionary<string, string>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

IsAutoTuneEnabled bool

(Updatable) Specifies whether the auto-tune performance is enabled for this volume. This field is deprecated. Use the DetachedVolumeAutotunePolicy instead to enable the volume for detached autotune.

IsReservationsEnabled bool

(Updatable) Reservations-enabled is a boolean field that allows to enable PR (Persistent Reservation) on a volume.

KmsKeyId string

(Updatable) The OCID of the Vault service key to assign as the master encryption key for the volume.

SizeInGbs string

(Updatable) The size of the volume in GBs.

SizeInMbs string

The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Use sizeInGBs instead.

Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.

SourceDetails VolumeSourceDetails

Specifies the volume source details for a new Block volume. The volume source is either another Block volume in the same Availability Domain or a Block volume backup. This is an optional field. If not specified or set to null, the new Block volume will be empty. When specified, the new Block volume will contain data from the source volume or backup.

VolumeBackupId string

The OCID of the volume backup from which the data should be restored on the newly created volume. This field is deprecated. Use the sourceDetails field instead to specify the backup for the volume.

VpusPerGb string

(Updatable) The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.

Allowed values:

XrcKmsKeyId string

The OCID of the Vault service key which is the master encryption key for the block volume cross region backups, which will be used in the destination region to encrypt the backup's encryption keys. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.

** 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

AvailabilityDomain string

The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example: Uocm:PHX-AD-1

CompartmentId string

(Updatable) The OCID of the compartment that contains the volume.

AutotunePolicies []VolumeAutotunePolicyArgs

(Updatable) The list of autotune policies to be enabled for this volume.

BackupPolicyId string

Deprecated: The 'backup_policy_id' field has been deprecated. Please use the 'oci_core_volume_backup_policy_assignment' resource instead.

BlockVolumeReplicas []VolumeBlockVolumeReplicaArgs

(Updatable) The list of block volume replicas to be enabled for this volume in the specified destination availability domains.

BlockVolumeReplicasDeletion bool

ClusterPlacementGroupId string

The clusterPlacementGroup Id of the volume for volume placement.

DefinedTags map[string]string

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

FreeformTags map[string]string

IsAutoTuneEnabled bool

IsReservationsEnabled bool

(Updatable) Reservations-enabled is a boolean field that allows to enable PR (Persistent Reservation) on a volume.

KmsKeyId string

(Updatable) The OCID of the Vault service key to assign as the master encryption key for the volume.

SizeInGbs string

(Updatable) The size of the volume in GBs.

SizeInMbs string

The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Use sizeInGBs instead.

Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.

SourceDetails VolumeSourceDetailsArgs

VolumeBackupId string

The OCID of the volume backup from which the data should be restored on the newly created volume. This field is deprecated. Use the sourceDetails field instead to specify the backup for the volume.

VpusPerGb string

Allowed values:

XrcKmsKeyId string

** 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

availabilityDomain String

The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example: Uocm:PHX-AD-1

compartmentId String

(Updatable) The OCID of the compartment that contains the volume.

autotunePolicies List<VolumeAutotunePolicy>

(Updatable) The list of autotune policies to be enabled for this volume.

backupPolicyId String

Deprecated: The 'backup_policy_id' field has been deprecated. Please use the 'oci_core_volume_backup_policy_assignment' resource instead.

blockVolumeReplicas List<VolumeBlockVolumeReplica>

(Updatable) The list of block volume replicas to be enabled for this volume in the specified destination availability domains.

blockVolumeReplicasDeletion Boolean

clusterPlacementGroupId String

The clusterPlacementGroup Id of the volume for volume placement.

definedTags Map<String,String>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeformTags Map<String,String>

isAutoTuneEnabled Boolean

isReservationsEnabled Boolean

(Updatable) Reservations-enabled is a boolean field that allows to enable PR (Persistent Reservation) on a volume.

kmsKeyId String

(Updatable) The OCID of the Vault service key to assign as the master encryption key for the volume.

sizeInGbs String

(Updatable) The size of the volume in GBs.

sizeInMbs String

The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Use sizeInGBs instead.

Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.

sourceDetails VolumeSourceDetails

volumeBackupId String

The OCID of the volume backup from which the data should be restored on the newly created volume. This field is deprecated. Use the sourceDetails field instead to specify the backup for the volume.

vpusPerGb String

Allowed values:

xrcKmsKeyId String

** 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

availabilityDomain string

The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example: Uocm:PHX-AD-1

compartmentId string

(Updatable) The OCID of the compartment that contains the volume.

autotunePolicies VolumeAutotunePolicy[]

(Updatable) The list of autotune policies to be enabled for this volume.

backupPolicyId string

Deprecated: The 'backup_policy_id' field has been deprecated. Please use the 'oci_core_volume_backup_policy_assignment' resource instead.

blockVolumeReplicas VolumeBlockVolumeReplica[]

(Updatable) The list of block volume replicas to be enabled for this volume in the specified destination availability domains.

blockVolumeReplicasDeletion boolean

clusterPlacementGroupId string

The clusterPlacementGroup Id of the volume for volume placement.

definedTags {[key: string]: string}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeformTags {[key: string]: string}

isAutoTuneEnabled boolean

isReservationsEnabled boolean

(Updatable) Reservations-enabled is a boolean field that allows to enable PR (Persistent Reservation) on a volume.

kmsKeyId string

(Updatable) The OCID of the Vault service key to assign as the master encryption key for the volume.

sizeInGbs string

(Updatable) The size of the volume in GBs.

sizeInMbs string

The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Use sizeInGBs instead.

Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.

sourceDetails VolumeSourceDetails

volumeBackupId string

The OCID of the volume backup from which the data should be restored on the newly created volume. This field is deprecated. Use the sourceDetails field instead to specify the backup for the volume.

vpusPerGb string

Allowed values:

xrcKmsKeyId string

** 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

availability_domain str

The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example: Uocm:PHX-AD-1

compartment_id str

(Updatable) The OCID of the compartment that contains the volume.

autotune_policies Sequence[VolumeAutotunePolicyArgs]

(Updatable) The list of autotune policies to be enabled for this volume.

backup_policy_id str

Deprecated: The 'backup_policy_id' field has been deprecated. Please use the 'oci_core_volume_backup_policy_assignment' resource instead.

block_volume_replicas Sequence[VolumeBlockVolumeReplicaArgs]

(Updatable) The list of block volume replicas to be enabled for this volume in the specified destination availability domains.

block_volume_replicas_deletion bool

cluster_placement_group_id str

The clusterPlacementGroup Id of the volume for volume placement.

defined_tags Mapping[str, str]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

display_name str

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeform_tags Mapping[str, str]

is_auto_tune_enabled bool

is_reservations_enabled bool

(Updatable) Reservations-enabled is a boolean field that allows to enable PR (Persistent Reservation) on a volume.

kms_key_id str

(Updatable) The OCID of the Vault service key to assign as the master encryption key for the volume.

size_in_gbs str

(Updatable) The size of the volume in GBs.

size_in_mbs str

The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Use sizeInGBs instead.

Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.

source_details VolumeSourceDetailsArgs

volume_backup_id str

The OCID of the volume backup from which the data should be restored on the newly created volume. This field is deprecated. Use the sourceDetails field instead to specify the backup for the volume.

vpus_per_gb str

Allowed values:

xrc_kms_key_id str

** 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

availabilityDomain String

The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example: Uocm:PHX-AD-1

compartmentId String

(Updatable) The OCID of the compartment that contains the volume.

autotunePolicies List<Property Map>

(Updatable) The list of autotune policies to be enabled for this volume.

backupPolicyId String

Deprecated: The 'backup_policy_id' field has been deprecated. Please use the 'oci_core_volume_backup_policy_assignment' resource instead.

blockVolumeReplicas List<Property Map>

(Updatable) The list of block volume replicas to be enabled for this volume in the specified destination availability domains.

blockVolumeReplicasDeletion Boolean

clusterPlacementGroupId String

The clusterPlacementGroup Id of the volume for volume placement.

definedTags Map<String>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeformTags Map<String>

isAutoTuneEnabled Boolean

isReservationsEnabled Boolean

(Updatable) Reservations-enabled is a boolean field that allows to enable PR (Persistent Reservation) on a volume.

kmsKeyId String

(Updatable) The OCID of the Vault service key to assign as the master encryption key for the volume.

sizeInGbs String

(Updatable) The size of the volume in GBs.

sizeInMbs String

The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Use sizeInGBs instead.

Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.

sourceDetails Property Map

volumeBackupId String

The OCID of the volume backup from which the data should be restored on the newly created volume. This field is deprecated. Use the sourceDetails field instead to specify the backup for the volume.

vpusPerGb String

Allowed values:

xrcKmsKeyId String

** 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

Outputs

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

AutoTunedVpusPerGb string: The number of Volume Performance Units per GB that this volume is effectively tuned to.
Id string: The provider-assigned unique ID for this managed resource.
IsHydrated bool: Specifies whether the cloned volume's data has finished copying from the source volume or backup.
State string: The current state of a volume.
SystemTags Dictionary<string, string>: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
TimeCreated string: The date and time the volume was created. Format defined by RFC3339.
VolumeGroupId string: The OCID of the source volume group.

AutoTunedVpusPerGb string: The number of Volume Performance Units per GB that this volume is effectively tuned to.
Id string: The provider-assigned unique ID for this managed resource.
IsHydrated bool: Specifies whether the cloned volume's data has finished copying from the source volume or backup.
State string: The current state of a volume.
SystemTags map[string]string: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
TimeCreated string: The date and time the volume was created. Format defined by RFC3339.
VolumeGroupId string: The OCID of the source volume group.

autoTunedVpusPerGb String: The number of Volume Performance Units per GB that this volume is effectively tuned to.
id String: The provider-assigned unique ID for this managed resource.
isHydrated Boolean: Specifies whether the cloned volume's data has finished copying from the source volume or backup.
state String: The current state of a volume.
systemTags Map<String,String>: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
timeCreated String: The date and time the volume was created. Format defined by RFC3339.
volumeGroupId String: The OCID of the source volume group.

autoTunedVpusPerGb string: The number of Volume Performance Units per GB that this volume is effectively tuned to.
id string: The provider-assigned unique ID for this managed resource.
isHydrated boolean: Specifies whether the cloned volume's data has finished copying from the source volume or backup.
state string: The current state of a volume.
systemTags {[key: string]: string}: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
timeCreated string: The date and time the volume was created. Format defined by RFC3339.
volumeGroupId string: The OCID of the source volume group.

auto_tuned_vpus_per_gb str: The number of Volume Performance Units per GB that this volume is effectively tuned to.
id str: The provider-assigned unique ID for this managed resource.
is_hydrated bool: Specifies whether the cloned volume's data has finished copying from the source volume or backup.
state str: The current state of a volume.
system_tags Mapping[str, str]: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
time_created str: The date and time the volume was created. Format defined by RFC3339.
volume_group_id str: The OCID of the source volume group.

autoTunedVpusPerGb String: The number of Volume Performance Units per GB that this volume is effectively tuned to.
id String: The provider-assigned unique ID for this managed resource.
isHydrated Boolean: Specifies whether the cloned volume's data has finished copying from the source volume or backup.
state String: The current state of a volume.
systemTags Map<String>: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
timeCreated String: The date and time the volume was created. Format defined by RFC3339.
volumeGroupId String: The OCID of the source volume group.

Look up Existing Volume Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_tuned_vpus_per_gb: Optional[str] = None,
        autotune_policies: Optional[Sequence[VolumeAutotunePolicyArgs]] = None,
        availability_domain: Optional[str] = None,
        backup_policy_id: Optional[str] = None,
        block_volume_replicas: Optional[Sequence[VolumeBlockVolumeReplicaArgs]] = None,
        block_volume_replicas_deletion: Optional[bool] = None,
        cluster_placement_group_id: Optional[str] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        is_auto_tune_enabled: Optional[bool] = None,
        is_hydrated: Optional[bool] = None,
        is_reservations_enabled: Optional[bool] = None,
        kms_key_id: Optional[str] = None,
        size_in_gbs: Optional[str] = None,
        size_in_mbs: Optional[str] = None,
        source_details: Optional[VolumeSourceDetailsArgs] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        volume_backup_id: Optional[str] = None,
        volume_group_id: Optional[str] = None,
        vpus_per_gb: Optional[str] = None,
        xrc_kms_key_id: Optional[str] = None) -> Volume

func GetVolume(ctx *Context, name string, id IDInput, state *VolumeState, opts ...ResourceOption) (*Volume, error)

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

public static Volume get(String name, Output<String> id, VolumeState state, CustomResourceOptions options)

resources:  _:    type: oci:Core:Volume    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:

AutoTunedVpusPerGb string

The number of Volume Performance Units per GB that this volume is effectively tuned to.

AutotunePolicies List<VolumeAutotunePolicy>

(Updatable) The list of autotune policies to be enabled for this volume.

AvailabilityDomain string

The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example: Uocm:PHX-AD-1

BackupPolicyId string

Deprecated: The 'backup_policy_id' field has been deprecated. Please use the 'oci_core_volume_backup_policy_assignment' resource instead.

BlockVolumeReplicas List<VolumeBlockVolumeReplica>

(Updatable) The list of block volume replicas to be enabled for this volume in the specified destination availability domains.

BlockVolumeReplicasDeletion bool

ClusterPlacementGroupId string

The clusterPlacementGroup Id of the volume for volume placement.

CompartmentId string

(Updatable) The OCID of the compartment that contains the volume.

DefinedTags Dictionary<string, string>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

FreeformTags Dictionary<string, string>

IsAutoTuneEnabled bool

IsHydrated bool

Specifies whether the cloned volume's data has finished copying from the source volume or backup.

IsReservationsEnabled bool

(Updatable) Reservations-enabled is a boolean field that allows to enable PR (Persistent Reservation) on a volume.

KmsKeyId string

(Updatable) The OCID of the Vault service key to assign as the master encryption key for the volume.

SizeInGbs string

(Updatable) The size of the volume in GBs.

SizeInMbs string

The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Use sizeInGBs instead.

Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.

SourceDetails VolumeSourceDetails

State string

The current state of a volume.

SystemTags Dictionary<string, string>

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

TimeCreated string

The date and time the volume was created. Format defined by RFC3339.

VolumeBackupId string

The OCID of the volume backup from which the data should be restored on the newly created volume. This field is deprecated. Use the sourceDetails field instead to specify the backup for the volume.

VolumeGroupId string

The OCID of the source volume group.

VpusPerGb string

Allowed values:

XrcKmsKeyId string

** 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

AutoTunedVpusPerGb string

The number of Volume Performance Units per GB that this volume is effectively tuned to.

AutotunePolicies []VolumeAutotunePolicyArgs

(Updatable) The list of autotune policies to be enabled for this volume.

AvailabilityDomain string

The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example: Uocm:PHX-AD-1

BackupPolicyId string

Deprecated: The 'backup_policy_id' field has been deprecated. Please use the 'oci_core_volume_backup_policy_assignment' resource instead.

BlockVolumeReplicas []VolumeBlockVolumeReplicaArgs

(Updatable) The list of block volume replicas to be enabled for this volume in the specified destination availability domains.

BlockVolumeReplicasDeletion bool

ClusterPlacementGroupId string

The clusterPlacementGroup Id of the volume for volume placement.

CompartmentId string

(Updatable) The OCID of the compartment that contains the volume.

DefinedTags map[string]string

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

FreeformTags map[string]string

IsAutoTuneEnabled bool

IsHydrated bool

Specifies whether the cloned volume's data has finished copying from the source volume or backup.

IsReservationsEnabled bool

(Updatable) Reservations-enabled is a boolean field that allows to enable PR (Persistent Reservation) on a volume.

KmsKeyId string

(Updatable) The OCID of the Vault service key to assign as the master encryption key for the volume.

SizeInGbs string

(Updatable) The size of the volume in GBs.

SizeInMbs string

The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Use sizeInGBs instead.

Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.

SourceDetails VolumeSourceDetailsArgs

State string

The current state of a volume.

SystemTags map[string]string

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

TimeCreated string

The date and time the volume was created. Format defined by RFC3339.

VolumeBackupId string

The OCID of the volume backup from which the data should be restored on the newly created volume. This field is deprecated. Use the sourceDetails field instead to specify the backup for the volume.

VolumeGroupId string

The OCID of the source volume group.

VpusPerGb string

Allowed values:

XrcKmsKeyId string

** 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

autoTunedVpusPerGb String

The number of Volume Performance Units per GB that this volume is effectively tuned to.

autotunePolicies List<VolumeAutotunePolicy>

(Updatable) The list of autotune policies to be enabled for this volume.

availabilityDomain String

The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example: Uocm:PHX-AD-1

backupPolicyId String

Deprecated: The 'backup_policy_id' field has been deprecated. Please use the 'oci_core_volume_backup_policy_assignment' resource instead.

blockVolumeReplicas List<VolumeBlockVolumeReplica>

(Updatable) The list of block volume replicas to be enabled for this volume in the specified destination availability domains.

blockVolumeReplicasDeletion Boolean

clusterPlacementGroupId String

The clusterPlacementGroup Id of the volume for volume placement.

compartmentId String

(Updatable) The OCID of the compartment that contains the volume.

definedTags Map<String,String>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeformTags Map<String,String>

isAutoTuneEnabled Boolean

isHydrated Boolean

Specifies whether the cloned volume's data has finished copying from the source volume or backup.

isReservationsEnabled Boolean

(Updatable) Reservations-enabled is a boolean field that allows to enable PR (Persistent Reservation) on a volume.

kmsKeyId String

(Updatable) The OCID of the Vault service key to assign as the master encryption key for the volume.

sizeInGbs String

(Updatable) The size of the volume in GBs.

sizeInMbs String

The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Use sizeInGBs instead.

Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.

sourceDetails VolumeSourceDetails

state String

The current state of a volume.

systemTags Map<String,String>

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

timeCreated String

The date and time the volume was created. Format defined by RFC3339.

volumeBackupId String

The OCID of the volume backup from which the data should be restored on the newly created volume. This field is deprecated. Use the sourceDetails field instead to specify the backup for the volume.

volumeGroupId String

The OCID of the source volume group.

vpusPerGb String

Allowed values:

xrcKmsKeyId String

** 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

autoTunedVpusPerGb string

The number of Volume Performance Units per GB that this volume is effectively tuned to.

autotunePolicies VolumeAutotunePolicy[]

(Updatable) The list of autotune policies to be enabled for this volume.

availabilityDomain string

The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example: Uocm:PHX-AD-1

backupPolicyId string

Deprecated: The 'backup_policy_id' field has been deprecated. Please use the 'oci_core_volume_backup_policy_assignment' resource instead.

blockVolumeReplicas VolumeBlockVolumeReplica[]

(Updatable) The list of block volume replicas to be enabled for this volume in the specified destination availability domains.

blockVolumeReplicasDeletion boolean

clusterPlacementGroupId string

The clusterPlacementGroup Id of the volume for volume placement.

compartmentId string

(Updatable) The OCID of the compartment that contains the volume.

definedTags {[key: string]: string}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeformTags {[key: string]: string}

isAutoTuneEnabled boolean

isHydrated boolean

Specifies whether the cloned volume's data has finished copying from the source volume or backup.

isReservationsEnabled boolean

(Updatable) Reservations-enabled is a boolean field that allows to enable PR (Persistent Reservation) on a volume.

kmsKeyId string

(Updatable) The OCID of the Vault service key to assign as the master encryption key for the volume.

sizeInGbs string

(Updatable) The size of the volume in GBs.

sizeInMbs string

The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Use sizeInGBs instead.

Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.

sourceDetails VolumeSourceDetails

state string

The current state of a volume.

systemTags {[key: string]: string}

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

timeCreated string

The date and time the volume was created. Format defined by RFC3339.

volumeBackupId string

The OCID of the volume backup from which the data should be restored on the newly created volume. This field is deprecated. Use the sourceDetails field instead to specify the backup for the volume.

volumeGroupId string

The OCID of the source volume group.

vpusPerGb string

Allowed values:

xrcKmsKeyId string

** 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

auto_tuned_vpus_per_gb str

The number of Volume Performance Units per GB that this volume is effectively tuned to.

autotune_policies Sequence[VolumeAutotunePolicyArgs]

(Updatable) The list of autotune policies to be enabled for this volume.

availability_domain str

The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example: Uocm:PHX-AD-1

backup_policy_id str

Deprecated: The 'backup_policy_id' field has been deprecated. Please use the 'oci_core_volume_backup_policy_assignment' resource instead.

block_volume_replicas Sequence[VolumeBlockVolumeReplicaArgs]

(Updatable) The list of block volume replicas to be enabled for this volume in the specified destination availability domains.

block_volume_replicas_deletion bool

cluster_placement_group_id str

The clusterPlacementGroup Id of the volume for volume placement.

compartment_id str

(Updatable) The OCID of the compartment that contains the volume.

defined_tags Mapping[str, str]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

display_name str

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeform_tags Mapping[str, str]

is_auto_tune_enabled bool

is_hydrated bool

Specifies whether the cloned volume's data has finished copying from the source volume or backup.

is_reservations_enabled bool

(Updatable) Reservations-enabled is a boolean field that allows to enable PR (Persistent Reservation) on a volume.

kms_key_id str

(Updatable) The OCID of the Vault service key to assign as the master encryption key for the volume.

size_in_gbs str

(Updatable) The size of the volume in GBs.

size_in_mbs str

The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Use sizeInGBs instead.

Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.

source_details VolumeSourceDetailsArgs

state str

The current state of a volume.

system_tags Mapping[str, str]

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

time_created str

The date and time the volume was created. Format defined by RFC3339.

volume_backup_id str

The OCID of the volume backup from which the data should be restored on the newly created volume. This field is deprecated. Use the sourceDetails field instead to specify the backup for the volume.

volume_group_id str

The OCID of the source volume group.

vpus_per_gb str

Allowed values:

xrc_kms_key_id str

** 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

autoTunedVpusPerGb String

The number of Volume Performance Units per GB that this volume is effectively tuned to.

autotunePolicies List<Property Map>

(Updatable) The list of autotune policies to be enabled for this volume.

availabilityDomain String

The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example: Uocm:PHX-AD-1

backupPolicyId String

Deprecated: The 'backup_policy_id' field has been deprecated. Please use the 'oci_core_volume_backup_policy_assignment' resource instead.

blockVolumeReplicas List<Property Map>

(Updatable) The list of block volume replicas to be enabled for this volume in the specified destination availability domains.

blockVolumeReplicasDeletion Boolean

clusterPlacementGroupId String

The clusterPlacementGroup Id of the volume for volume placement.

compartmentId String

(Updatable) The OCID of the compartment that contains the volume.

definedTags Map<String>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeformTags Map<String>

isAutoTuneEnabled Boolean

isHydrated Boolean

Specifies whether the cloned volume's data has finished copying from the source volume or backup.

isReservationsEnabled Boolean

(Updatable) Reservations-enabled is a boolean field that allows to enable PR (Persistent Reservation) on a volume.

kmsKeyId String

(Updatable) The OCID of the Vault service key to assign as the master encryption key for the volume.

sizeInGbs String

(Updatable) The size of the volume in GBs.

sizeInMbs String

The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Use sizeInGBs instead.

Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.

sourceDetails Property Map

state String

The current state of a volume.

systemTags Map<String>

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

timeCreated String

The date and time the volume was created. Format defined by RFC3339.

volumeBackupId String

The OCID of the volume backup from which the data should be restored on the newly created volume. This field is deprecated. Use the sourceDetails field instead to specify the backup for the volume.

volumeGroupId String

The OCID of the source volume group.

vpusPerGb String

Allowed values:

xrcKmsKeyId String

** 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

VolumeAutotunePolicy, VolumeAutotunePolicyArgs

AutotuneType string: (Updatable) This specifies the type of autotunes supported by OCI.
MaxVpusPerGb string: (Updatable) This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring.

AutotuneType string: (Updatable) This specifies the type of autotunes supported by OCI.
MaxVpusPerGb string: (Updatable) This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring.

autotuneType String: (Updatable) This specifies the type of autotunes supported by OCI.
maxVpusPerGb String: (Updatable) This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring.

autotuneType string: (Updatable) This specifies the type of autotunes supported by OCI.
maxVpusPerGb string: (Updatable) This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring.

autotune_type str: (Updatable) This specifies the type of autotunes supported by OCI.
max_vpus_per_gb str: (Updatable) This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring.

autotuneType String: (Updatable) This specifies the type of autotunes supported by OCI.
maxVpusPerGb String: (Updatable) This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring.

VolumeBlockVolumeReplica, VolumeBlockVolumeReplicaArgs

AvailabilityDomain string: (Updatable) The availability domain of the block volume replica. Example: Uocm:PHX-AD-1
BlockVolumeReplicaId string: The block volume replica's Oracle ID (OCID).
DisplayName string: (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
KmsKeyId string: (Updatable) The OCID of the Vault service key to assign as the master encryption key for the volume.
XrrKmsKeyId string: (Updatable) The OCID of the Vault service key which is the master encryption key for the cross region block volume replicas, which will be used in the destination region to encrypt the block volume replica's encryption keys. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.

AvailabilityDomain string: (Updatable) The availability domain of the block volume replica. Example: Uocm:PHX-AD-1
BlockVolumeReplicaId string: The block volume replica's Oracle ID (OCID).
DisplayName string: (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
KmsKeyId string: (Updatable) The OCID of the Vault service key to assign as the master encryption key for the volume.
XrrKmsKeyId string: (Updatable) The OCID of the Vault service key which is the master encryption key for the cross region block volume replicas, which will be used in the destination region to encrypt the block volume replica's encryption keys. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.

availabilityDomain String: (Updatable) The availability domain of the block volume replica. Example: Uocm:PHX-AD-1
blockVolumeReplicaId String: The block volume replica's Oracle ID (OCID).
displayName String: (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
kmsKeyId String: (Updatable) The OCID of the Vault service key to assign as the master encryption key for the volume.
xrrKmsKeyId String: (Updatable) The OCID of the Vault service key which is the master encryption key for the cross region block volume replicas, which will be used in the destination region to encrypt the block volume replica's encryption keys. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.

availabilityDomain string: (Updatable) The availability domain of the block volume replica. Example: Uocm:PHX-AD-1
blockVolumeReplicaId string: The block volume replica's Oracle ID (OCID).
displayName string: (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
kmsKeyId string: (Updatable) The OCID of the Vault service key to assign as the master encryption key for the volume.
xrrKmsKeyId string: (Updatable) The OCID of the Vault service key which is the master encryption key for the cross region block volume replicas, which will be used in the destination region to encrypt the block volume replica's encryption keys. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.

availability_domain str: (Updatable) The availability domain of the block volume replica. Example: Uocm:PHX-AD-1
block_volume_replica_id str: The block volume replica's Oracle ID (OCID).
display_name str: (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
kms_key_id str: (Updatable) The OCID of the Vault service key to assign as the master encryption key for the volume.
xrr_kms_key_id str: (Updatable) The OCID of the Vault service key which is the master encryption key for the cross region block volume replicas, which will be used in the destination region to encrypt the block volume replica's encryption keys. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.

availabilityDomain String: (Updatable) The availability domain of the block volume replica. Example: Uocm:PHX-AD-1
blockVolumeReplicaId String: The block volume replica's Oracle ID (OCID).
displayName String: (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
kmsKeyId String: (Updatable) The OCID of the Vault service key to assign as the master encryption key for the volume.
xrrKmsKeyId String: (Updatable) The OCID of the Vault service key which is the master encryption key for the cross region block volume replicas, which will be used in the destination region to encrypt the block volume replica's encryption keys. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.

VolumeSourceDetails, VolumeSourceDetailsArgs

Type string: The type can be one of these values: blockVolumeReplica, volume, volumeBackup, volumeBackupDelta
ChangeBlockSizeInBytes string: Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).
FirstBackupId string: The OCID of the first volume backup.
Id string: The OCID of the block volume replica.
SecondBackupId string: The OCID of the second volume backup.

Type string: The type can be one of these values: blockVolumeReplica, volume, volumeBackup, volumeBackupDelta
ChangeBlockSizeInBytes string: Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).
FirstBackupId string: The OCID of the first volume backup.
Id string: The OCID of the block volume replica.
SecondBackupId string: The OCID of the second volume backup.

type String: The type can be one of these values: blockVolumeReplica, volume, volumeBackup, volumeBackupDelta
changeBlockSizeInBytes String: Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).
firstBackupId String: The OCID of the first volume backup.
id String: The OCID of the block volume replica.
secondBackupId String: The OCID of the second volume backup.

type string: The type can be one of these values: blockVolumeReplica, volume, volumeBackup, volumeBackupDelta
changeBlockSizeInBytes string: Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).
firstBackupId string: The OCID of the first volume backup.
id string: The OCID of the block volume replica.
secondBackupId string: The OCID of the second volume backup.

type str: The type can be one of these values: blockVolumeReplica, volume, volumeBackup, volumeBackupDelta
change_block_size_in_bytes str: Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).
first_backup_id str: The OCID of the first volume backup.
id str: The OCID of the block volume replica.
second_backup_id str: The OCID of the second volume backup.

type String: The type can be one of these values: blockVolumeReplica, volume, volumeBackup, volumeBackupDelta
changeBlockSizeInBytes String: Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).
firstBackupId String: The OCID of the first volume backup.
id String: The OCID of the block volume replica.
secondBackupId String: The OCID of the second volume backup.

Import

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

$ pulumi import oci:Core/volume:Volume test_volume "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.

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

pulumi/pulumi-oci

oci.Core.Volume

On this page

On this page

Example Usage

Create Volume Resource

Constructor syntax

Parameters

Constructor example

Volume Resource Properties

Inputs

Outputs

Look up Existing Volume Resource

Supporting Types

VolumeAutotunePolicy, VolumeAutotunePolicyArgs

VolumeBlockVolumeReplica, VolumeBlockVolumeReplicaArgs

VolumeSourceDetails, VolumeSourceDetailsArgs

Import

Package Details

On this page

On this page