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.getVolume

Explore with Pulumi AI

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

Example Usage

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

const testVolume = oci.Core.getVolume({
    volumeId: testVolumeOciCoreVolume.id,
});

import pulumi
import pulumi_oci as oci

test_volume = oci.Core.get_volume(volume_id=test_volume_oci_core_volume["id"])

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.GetVolume(ctx, &core.GetVolumeArgs{
			VolumeId: testVolumeOciCoreVolume.Id,
		}, nil)
		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 = Oci.Core.GetVolume.Invoke(new()
    {
        VolumeId = testVolumeOciCoreVolume.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.CoreFunctions;
import com.pulumi.oci.Core.inputs.GetVolumeArgs;
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) {
        final var testVolume = CoreFunctions.getVolume(GetVolumeArgs.builder()
            .volumeId(testVolumeOciCoreVolume.id())
            .build());

    }
}

variables:
  testVolume:
    fn::invoke:
      function: oci:Core:getVolume
      arguments:
        volumeId: ${testVolumeOciCoreVolume.id}

Using getVolume

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getVolume(args: GetVolumeArgs, opts?: InvokeOptions): Promise<GetVolumeResult>
function getVolumeOutput(args: GetVolumeOutputArgs, opts?: InvokeOptions): Output<GetVolumeResult>

def get_volume(volume_id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetVolumeResult
def get_volume_output(volume_id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetVolumeResult]

func LookupVolume(ctx *Context, args *LookupVolumeArgs, opts ...InvokeOption) (*LookupVolumeResult, error)
func LookupVolumeOutput(ctx *Context, args *LookupVolumeOutputArgs, opts ...InvokeOption) LookupVolumeResultOutput

> Note: This function is named LookupVolume in the Go SDK.

public static class GetVolume 
{
    public static Task<GetVolumeResult> InvokeAsync(GetVolumeArgs args, InvokeOptions? opts = null)
    public static Output<GetVolumeResult> Invoke(GetVolumeInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOptions options)
public static Output<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOptions options)

fn::invoke:
  function: oci:Core/getVolume:getVolume
  arguments:
    # arguments dictionary

The following arguments are supported:

VolumeId string: The OCID of the volume.

VolumeId string: The OCID of the volume.

volumeId String: The OCID of the volume.

volumeId string: The OCID of the volume.

volume_id str: The OCID of the volume.

volumeId String: The OCID of the volume.

getVolume Result

The following output properties are available:

AutoTunedVpusPerGb string: The number of Volume Performance Units per GB that this volume is effectively tuned to.
AutotunePolicies List<GetVolumeAutotunePolicy>: The list of autotune policies enabled for this volume.
AvailabilityDomain string: The availability domain of the block volume replica. 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<GetVolumeBlockVolumeReplica>: The list of block volume replicas of this volume.
BlockVolumeReplicasDeletion bool
ClusterPlacementGroupId string: The clusterPlacementGroup Id of the volume for volume placement.
CompartmentId string: The OCID of the compartment that contains the volume.
DefinedTags Dictionary<string, string>: 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: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
FreeformTags Dictionary<string, string>: 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"}
Id string: (Required when type=blockVolumeReplica | volume | volumeBackup) The OCID of the block volume replica.
IsAutoTuneEnabled bool: 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.
IsHydrated bool: Specifies whether the cloned volume's data has finished copying from the source volume or backup.
IsReservationsEnabled bool: Reservations-enabled is a boolean field that allows to enable PR (Persistent Reservation) on a volume.
KmsKeyId string: The OCID of the Vault service key which is the master encryption key for the volume.
SizeInGbs string: The size of the volume in GBs.
SizeInMbs string: The size of the volume in MBs. This field is deprecated. Use sizeInGBs instead.
Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.
SourceDetails List<GetVolumeSourceDetail>: 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.
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
VolumeGroupId string: The OCID of the source volume group.
VolumeId string
VpusPerGb string: 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.
XrcKmsKeyId string

AutoTunedVpusPerGb string: The number of Volume Performance Units per GB that this volume is effectively tuned to.
AutotunePolicies []GetVolumeAutotunePolicy: The list of autotune policies enabled for this volume.
AvailabilityDomain string: The availability domain of the block volume replica. 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 []GetVolumeBlockVolumeReplica: The list of block volume replicas of this volume.
BlockVolumeReplicasDeletion bool
ClusterPlacementGroupId string: The clusterPlacementGroup Id of the volume for volume placement.
CompartmentId string: The OCID of the compartment that contains the volume.
DefinedTags map[string]string: 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: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
FreeformTags map[string]string: 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"}
Id string: (Required when type=blockVolumeReplica | volume | volumeBackup) The OCID of the block volume replica.
IsAutoTuneEnabled bool: 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.
IsHydrated bool: Specifies whether the cloned volume's data has finished copying from the source volume or backup.
IsReservationsEnabled bool: Reservations-enabled is a boolean field that allows to enable PR (Persistent Reservation) on a volume.
KmsKeyId string: The OCID of the Vault service key which is the master encryption key for the volume.
SizeInGbs string: The size of the volume in GBs.
SizeInMbs string: The size of the volume in MBs. This field is deprecated. Use sizeInGBs instead.
Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.
SourceDetails []GetVolumeSourceDetail: 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.
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
VolumeGroupId string: The OCID of the source volume group.
VolumeId string
VpusPerGb string: 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.
XrcKmsKeyId string

autoTunedVpusPerGb String: The number of Volume Performance Units per GB that this volume is effectively tuned to.
autotunePolicies List<GetVolumeAutotunePolicy>: The list of autotune policies enabled for this volume.
availabilityDomain String: The availability domain of the block volume replica. 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<GetVolumeBlockVolumeReplica>: The list of block volume replicas of this volume.
blockVolumeReplicasDeletion Boolean
clusterPlacementGroupId String: The clusterPlacementGroup Id of the volume for volume placement.
compartmentId String: The OCID of the compartment that contains the volume.
definedTags Map<String,String>: 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: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTags Map<String,String>: 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"}
id String: (Required when type=blockVolumeReplica | volume | volumeBackup) The OCID of the block volume replica.
isAutoTuneEnabled Boolean: 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.
isHydrated Boolean: Specifies whether the cloned volume's data has finished copying from the source volume or backup.
isReservationsEnabled Boolean: Reservations-enabled is a boolean field that allows to enable PR (Persistent Reservation) on a volume.
kmsKeyId String: The OCID of the Vault service key which is the master encryption key for the volume.
sizeInGbs String: The size of the volume in GBs.
sizeInMbs String: The size of the volume in MBs. This field is deprecated. Use sizeInGBs instead.
Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.
sourceDetails List<GetVolumeSourceDetail>: 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.
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
volumeGroupId String: The OCID of the source volume group.
volumeId String
vpusPerGb String: 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.
xrcKmsKeyId String

autoTunedVpusPerGb string: The number of Volume Performance Units per GB that this volume is effectively tuned to.
autotunePolicies GetVolumeAutotunePolicy[]: The list of autotune policies enabled for this volume.
availabilityDomain string: The availability domain of the block volume replica. 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 GetVolumeBlockVolumeReplica[]: The list of block volume replicas of this volume.
blockVolumeReplicasDeletion boolean
clusterPlacementGroupId string: The clusterPlacementGroup Id of the volume for volume placement.
compartmentId string: The OCID of the compartment that contains the volume.
definedTags {[key: string]: string}: 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: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTags {[key: string]: string}: 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"}
id string: (Required when type=blockVolumeReplica | volume | volumeBackup) The OCID of the block volume replica.
isAutoTuneEnabled boolean: 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.
isHydrated boolean: Specifies whether the cloned volume's data has finished copying from the source volume or backup.
isReservationsEnabled boolean: Reservations-enabled is a boolean field that allows to enable PR (Persistent Reservation) on a volume.
kmsKeyId string: The OCID of the Vault service key which is the master encryption key for the volume.
sizeInGbs string: The size of the volume in GBs.
sizeInMbs string: The size of the volume in MBs. This field is deprecated. Use sizeInGBs instead.
Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.
sourceDetails GetVolumeSourceDetail[]: 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.
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
volumeGroupId string: The OCID of the source volume group.
volumeId string
vpusPerGb string: 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.
xrcKmsKeyId string

auto_tuned_vpus_per_gb str: The number of Volume Performance Units per GB that this volume is effectively tuned to.
autotune_policies Sequence[GetVolumeAutotunePolicy]: The list of autotune policies enabled for this volume.
availability_domain str: The availability domain of the block volume replica. 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[GetVolumeBlockVolumeReplica]: The list of block volume replicas of this volume.
block_volume_replicas_deletion bool
cluster_placement_group_id str: The clusterPlacementGroup Id of the volume for volume placement.
compartment_id str: The OCID of the compartment that contains the volume.
defined_tags Mapping[str, str]: 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: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeform_tags Mapping[str, str]: 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"}
id str: (Required when type=blockVolumeReplica | volume | volumeBackup) The OCID of the block volume replica.
is_auto_tune_enabled bool: 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.
is_hydrated bool: Specifies whether the cloned volume's data has finished copying from the source volume or backup.
is_reservations_enabled bool: Reservations-enabled is a boolean field that allows to enable PR (Persistent Reservation) on a volume.
kms_key_id str: The OCID of the Vault service key which is the master encryption key for the volume.
size_in_gbs str: The size of the volume in GBs.
size_in_mbs str: The size of the volume in MBs. This field is deprecated. Use sizeInGBs instead.
Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.
source_details Sequence[GetVolumeSourceDetail]: 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.
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
volume_group_id str: The OCID of the source volume group.
volume_id str
vpus_per_gb str: 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.
xrc_kms_key_id str

autoTunedVpusPerGb String: The number of Volume Performance Units per GB that this volume is effectively tuned to.
autotunePolicies List<Property Map>: The list of autotune policies enabled for this volume.
availabilityDomain String: The availability domain of the block volume replica. 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>: The list of block volume replicas of this volume.
blockVolumeReplicasDeletion Boolean
clusterPlacementGroupId String: The clusterPlacementGroup Id of the volume for volume placement.
compartmentId String: The OCID of the compartment that contains the volume.
definedTags Map<String>: 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: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTags Map<String>: 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"}
id String: (Required when type=blockVolumeReplica | volume | volumeBackup) The OCID of the block volume replica.
isAutoTuneEnabled Boolean: 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.
isHydrated Boolean: Specifies whether the cloned volume's data has finished copying from the source volume or backup.
isReservationsEnabled Boolean: Reservations-enabled is a boolean field that allows to enable PR (Persistent Reservation) on a volume.
kmsKeyId String: The OCID of the Vault service key which is the master encryption key for the volume.
sizeInGbs String: The size of the volume in GBs.
sizeInMbs String: The size of the volume in MBs. This field is deprecated. Use sizeInGBs instead.
Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.
sourceDetails List<Property Map>: 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.
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
volumeGroupId String: The OCID of the source volume group.
volumeId String
vpusPerGb String: 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.
xrcKmsKeyId String

Supporting Types

GetVolumeAutotunePolicy

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

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

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

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

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

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

GetVolumeBlockVolumeReplica

AvailabilityDomain string: 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: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
KmsKeyId string: The OCID of the Vault service key which is the master encryption key for the volume.
XrrKmsKeyId string

AvailabilityDomain string: 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: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
KmsKeyId string: The OCID of the Vault service key which is the master encryption key for the volume.
XrrKmsKeyId string

availabilityDomain String: 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: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
kmsKeyId String: The OCID of the Vault service key which is the master encryption key for the volume.
xrrKmsKeyId String

availabilityDomain string: 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: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
kmsKeyId string: The OCID of the Vault service key which is the master encryption key for the volume.
xrrKmsKeyId string

availability_domain str: 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: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
kms_key_id str: The OCID of the Vault service key which is the master encryption key for the volume.
xrr_kms_key_id str

availabilityDomain String: 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: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
kmsKeyId String: The OCID of the Vault service key which is the master encryption key for the volume.
xrrKmsKeyId String

GetVolumeSourceDetail

ChangeBlockSizeInBytes string: (Applicable when type=volumeBackupDelta) 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: (Required when type=volumeBackupDelta) The OCID of the first volume backup.
Id string: (Required when type=blockVolumeReplica | volume | volumeBackup) The OCID of the block volume replica.
SecondBackupId string: (Required when type=volumeBackupDelta) The OCID of the second volume backup.
Type string: (Required) The type can be one of these values: blockVolumeReplica, volume, volumeBackup, volumeBackupDelta

ChangeBlockSizeInBytes string: (Applicable when type=volumeBackupDelta) 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: (Required when type=volumeBackupDelta) The OCID of the first volume backup.
Id string: (Required when type=blockVolumeReplica | volume | volumeBackup) The OCID of the block volume replica.
SecondBackupId string: (Required when type=volumeBackupDelta) The OCID of the second volume backup.
Type string: (Required) The type can be one of these values: blockVolumeReplica, volume, volumeBackup, volumeBackupDelta

changeBlockSizeInBytes String: (Applicable when type=volumeBackupDelta) 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: (Required when type=volumeBackupDelta) The OCID of the first volume backup.
id String: (Required when type=blockVolumeReplica | volume | volumeBackup) The OCID of the block volume replica.
secondBackupId String: (Required when type=volumeBackupDelta) The OCID of the second volume backup.
type String: (Required) The type can be one of these values: blockVolumeReplica, volume, volumeBackup, volumeBackupDelta

changeBlockSizeInBytes string: (Applicable when type=volumeBackupDelta) 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: (Required when type=volumeBackupDelta) The OCID of the first volume backup.
id string: (Required when type=blockVolumeReplica | volume | volumeBackup) The OCID of the block volume replica.
secondBackupId string: (Required when type=volumeBackupDelta) The OCID of the second volume backup.
type string: (Required) The type can be one of these values: blockVolumeReplica, volume, volumeBackup, volumeBackupDelta

change_block_size_in_bytes str: (Applicable when type=volumeBackupDelta) 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: (Required when type=volumeBackupDelta) The OCID of the first volume backup.
id str: (Required when type=blockVolumeReplica | volume | volumeBackup) The OCID of the block volume replica.
second_backup_id str: (Required when type=volumeBackupDelta) The OCID of the second volume backup.
type str: (Required) The type can be one of these values: blockVolumeReplica, volume, volumeBackup, volumeBackupDelta

changeBlockSizeInBytes String: (Applicable when type=volumeBackupDelta) 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: (Required when type=volumeBackupDelta) The OCID of the first volume backup.
id String: (Required when type=blockVolumeReplica | volume | volumeBackup) The OCID of the block volume replica.
secondBackupId String: (Required when type=volumeBackupDelta) The OCID of the second volume backup.
type String: (Required) The type can be one of these values: blockVolumeReplica, volume, volumeBackup, volumeBackupDelta

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.getVolume

On this page

On this page

Example Usage

Using getVolume

getVolume Result

Supporting Types

GetVolumeAutotunePolicy

GetVolumeBlockVolumeReplica

GetVolumeSourceDetail

Package Details

On this page

On this page