Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. getVolumes
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

oci.Core.getVolumes

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

    This data source provides the list of Volumes in Oracle Cloud Infrastructure Core service.

    Lists the volumes in the specified compartment and availability domain.

    Example Usage

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

const testVolumes = oci.Core.getVolumes({
    availabilityDomain: volumeAvailabilityDomain,
    clusterPlacementGroupId: testGroup.id,
    compartmentId: compartmentId,
    displayName: volumeDisplayName,
    state: volumeState,
    volumeGroupId: testVolumeGroup.id,
});

    import pulumi
import pulumi_oci as oci

test_volumes = oci.Core.get_volumes(availability_domain=volume_availability_domain,
    cluster_placement_group_id=test_group["id"],
    compartment_id=compartment_id,
    display_name=volume_display_name,
    state=volume_state,
    volume_group_id=test_volume_group["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.GetVolumes(ctx, &core.GetVolumesArgs{
			AvailabilityDomain:      pulumi.StringRef(volumeAvailabilityDomain),
			ClusterPlacementGroupId: pulumi.StringRef(testGroup.Id),
			CompartmentId:           pulumi.StringRef(compartmentId),
			DisplayName:             pulumi.StringRef(volumeDisplayName),
			State:                   pulumi.StringRef(volumeState),
			VolumeGroupId:           pulumi.StringRef(testVolumeGroup.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 testVolumes = Oci.Core.GetVolumes.Invoke(new()
    {
        AvailabilityDomain = volumeAvailabilityDomain,
        ClusterPlacementGroupId = testGroup.Id,
        CompartmentId = compartmentId,
        DisplayName = volumeDisplayName,
        State = volumeState,
        VolumeGroupId = testVolumeGroup.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.GetVolumesArgs;
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 testVolumes = CoreFunctions.getVolumes(GetVolumesArgs.builder()
            .availabilityDomain(volumeAvailabilityDomain)
            .clusterPlacementGroupId(testGroup.id())
            .compartmentId(compartmentId)
            .displayName(volumeDisplayName)
            .state(volumeState)
            .volumeGroupId(testVolumeGroup.id())
            .build());

    }
}

    variables:
  testVolumes:
    fn::invoke:
      Function: oci:Core:getVolumes
      Arguments:
        availabilityDomain: ${volumeAvailabilityDomain}
        clusterPlacementGroupId: ${testGroup.id}
        compartmentId: ${compartmentId}
        displayName: ${volumeDisplayName}
        state: ${volumeState}
        volumeGroupId: ${testVolumeGroup.id}

    Using getVolumes

    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 getVolumes(args: GetVolumesArgs, opts?: InvokeOptions): Promise<GetVolumesResult>
function getVolumesOutput(args: GetVolumesOutputArgs, opts?: InvokeOptions): Output<GetVolumesResult>
    def get_volumes(availability_domain: Optional[str] = None,
                cluster_placement_group_id: Optional[str] = None,
                compartment_id: Optional[str] = None,
                display_name: Optional[str] = None,
                filters: Optional[Sequence[_core.GetVolumesFilter]] = None,
                state: Optional[str] = None,
                volume_group_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetVolumesResult
def get_volumes_output(availability_domain: Optional[pulumi.Input[str]] = None,
                cluster_placement_group_id: Optional[pulumi.Input[str]] = None,
                compartment_id: Optional[pulumi.Input[str]] = None,
                display_name: Optional[pulumi.Input[str]] = None,
                filters: Optional[pulumi.Input[Sequence[pulumi.Input[_core.GetVolumesFilterArgs]]]] = None,
                state: Optional[pulumi.Input[str]] = None,
                volume_group_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetVolumesResult]
    func GetVolumes(ctx *Context, args *GetVolumesArgs, opts ...InvokeOption) (*GetVolumesResult, error)
func GetVolumesOutput(ctx *Context, args *GetVolumesOutputArgs, opts ...InvokeOption) GetVolumesResultOutput

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

    public static class GetVolumes 
{
    public static Task<GetVolumesResult> InvokeAsync(GetVolumesArgs args, InvokeOptions? opts = null)
    public static Output<GetVolumesResult> Invoke(GetVolumesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVolumesResult> getVolumes(GetVolumesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    AvailabilityDomain string
    The name of the availability domain. Example: Uocm:PHX-AD-1
    ClusterPlacementGroupId string
    A filter to return only resources that match the given cluster placement group Id exactly.
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    Filters List<GetVolumesFilter>
    State string
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    VolumeGroupId string
    The OCID of the volume group.
    AvailabilityDomain string
    The name of the availability domain. Example: Uocm:PHX-AD-1
    ClusterPlacementGroupId string
    A filter to return only resources that match the given cluster placement group Id exactly.
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    Filters []GetVolumesFilter
    State string
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    VolumeGroupId string
    The OCID of the volume group.
    availabilityDomain String
    The name of the availability domain. Example: Uocm:PHX-AD-1
    clusterPlacementGroupId String
    A filter to return only resources that match the given cluster placement group Id exactly.
    compartmentId String
    The OCID of the compartment.
    displayName String
    A filter to return only resources that match the given display name exactly.
    filters List<GetVolumesFilter>
    state String
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    volumeGroupId String
    The OCID of the volume group.
    availabilityDomain string
    The name of the availability domain. Example: Uocm:PHX-AD-1
    clusterPlacementGroupId string
    A filter to return only resources that match the given cluster placement group Id exactly.
    compartmentId string
    The OCID of the compartment.
    displayName string
    A filter to return only resources that match the given display name exactly.
    filters GetVolumesFilter[]
    state string
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    volumeGroupId string
    The OCID of the volume group.
    availability_domain str
    The name of the availability domain. Example: Uocm:PHX-AD-1
    cluster_placement_group_id str
    A filter to return only resources that match the given cluster placement group Id exactly.
    compartment_id str
    The OCID of the compartment.
    display_name str
    A filter to return only resources that match the given display name exactly.
    filters Sequence[core.GetVolumesFilter]
    state str
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    volume_group_id str
    The OCID of the volume group.
    availabilityDomain String
    The name of the availability domain. Example: Uocm:PHX-AD-1
    clusterPlacementGroupId String
    A filter to return only resources that match the given cluster placement group Id exactly.
    compartmentId String
    The OCID of the compartment.
    displayName String
    A filter to return only resources that match the given display name exactly.
    filters List<Property Map>
    state String
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    volumeGroupId String
    The OCID of the volume group.

    getVolumes Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Volumes List<GetVolumesVolume>
    The list of volumes.
    AvailabilityDomain string
    The availability domain of the block volume replica. Example: Uocm:PHX-AD-1
    ClusterPlacementGroupId string
    The clusterPlacementGroup Id of the volume for volume placement.
    CompartmentId string
    The OCID of the compartment that contains the volume.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    Filters List<GetVolumesFilter>
    State string
    The current state of a volume.
    VolumeGroupId string
    The OCID of the source volume group.
    Id string
    The provider-assigned unique ID for this managed resource.
    Volumes []GetVolumesVolume
    The list of volumes.
    AvailabilityDomain string
    The availability domain of the block volume replica. Example: Uocm:PHX-AD-1
    ClusterPlacementGroupId string
    The clusterPlacementGroup Id of the volume for volume placement.
    CompartmentId string
    The OCID of the compartment that contains the volume.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    Filters []GetVolumesFilter
    State string
    The current state of a volume.
    VolumeGroupId string
    The OCID of the source volume group.
    id String
    The provider-assigned unique ID for this managed resource.
    volumes List<GetVolumesVolume>
    The list of volumes.
    availabilityDomain String
    The availability domain of the block volume replica. Example: Uocm:PHX-AD-1
    clusterPlacementGroupId String
    The clusterPlacementGroup Id of the volume for volume placement.
    compartmentId String
    The OCID of the compartment that contains the volume.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    filters List<GetVolumesFilter>
    state String
    The current state of a volume.
    volumeGroupId String
    The OCID of the source volume group.
    id string
    The provider-assigned unique ID for this managed resource.
    volumes GetVolumesVolume[]
    The list of volumes.
    availabilityDomain string
    The availability domain of the block volume replica. Example: Uocm:PHX-AD-1
    clusterPlacementGroupId string
    The clusterPlacementGroup Id of the volume for volume placement.
    compartmentId string
    The OCID of the compartment that contains the volume.
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    filters GetVolumesFilter[]
    state string
    The current state of a volume.
    volumeGroupId string
    The OCID of the source volume group.
    id str
    The provider-assigned unique ID for this managed resource.
    volumes Sequence[core.GetVolumesVolume]
    The list of volumes.
    availability_domain str
    The availability domain of the block volume replica. Example: Uocm:PHX-AD-1
    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.
    display_name str
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    filters Sequence[core.GetVolumesFilter]
    state str
    The current state of a volume.
    volume_group_id str
    The OCID of the source volume group.
    id String
    The provider-assigned unique ID for this managed resource.
    volumes List<Property Map>
    The list of volumes.
    availabilityDomain String
    The availability domain of the block volume replica. Example: Uocm:PHX-AD-1
    clusterPlacementGroupId String
    The clusterPlacementGroup Id of the volume for volume placement.
    compartmentId String
    The OCID of the compartment that contains the volume.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    filters List<Property Map>
    state String
    The current state of a volume.
    volumeGroupId String
    The OCID of the source volume group.

    Supporting Types

    GetVolumesFilter

    Name string
    Values List<string>
    Regex bool
    Name string
    Values []string
    Regex bool
    name String
    values List<String>
    regex Boolean
    name string
    values string[]
    regex boolean
    name str
    values Sequence[str]
    regex bool
    name String
    values List<String>
    regex Boolean

    GetVolumesVolume

    AutoTunedVpusPerGb string
    The number of Volume Performance Units per GB that this volume is effectively tuned to.
    AutotunePolicies List<GetVolumesVolumeAutotunePolicy>
    The list of autotune policies enabled for this volume.
    AvailabilityDomain string
    The name of the availability domain. 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<GetVolumesVolumeBlockVolumeReplica>
    The list of block volume replicas of this volume.
    BlockVolumeReplicasDeletion bool
    ClusterPlacementGroupId string
    A filter to return only resources that match the given cluster placement group Id exactly.
    CompartmentId string
    The OCID of the compartment.
    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 filter to return only resources that match the given display name exactly.
    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.
    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<GetVolumesVolumeSourceDetail>
    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
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    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 volume group.
    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 []GetVolumesVolumeAutotunePolicy
    The list of autotune policies enabled for this volume.
    AvailabilityDomain string
    The name of the availability domain. 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 []GetVolumesVolumeBlockVolumeReplica
    The list of block volume replicas of this volume.
    BlockVolumeReplicasDeletion bool
    ClusterPlacementGroupId string
    A filter to return only resources that match the given cluster placement group Id exactly.
    CompartmentId string
    The OCID of the compartment.
    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 filter to return only resources that match the given display name exactly.
    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.
    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 []GetVolumesVolumeSourceDetail
    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
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    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 volume group.
    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<GetVolumesVolumeAutotunePolicy>
    The list of autotune policies enabled for this volume.
    availabilityDomain String
    The name of the availability domain. 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<GetVolumesVolumeBlockVolumeReplica>
    The list of block volume replicas of this volume.
    blockVolumeReplicasDeletion Boolean
    clusterPlacementGroupId String
    A filter to return only resources that match the given cluster placement group Id exactly.
    compartmentId String
    The OCID of the compartment.
    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 filter to return only resources that match the given display name exactly.
    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.
    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<GetVolumesVolumeSourceDetail>
    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
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    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 volume group.
    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 GetVolumesVolumeAutotunePolicy[]
    The list of autotune policies enabled for this volume.
    availabilityDomain string
    The name of the availability domain. 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 GetVolumesVolumeBlockVolumeReplica[]
    The list of block volume replicas of this volume.
    blockVolumeReplicasDeletion boolean
    clusterPlacementGroupId string
    A filter to return only resources that match the given cluster placement group Id exactly.
    compartmentId string
    The OCID of the compartment.
    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 filter to return only resources that match the given display name exactly.
    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.
    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 GetVolumesVolumeSourceDetail[]
    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
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    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 volume group.
    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[core.GetVolumesVolumeAutotunePolicy]
    The list of autotune policies enabled for this volume.
    availability_domain str
    The name of the availability domain. 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[core.GetVolumesVolumeBlockVolumeReplica]
    The list of block volume replicas of this volume.
    block_volume_replicas_deletion bool
    cluster_placement_group_id str
    A filter to return only resources that match the given cluster placement group Id exactly.
    compartment_id str
    The OCID of the compartment.
    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 filter to return only resources that match the given display name exactly.
    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.
    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[core.GetVolumesVolumeSourceDetail]
    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
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    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 volume group.
    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 name of the availability domain. 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
    A filter to return only resources that match the given cluster placement group Id exactly.
    compartmentId String
    The OCID of the compartment.
    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 filter to return only resources that match the given display name exactly.
    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.
    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
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    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 volume group.
    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

    GetVolumesVolumeAutotunePolicy

    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.

    GetVolumesVolumeBlockVolumeReplica

    AvailabilityDomain string
    The name of the availability domain. Example: Uocm:PHX-AD-1
    BlockVolumeReplicaId string
    The block volume replica's Oracle ID (OCID).
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    KmsKeyId string
    The OCID of the Vault service key which is the master encryption key for the volume.
    XrrKmsKeyId string
    AvailabilityDomain string
    The name of the availability domain. Example: Uocm:PHX-AD-1
    BlockVolumeReplicaId string
    The block volume replica's Oracle ID (OCID).
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    KmsKeyId string
    The OCID of the Vault service key which is the master encryption key for the volume.
    XrrKmsKeyId string
    availabilityDomain String
    The name of the availability domain. Example: Uocm:PHX-AD-1
    blockVolumeReplicaId String
    The block volume replica's Oracle ID (OCID).
    displayName String
    A filter to return only resources that match the given display name exactly.
    kmsKeyId String
    The OCID of the Vault service key which is the master encryption key for the volume.
    xrrKmsKeyId String
    availabilityDomain string
    The name of the availability domain. Example: Uocm:PHX-AD-1
    blockVolumeReplicaId string
    The block volume replica's Oracle ID (OCID).
    displayName string
    A filter to return only resources that match the given display name exactly.
    kmsKeyId string
    The OCID of the Vault service key which is the master encryption key for the volume.
    xrrKmsKeyId string
    availability_domain str
    The name of the availability domain. Example: Uocm:PHX-AD-1
    block_volume_replica_id str
    The block volume replica's Oracle ID (OCID).
    display_name str
    A filter to return only resources that match the given display name exactly.
    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 name of the availability domain. Example: Uocm:PHX-AD-1
    blockVolumeReplicaId String
    The block volume replica's Oracle ID (OCID).
    displayName String
    A filter to return only resources that match the given display name exactly.
    kmsKeyId String
    The OCID of the Vault service key which is the master encryption key for the volume.
    xrrKmsKeyId String

    GetVolumesVolumeSourceDetail

    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.
    oci logo
    Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-oci