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

oci.Core.getBootVolumeBackup

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 details about a specific Boot Volume Backup resource in Oracle Cloud Infrastructure Core service.

    Gets information for the specified boot volume backup.

    Example Usage

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

const testBootVolumeBackup = oci.Core.getBootVolumeBackup({
    bootVolumeBackupId: testBootVolumeBackupOciCoreBootVolumeBackup.id,
});

    import pulumi
import pulumi_oci as oci

test_boot_volume_backup = oci.Core.get_boot_volume_backup(boot_volume_backup_id=test_boot_volume_backup_oci_core_boot_volume_backup["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.GetBootVolumeBackup(ctx, &core.GetBootVolumeBackupArgs{
			BootVolumeBackupId: testBootVolumeBackupOciCoreBootVolumeBackup.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 testBootVolumeBackup = Oci.Core.GetBootVolumeBackup.Invoke(new()
    {
        BootVolumeBackupId = testBootVolumeBackupOciCoreBootVolumeBackup.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.GetBootVolumeBackupArgs;
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 testBootVolumeBackup = CoreFunctions.getBootVolumeBackup(GetBootVolumeBackupArgs.builder()
            .bootVolumeBackupId(testBootVolumeBackupOciCoreBootVolumeBackup.id())
            .build());

    }
}

    variables:
  testBootVolumeBackup:
    fn::invoke:
      Function: oci:Core:getBootVolumeBackup
      Arguments:
        bootVolumeBackupId: ${testBootVolumeBackupOciCoreBootVolumeBackup.id}

    Using getBootVolumeBackup

    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 getBootVolumeBackup(args: GetBootVolumeBackupArgs, opts?: InvokeOptions): Promise<GetBootVolumeBackupResult>
function getBootVolumeBackupOutput(args: GetBootVolumeBackupOutputArgs, opts?: InvokeOptions): Output<GetBootVolumeBackupResult>
    def get_boot_volume_backup(boot_volume_backup_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetBootVolumeBackupResult
def get_boot_volume_backup_output(boot_volume_backup_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetBootVolumeBackupResult]
    func GetBootVolumeBackup(ctx *Context, args *GetBootVolumeBackupArgs, opts ...InvokeOption) (*GetBootVolumeBackupResult, error)
func GetBootVolumeBackupOutput(ctx *Context, args *GetBootVolumeBackupOutputArgs, opts ...InvokeOption) GetBootVolumeBackupResultOutput

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

    public static class GetBootVolumeBackup 
{
    public static Task<GetBootVolumeBackupResult> InvokeAsync(GetBootVolumeBackupArgs args, InvokeOptions? opts = null)
    public static Output<GetBootVolumeBackupResult> Invoke(GetBootVolumeBackupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBootVolumeBackupResult> getBootVolumeBackup(GetBootVolumeBackupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    BootVolumeBackupId string
    The OCID of the boot volume backup.
    BootVolumeBackupId string
    The OCID of the boot volume backup.
    bootVolumeBackupId String
    The OCID of the boot volume backup.
    bootVolumeBackupId string
    The OCID of the boot volume backup.
    boot_volume_backup_id str
    The OCID of the boot volume backup.
    bootVolumeBackupId String
    The OCID of the boot volume backup.

    getBootVolumeBackup Result

    The following output properties are available:

    BootVolumeBackupId string
    BootVolumeId string
    The OCID of the boot volume.
    CompartmentId string
    The OCID of the compartment that contains the boot volume backup.
    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.
    ExpirationTime string
    The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
    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 backup.
    ImageId string
    The image OCID used to create the boot volume the backup is taken from.
    KmsKeyId string
    The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    SizeInGbs string
    The size of the boot volume, in GBs.
    SourceBootVolumeBackupId string
    The OCID of the source boot volume backup.
    SourceDetails List<GetBootVolumeBackupSourceDetail>
    SourceType string
    Specifies whether the backup was created manually, or via scheduled backup policy.
    State string
    The current state of a boot volume backup.
    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 backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    TimeRequestReceived string
    The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
    Type string
    The type of a volume backup. Supported values are 'FULL' or 'INCREMENTAL'.
    UniqueSizeInGbs string
    The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.
    BootVolumeBackupId string
    BootVolumeId string
    The OCID of the boot volume.
    CompartmentId string
    The OCID of the compartment that contains the boot volume backup.
    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.
    ExpirationTime string
    The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
    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 backup.
    ImageId string
    The image OCID used to create the boot volume the backup is taken from.
    KmsKeyId string
    The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    SizeInGbs string
    The size of the boot volume, in GBs.
    SourceBootVolumeBackupId string
    The OCID of the source boot volume backup.
    SourceDetails []GetBootVolumeBackupSourceDetail
    SourceType string
    Specifies whether the backup was created manually, or via scheduled backup policy.
    State string
    The current state of a boot volume backup.
    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 backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    TimeRequestReceived string
    The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
    Type string
    The type of a volume backup. Supported values are 'FULL' or 'INCREMENTAL'.
    UniqueSizeInGbs string
    The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.
    bootVolumeBackupId String
    bootVolumeId String
    The OCID of the boot volume.
    compartmentId String
    The OCID of the compartment that contains the boot volume backup.
    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.
    expirationTime String
    The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
    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 backup.
    imageId String
    The image OCID used to create the boot volume the backup is taken from.
    kmsKeyId String
    The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    sizeInGbs String
    The size of the boot volume, in GBs.
    sourceBootVolumeBackupId String
    The OCID of the source boot volume backup.
    sourceDetails List<GetBootVolumeBackupSourceDetail>
    sourceType String
    Specifies whether the backup was created manually, or via scheduled backup policy.
    state String
    The current state of a boot volume backup.
    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 backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    timeRequestReceived String
    The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
    type String
    The type of a volume backup. Supported values are 'FULL' or 'INCREMENTAL'.
    uniqueSizeInGbs String
    The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.
    bootVolumeBackupId string
    bootVolumeId string
    The OCID of the boot volume.
    compartmentId string
    The OCID of the compartment that contains the boot volume backup.
    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.
    expirationTime string
    The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
    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 backup.
    imageId string
    The image OCID used to create the boot volume the backup is taken from.
    kmsKeyId string
    The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    sizeInGbs string
    The size of the boot volume, in GBs.
    sourceBootVolumeBackupId string
    The OCID of the source boot volume backup.
    sourceDetails GetBootVolumeBackupSourceDetail[]
    sourceType string
    Specifies whether the backup was created manually, or via scheduled backup policy.
    state string
    The current state of a boot volume backup.
    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 backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    timeRequestReceived string
    The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
    type string
    The type of a volume backup. Supported values are 'FULL' or 'INCREMENTAL'.
    uniqueSizeInGbs string
    The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.
    boot_volume_backup_id str
    boot_volume_id str
    The OCID of the boot volume.
    compartment_id str
    The OCID of the compartment that contains the boot volume backup.
    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.
    expiration_time str
    The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
    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 backup.
    image_id str
    The image OCID used to create the boot volume the backup is taken from.
    kms_key_id str
    The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    size_in_gbs str
    The size of the boot volume, in GBs.
    source_boot_volume_backup_id str
    The OCID of the source boot volume backup.
    source_details Sequence[core.GetBootVolumeBackupSourceDetail]
    source_type str
    Specifies whether the backup was created manually, or via scheduled backup policy.
    state str
    The current state of a boot volume backup.
    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 backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    time_request_received str
    The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
    type str
    The type of a volume backup. Supported values are 'FULL' or 'INCREMENTAL'.
    unique_size_in_gbs str
    The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.
    bootVolumeBackupId String
    bootVolumeId String
    The OCID of the boot volume.
    compartmentId String
    The OCID of the compartment that contains the boot volume backup.
    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.
    expirationTime String
    The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
    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 backup.
    imageId String
    The image OCID used to create the boot volume the backup is taken from.
    kmsKeyId String
    The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    sizeInGbs String
    The size of the boot volume, in GBs.
    sourceBootVolumeBackupId String
    The OCID of the source boot volume backup.
    sourceDetails List<Property Map>
    sourceType String
    Specifies whether the backup was created manually, or via scheduled backup policy.
    state String
    The current state of a boot volume backup.
    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 backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    timeRequestReceived String
    The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
    type String
    The type of a volume backup. Supported values are 'FULL' or 'INCREMENTAL'.
    uniqueSizeInGbs String
    The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.

    Supporting Types

    GetBootVolumeBackupSourceDetail

    BootVolumeBackupId string
    The OCID of the boot volume backup.
    KmsKeyId string
    The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    Region string
    BootVolumeBackupId string
    The OCID of the boot volume backup.
    KmsKeyId string
    The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    Region string
    bootVolumeBackupId String
    The OCID of the boot volume backup.
    kmsKeyId String
    The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    region String
    bootVolumeBackupId string
    The OCID of the boot volume backup.
    kmsKeyId string
    The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    region string
    boot_volume_backup_id str
    The OCID of the boot volume backup.
    kms_key_id str
    The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    region str
    bootVolumeBackupId String
    The OCID of the boot volume backup.
    kmsKeyId String
    The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    region String

    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