1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. getBootVolume
Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi

oci.Core.getBootVolume

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi

    This data source provides details about a specific Boot Volume resource in Oracle Cloud Infrastructure Core service.

    Gets information for the specified boot volume.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testBootVolume = oci.Core.getBootVolume({
        bootVolumeId: testBootVolumeOciCoreBootVolume.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_boot_volume = oci.Core.get_boot_volume(boot_volume_id=test_boot_volume_oci_core_boot_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.GetBootVolume(ctx, &core.GetBootVolumeArgs{
    			BootVolumeId: testBootVolumeOciCoreBootVolume.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 testBootVolume = Oci.Core.GetBootVolume.Invoke(new()
        {
            BootVolumeId = testBootVolumeOciCoreBootVolume.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.GetBootVolumeArgs;
    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 testBootVolume = CoreFunctions.getBootVolume(GetBootVolumeArgs.builder()
                .bootVolumeId(testBootVolumeOciCoreBootVolume.id())
                .build());
    
        }
    }
    
    variables:
      testBootVolume:
        fn::invoke:
          Function: oci:Core:getBootVolume
          Arguments:
            bootVolumeId: ${testBootVolumeOciCoreBootVolume.id}
    

    Using getBootVolume

    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 getBootVolume(args: GetBootVolumeArgs, opts?: InvokeOptions): Promise<GetBootVolumeResult>
    function getBootVolumeOutput(args: GetBootVolumeOutputArgs, opts?: InvokeOptions): Output<GetBootVolumeResult>
    def get_boot_volume(boot_volume_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetBootVolumeResult
    def get_boot_volume_output(boot_volume_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetBootVolumeResult]
    func GetBootVolume(ctx *Context, args *GetBootVolumeArgs, opts ...InvokeOption) (*GetBootVolumeResult, error)
    func GetBootVolumeOutput(ctx *Context, args *GetBootVolumeOutputArgs, opts ...InvokeOption) GetBootVolumeResultOutput

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

    public static class GetBootVolume 
    {
        public static Task<GetBootVolumeResult> InvokeAsync(GetBootVolumeArgs args, InvokeOptions? opts = null)
        public static Output<GetBootVolumeResult> Invoke(GetBootVolumeInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBootVolumeResult> getBootVolume(GetBootVolumeArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Core/getBootVolume:getBootVolume
      arguments:
        # arguments dictionary

    The following arguments are supported:

    BootVolumeId string
    The OCID of the boot volume.
    BootVolumeId string
    The OCID of the boot volume.
    bootVolumeId String
    The OCID of the boot volume.
    bootVolumeId string
    The OCID of the boot volume.
    boot_volume_id str
    The OCID of the boot volume.
    bootVolumeId String
    The OCID of the boot volume.

    getBootVolume Result

    The following output properties are available:

    AutoTunedVpusPerGb string
    The number of Volume Performance Units per GB that this boot volume is effectively tuned to.
    AutotunePolicies List<GetBootVolumeAutotunePolicy>
    The list of autotune policies enabled for this volume.
    AvailabilityDomain string
    The availability domain of the boot 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.

    BootVolumeId string
    BootVolumeReplicas List<GetBootVolumeBootVolumeReplica>
    The list of boot volume replicas of this boot volume
    BootVolumeReplicasDeletion bool
    ClusterPlacementGroupId string
    The clusterPlacementGroup Id of the volume for volume placement.
    CompartmentId string
    The OCID of the compartment that contains the boot 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
    The OCID of the boot volume replica.
    ImageId string
    The image OCID used to create the boot volume.
    IsAutoTuneEnabled bool
    Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the DetachedVolumeAutotunePolicy instead to enable the volume for detached autotune.
    IsHydrated bool
    Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup.
    KmsKeyId string
    The OCID of the Vault service master encryption key assigned to the boot volume.
    SizeInGbs string
    The size of the boot volume in GBs.
    SizeInMbs string
    The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.
    SourceDetails List<GetBootVolumeSourceDetail>
    State string
    The current state of a boot 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 boot volume was created. Format defined by RFC3339.
    VolumeGroupId string
    The OCID of the source volume group.
    VpusPerGb string
    The number of volume performance units (VPUs) that will be applied to this boot volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.
    AutoTunedVpusPerGb string
    The number of Volume Performance Units per GB that this boot volume is effectively tuned to.
    AutotunePolicies []GetBootVolumeAutotunePolicy
    The list of autotune policies enabled for this volume.
    AvailabilityDomain string
    The availability domain of the boot 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.

    BootVolumeId string
    BootVolumeReplicas []GetBootVolumeBootVolumeReplica
    The list of boot volume replicas of this boot volume
    BootVolumeReplicasDeletion bool
    ClusterPlacementGroupId string
    The clusterPlacementGroup Id of the volume for volume placement.
    CompartmentId string
    The OCID of the compartment that contains the boot 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
    The OCID of the boot volume replica.
    ImageId string
    The image OCID used to create the boot volume.
    IsAutoTuneEnabled bool
    Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the DetachedVolumeAutotunePolicy instead to enable the volume for detached autotune.
    IsHydrated bool
    Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup.
    KmsKeyId string
    The OCID of the Vault service master encryption key assigned to the boot volume.
    SizeInGbs string
    The size of the boot volume in GBs.
    SizeInMbs string
    The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.
    SourceDetails []GetBootVolumeSourceDetail
    State string
    The current state of a boot 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 boot volume was created. Format defined by RFC3339.
    VolumeGroupId string
    The OCID of the source volume group.
    VpusPerGb string
    The number of volume performance units (VPUs) that will be applied to this boot volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.
    autoTunedVpusPerGb String
    The number of Volume Performance Units per GB that this boot volume is effectively tuned to.
    autotunePolicies List<GetBootVolumeAutotunePolicy>
    The list of autotune policies enabled for this volume.
    availabilityDomain String
    The availability domain of the boot 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.

    bootVolumeId String
    bootVolumeReplicas List<GetBootVolumeBootVolumeReplica>
    The list of boot volume replicas of this boot volume
    bootVolumeReplicasDeletion Boolean
    clusterPlacementGroupId String
    The clusterPlacementGroup Id of the volume for volume placement.
    compartmentId String
    The OCID of the compartment that contains the boot 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
    The OCID of the boot volume replica.
    imageId String
    The image OCID used to create the boot volume.
    isAutoTuneEnabled Boolean
    Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the DetachedVolumeAutotunePolicy instead to enable the volume for detached autotune.
    isHydrated Boolean
    Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup.
    kmsKeyId String
    The OCID of the Vault service master encryption key assigned to the boot volume.
    sizeInGbs String
    The size of the boot volume in GBs.
    sizeInMbs String
    The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.
    sourceDetails List<GetBootVolumeSourceDetail>
    state String
    The current state of a boot 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 boot volume was created. Format defined by RFC3339.
    volumeGroupId String
    The OCID of the source volume group.
    vpusPerGb String
    The number of volume performance units (VPUs) that will be applied to this boot volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.
    autoTunedVpusPerGb string
    The number of Volume Performance Units per GB that this boot volume is effectively tuned to.
    autotunePolicies GetBootVolumeAutotunePolicy[]
    The list of autotune policies enabled for this volume.
    availabilityDomain string
    The availability domain of the boot 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.

    bootVolumeId string
    bootVolumeReplicas GetBootVolumeBootVolumeReplica[]
    The list of boot volume replicas of this boot volume
    bootVolumeReplicasDeletion boolean
    clusterPlacementGroupId string
    The clusterPlacementGroup Id of the volume for volume placement.
    compartmentId string
    The OCID of the compartment that contains the boot 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
    The OCID of the boot volume replica.
    imageId string
    The image OCID used to create the boot volume.
    isAutoTuneEnabled boolean
    Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the DetachedVolumeAutotunePolicy instead to enable the volume for detached autotune.
    isHydrated boolean
    Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup.
    kmsKeyId string
    The OCID of the Vault service master encryption key assigned to the boot volume.
    sizeInGbs string
    The size of the boot volume in GBs.
    sizeInMbs string
    The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.
    sourceDetails GetBootVolumeSourceDetail[]
    state string
    The current state of a boot 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 boot volume was created. Format defined by RFC3339.
    volumeGroupId string
    The OCID of the source volume group.
    vpusPerGb string
    The number of volume performance units (VPUs) that will be applied to this boot volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.
    auto_tuned_vpus_per_gb str
    The number of Volume Performance Units per GB that this boot volume is effectively tuned to.
    autotune_policies Sequence[core.GetBootVolumeAutotunePolicy]
    The list of autotune policies enabled for this volume.
    availability_domain str
    The availability domain of the boot 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.

    boot_volume_id str
    boot_volume_replicas Sequence[core.GetBootVolumeBootVolumeReplica]
    The list of boot volume replicas of this boot volume
    boot_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 boot 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
    The OCID of the boot volume replica.
    image_id str
    The image OCID used to create the boot volume.
    is_auto_tune_enabled bool
    Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the DetachedVolumeAutotunePolicy instead to enable the volume for detached autotune.
    is_hydrated bool
    Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup.
    kms_key_id str
    The OCID of the Vault service master encryption key assigned to the boot volume.
    size_in_gbs str
    The size of the boot 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. Please use size_in_gbs.
    source_details Sequence[core.GetBootVolumeSourceDetail]
    state str
    The current state of a boot 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 boot volume was created. Format defined by RFC3339.
    volume_group_id str
    The OCID of the source volume group.
    vpus_per_gb str
    The number of volume performance units (VPUs) that will be applied to this boot volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.
    autoTunedVpusPerGb String
    The number of Volume Performance Units per GB that this boot 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 boot 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.

    bootVolumeId String
    bootVolumeReplicas List<Property Map>
    The list of boot volume replicas of this boot volume
    bootVolumeReplicasDeletion Boolean
    clusterPlacementGroupId String
    The clusterPlacementGroup Id of the volume for volume placement.
    compartmentId String
    The OCID of the compartment that contains the boot 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
    The OCID of the boot volume replica.
    imageId String
    The image OCID used to create the boot volume.
    isAutoTuneEnabled Boolean
    Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the DetachedVolumeAutotunePolicy instead to enable the volume for detached autotune.
    isHydrated Boolean
    Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup.
    kmsKeyId String
    The OCID of the Vault service master encryption key assigned to the boot volume.
    sizeInGbs String
    The size of the boot volume in GBs.
    sizeInMbs String
    The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.
    sourceDetails List<Property Map>
    state String
    The current state of a boot 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 boot volume was created. Format defined by RFC3339.
    volumeGroupId String
    The OCID of the source volume group.
    vpusPerGb String
    The number of volume performance units (VPUs) that will be applied to this boot volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.

    Supporting Types

    GetBootVolumeAutotunePolicy

    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.

    GetBootVolumeBootVolumeReplica

    AvailabilityDomain string
    The availability domain of the boot volume replica. Example: Uocm:PHX-AD-1
    BootVolumeReplicaId string
    The boot 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.
    AvailabilityDomain string
    The availability domain of the boot volume replica. Example: Uocm:PHX-AD-1
    BootVolumeReplicaId string
    The boot 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.
    availabilityDomain String
    The availability domain of the boot volume replica. Example: Uocm:PHX-AD-1
    bootVolumeReplicaId String
    The boot 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.
    availabilityDomain string
    The availability domain of the boot volume replica. Example: Uocm:PHX-AD-1
    bootVolumeReplicaId string
    The boot 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.
    availability_domain str
    The availability domain of the boot volume replica. Example: Uocm:PHX-AD-1
    boot_volume_replica_id str
    The boot 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.
    availabilityDomain String
    The availability domain of the boot volume replica. Example: Uocm:PHX-AD-1
    bootVolumeReplicaId String
    The boot 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.

    GetBootVolumeSourceDetail

    Id string
    The OCID of the boot volume replica.
    Type string
    The type can be one of these values: bootVolume, bootVolumeBackup, bootVolumeReplica
    Id string
    The OCID of the boot volume replica.
    Type string
    The type can be one of these values: bootVolume, bootVolumeBackup, bootVolumeReplica
    id String
    The OCID of the boot volume replica.
    type String
    The type can be one of these values: bootVolume, bootVolumeBackup, bootVolumeReplica
    id string
    The OCID of the boot volume replica.
    type string
    The type can be one of these values: bootVolume, bootVolumeBackup, bootVolumeReplica
    id str
    The OCID of the boot volume replica.
    type str
    The type can be one of these values: bootVolume, bootVolumeBackup, bootVolumeReplica
    id String
    The OCID of the boot volume replica.
    type String
    The type can be one of these values: bootVolume, bootVolumeBackup, bootVolumeReplica

    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.11.0 published on Thursday, Sep 19, 2024 by Pulumi