1. Pulumi Registry
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. BootVolumeBackup
oci logo
Oracle Cloud Infrastructure v0.12.0, Mar 17 23

oci.Core.BootVolumeBackup

This resource provides the Boot Volume Backup resource in Oracle Cloud Infrastructure Core service.

Creates a new boot volume backup of the specified boot volume. For general information about boot volume backups, see Overview of Boot Volume Backups

When the request is received, the backup object is in a REQUEST_RECEIVED state. When the data is imaged, it goes into a CREATING state. After the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testBootVolumeBackup = new Oci.Core.BootVolumeBackup("testBootVolumeBackup", new()
    {
        BootVolumeId = oci_core_boot_volume.Test_boot_volume.Id,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        DisplayName = @var.Boot_volume_backup_display_name,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        Type = @var.Boot_volume_backup_type,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Core.NewBootVolumeBackup(ctx, "testBootVolumeBackup", &Core.BootVolumeBackupArgs{
			BootVolumeId: pulumi.Any(oci_core_boot_volume.Test_boot_volume.Id),
			DefinedTags: pulumi.AnyMap{
				"Operations.CostCenter": pulumi.Any("42"),
			},
			DisplayName: pulumi.Any(_var.Boot_volume_backup_display_name),
			FreeformTags: pulumi.AnyMap{
				"Department": pulumi.Any("Finance"),
			},
			Type: pulumi.Any(_var.Boot_volume_backup_type),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.BootVolumeBackup;
import com.pulumi.oci.Core.BootVolumeBackupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testBootVolumeBackup = new BootVolumeBackup("testBootVolumeBackup", BootVolumeBackupArgs.builder()        
            .bootVolumeId(oci_core_boot_volume.test_boot_volume().id())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .displayName(var_.boot_volume_backup_display_name())
            .freeformTags(Map.of("Department", "Finance"))
            .type(var_.boot_volume_backup_type())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_boot_volume_backup = oci.core.BootVolumeBackup("testBootVolumeBackup",
    boot_volume_id=oci_core_boot_volume["test_boot_volume"]["id"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    display_name=var["boot_volume_backup_display_name"],
    freeform_tags={
        "Department": "Finance",
    },
    type=var["boot_volume_backup_type"])

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

const testBootVolumeBackup = new oci.core.BootVolumeBackup("testBootVolumeBackup", {
    bootVolumeId: oci_core_boot_volume.test_boot_volume.id,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    displayName: _var.boot_volume_backup_display_name,
    freeformTags: {
        Department: "Finance",
    },
    type: _var.boot_volume_backup_type,
});

resources:
  testBootVolumeBackup:
    type: oci:Core:BootVolumeBackup
    properties:
      #Required
      bootVolumeId: ${oci_core_boot_volume.test_boot_volume.id}
      #Optional
      definedTags:
        Operations.CostCenter: '42'
      displayName: ${var.boot_volume_backup_display_name}
      freeformTags:
        Department: Finance
      type: ${var.boot_volume_backup_type}

Create BootVolumeBackup Resource

new BootVolumeBackup(name: string, args?: BootVolumeBackupArgs, opts?: CustomResourceOptions);
@overload
def BootVolumeBackup(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     boot_volume_id: Optional[str] = None,
                     compartment_id: Optional[str] = None,
                     defined_tags: Optional[Mapping[str, Any]] = None,
                     display_name: Optional[str] = None,
                     freeform_tags: Optional[Mapping[str, Any]] = None,
                     source_details: Optional[_core.BootVolumeBackupSourceDetailsArgs] = None,
                     type: Optional[str] = None)
@overload
def BootVolumeBackup(resource_name: str,
                     args: Optional[BootVolumeBackupArgs] = None,
                     opts: Optional[ResourceOptions] = None)
func NewBootVolumeBackup(ctx *Context, name string, args *BootVolumeBackupArgs, opts ...ResourceOption) (*BootVolumeBackup, error)
public BootVolumeBackup(string name, BootVolumeBackupArgs? args = null, CustomResourceOptions? opts = null)
public BootVolumeBackup(String name, BootVolumeBackupArgs args)
public BootVolumeBackup(String name, BootVolumeBackupArgs args, CustomResourceOptions options)

type: oci:Core:BootVolumeBackup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BootVolumeBackupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args BootVolumeBackupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args BootVolumeBackupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BootVolumeBackupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args BootVolumeBackupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

BootVolumeBackup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The BootVolumeBackup resource accepts the following input properties:

BootVolumeId string

The OCID of the boot volume that needs to be backed up. Cannot be defined if source_details is defined.

CompartmentId string

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

DefinedTags Dictionary<string, object>

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

DisplayName string

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

FreeformTags Dictionary<string, object>

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

SourceDetails BootVolumeBackupSourceDetailsArgs

Details of the volume backup source in the cloud. Cannot be defined if boot_volume_id is defined.

Type string

The type of backup to create. If omitted, defaults to incremental. Supported values are 'FULL' or 'INCREMENTAL'.

BootVolumeId string

The OCID of the boot volume that needs to be backed up. Cannot be defined if source_details is defined.

CompartmentId string

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

DefinedTags map[string]interface{}

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

DisplayName string

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

FreeformTags map[string]interface{}

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

SourceDetails BootVolumeBackupSourceDetailsArgs

Details of the volume backup source in the cloud. Cannot be defined if boot_volume_id is defined.

Type string

The type of backup to create. If omitted, defaults to incremental. Supported values are 'FULL' or 'INCREMENTAL'.

bootVolumeId String

The OCID of the boot volume that needs to be backed up. Cannot be defined if source_details is defined.

compartmentId String

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

definedTags Map<String,Object>

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

displayName String

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

freeformTags Map<String,Object>

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

sourceDetails BootVolumeBackupSourceDetailsArgs

Details of the volume backup source in the cloud. Cannot be defined if boot_volume_id is defined.

type String

The type of backup to create. If omitted, defaults to incremental. Supported values are 'FULL' or 'INCREMENTAL'.

bootVolumeId string

The OCID of the boot volume that needs to be backed up. Cannot be defined if source_details is defined.

compartmentId string

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

definedTags {[key: string]: any}

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

displayName string

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

freeformTags {[key: string]: any}

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

sourceDetails BootVolumeBackupSourceDetailsArgs

Details of the volume backup source in the cloud. Cannot be defined if boot_volume_id is defined.

type string

The type of backup to create. If omitted, defaults to incremental. Supported values are 'FULL' or 'INCREMENTAL'.

boot_volume_id str

The OCID of the boot volume that needs to be backed up. Cannot be defined if source_details is defined.

compartment_id str

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

defined_tags Mapping[str, Any]

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

display_name str

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

freeform_tags Mapping[str, Any]

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

source_details BootVolumeBackupSourceDetailsArgs

Details of the volume backup source in the cloud. Cannot be defined if boot_volume_id is defined.

type str

The type of backup to create. If omitted, defaults to incremental. Supported values are 'FULL' or 'INCREMENTAL'.

bootVolumeId String

The OCID of the boot volume that needs to be backed up. Cannot be defined if source_details is defined.

compartmentId String

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

definedTags Map<Any>

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

displayName String

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

freeformTags Map<Any>

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

sourceDetails Property Map

Details of the volume backup source in the cloud. Cannot be defined if boot_volume_id is defined.

type String

The type of backup to create. If omitted, defaults to incremental. Supported values are 'FULL' or 'INCREMENTAL'.

Outputs

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

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.

Id string

The provider-assigned unique ID for this managed resource.

ImageId string

The image OCID used to create the boot volume the backup is taken from.

KmsKeyId string

The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.

SizeInGbs string

The size of the boot volume, in GBs.

SourceBootVolumeBackupId string

The OCID of the source boot volume backup.

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, object>

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.

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.

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.

Id string

The provider-assigned unique ID for this managed resource.

ImageId string

The image OCID used to create the boot volume the backup is taken from.

KmsKeyId string

The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.

SizeInGbs string

The size of the boot volume, in GBs.

SourceBootVolumeBackupId string

The OCID of the source boot volume backup.

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]interface{}

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.

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.

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.

id String

The provider-assigned unique ID for this managed resource.

imageId String

The image OCID used to create the boot volume the backup is taken from.

kmsKeyId String

The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.

sizeInGbs String

The size of the boot volume, in GBs.

sourceBootVolumeBackupId String

The OCID of the source boot volume backup.

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,Object>

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.

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.

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.

id string

The provider-assigned unique ID for this managed resource.

imageId string

The image OCID used to create the boot volume the backup is taken from.

kmsKeyId string

The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.

sizeInGbs string

The size of the boot volume, in GBs.

sourceBootVolumeBackupId string

The OCID of the source boot volume backup.

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]: any}

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.

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.

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.

id str

The provider-assigned unique ID for this managed resource.

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 KMS key in the destination region which will be the master encryption key for the copied volume backup.

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_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, Any]

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.

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.

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.

id String

The provider-assigned unique ID for this managed resource.

imageId String

The image OCID used to create the boot volume the backup is taken from.

kmsKeyId String

The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.

sizeInGbs String

The size of the boot volume, in GBs.

sourceBootVolumeBackupId String

The OCID of the source boot volume backup.

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

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.

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.

Look up Existing BootVolumeBackup Resource

Get an existing BootVolumeBackup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: BootVolumeBackupState, opts?: CustomResourceOptions): BootVolumeBackup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        boot_volume_id: Optional[str] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        display_name: Optional[str] = None,
        expiration_time: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        image_id: Optional[str] = None,
        kms_key_id: Optional[str] = None,
        size_in_gbs: Optional[str] = None,
        source_boot_volume_backup_id: Optional[str] = None,
        source_details: Optional[_core.BootVolumeBackupSourceDetailsArgs] = None,
        source_type: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, Any]] = None,
        time_created: Optional[str] = None,
        time_request_received: Optional[str] = None,
        type: Optional[str] = None,
        unique_size_in_gbs: Optional[str] = None) -> BootVolumeBackup
func GetBootVolumeBackup(ctx *Context, name string, id IDInput, state *BootVolumeBackupState, opts ...ResourceOption) (*BootVolumeBackup, error)
public static BootVolumeBackup Get(string name, Input<string> id, BootVolumeBackupState? state, CustomResourceOptions? opts = null)
public static BootVolumeBackup get(String name, Output<String> id, BootVolumeBackupState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
BootVolumeId string

The OCID of the boot volume that needs to be backed up. Cannot be defined if source_details is defined.

CompartmentId string

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

DefinedTags Dictionary<string, object>

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

DisplayName string

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

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, object>

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

ImageId string

The image OCID used to create the boot volume the backup is taken from.

KmsKeyId string

The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.

SizeInGbs string

The size of the boot volume, in GBs.

SourceBootVolumeBackupId string

The OCID of the source boot volume backup.

SourceDetails BootVolumeBackupSourceDetailsArgs

Details of the volume backup source in the cloud. Cannot be defined if boot_volume_id is defined.

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, object>

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 backup to create. If omitted, defaults to incremental. 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.

BootVolumeId string

The OCID of the boot volume that needs to be backed up. Cannot be defined if source_details is defined.

CompartmentId string

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

DefinedTags map[string]interface{}

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

DisplayName string

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

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]interface{}

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

ImageId string

The image OCID used to create the boot volume the backup is taken from.

KmsKeyId string

The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.

SizeInGbs string

The size of the boot volume, in GBs.

SourceBootVolumeBackupId string

The OCID of the source boot volume backup.

SourceDetails BootVolumeBackupSourceDetailsArgs

Details of the volume backup source in the cloud. Cannot be defined if boot_volume_id is defined.

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]interface{}

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 backup to create. If omitted, defaults to incremental. 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.

bootVolumeId String

The OCID of the boot volume that needs to be backed up. Cannot be defined if source_details is defined.

compartmentId String

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

definedTags Map<String,Object>

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

displayName String

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

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,Object>

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

imageId String

The image OCID used to create the boot volume the backup is taken from.

kmsKeyId String

The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.

sizeInGbs String

The size of the boot volume, in GBs.

sourceBootVolumeBackupId String

The OCID of the source boot volume backup.

sourceDetails BootVolumeBackupSourceDetailsArgs

Details of the volume backup source in the cloud. Cannot be defined if boot_volume_id is defined.

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,Object>

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 backup to create. If omitted, defaults to incremental. 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.

bootVolumeId string

The OCID of the boot volume that needs to be backed up. Cannot be defined if source_details is defined.

compartmentId string

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

definedTags {[key: string]: any}

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

displayName string

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

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]: any}

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

imageId string

The image OCID used to create the boot volume the backup is taken from.

kmsKeyId string

The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.

sizeInGbs string

The size of the boot volume, in GBs.

sourceBootVolumeBackupId string

The OCID of the source boot volume backup.

sourceDetails BootVolumeBackupSourceDetailsArgs

Details of the volume backup source in the cloud. Cannot be defined if boot_volume_id is defined.

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]: any}

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 backup to create. If omitted, defaults to incremental. 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_id str

The OCID of the boot volume that needs to be backed up. Cannot be defined if source_details is defined.

compartment_id str

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

defined_tags Mapping[str, Any]

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

display_name str

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

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, Any]

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

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 KMS key in the destination region which will be the master encryption key for the copied volume backup.

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 BootVolumeBackupSourceDetailsArgs

Details of the volume backup source in the cloud. Cannot be defined if boot_volume_id is defined.

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, Any]

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 backup to create. If omitted, defaults to incremental. 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.

bootVolumeId String

The OCID of the boot volume that needs to be backed up. Cannot be defined if source_details is defined.

compartmentId String

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

definedTags Map<Any>

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

displayName String

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

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

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

imageId String

The image OCID used to create the boot volume the backup is taken from.

kmsKeyId String

The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.

sizeInGbs String

The size of the boot volume, in GBs.

sourceBootVolumeBackupId String

The OCID of the source boot volume backup.

sourceDetails Property Map

Details of the volume backup source in the cloud. Cannot be defined if boot_volume_id is defined.

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

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 backup to create. If omitted, defaults to incremental. 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

BootVolumeBackupSourceDetails

BootVolumeBackupId string
Region string

The region of the volume backup source.

KmsKeyId string

The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.

BootVolumeBackupId string
Region string

The region of the volume backup source.

KmsKeyId string

The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.

bootVolumeBackupId String
region String

The region of the volume backup source.

kmsKeyId String

The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.

bootVolumeBackupId string
region string

The region of the volume backup source.

kmsKeyId string

The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.

boot_volume_backup_id str
region str

The region of the volume backup source.

kms_key_id str

The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.

bootVolumeBackupId String
region String

The region of the volume backup source.

kmsKeyId String

The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.

Import

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

 $ pulumi import oci:Core/bootVolumeBackup:BootVolumeBackup test_boot_volume_backup "id"

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.