oci.Core.BootVolumeBackup
Explore with Pulumi AI
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 System.Linq;
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" },
},
KmsKeyId = oci_kms_key.Test_key.Id,
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"),
},
KmsKeyId: pulumi.Any(oci_kms_key.Test_key.Id),
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"))
.kmsKeyId(oci_kms_key.test_key().id())
.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",
},
kms_key_id=oci_kms_key["test_key"]["id"],
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",
},
kmsKeyId: oci_kms_key.test_key.id,
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
kmsKeyId: ${oci_kms_key.test_key.id}
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,
kms_key_id: Optional[str] = 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:
- Boot
Volume stringId The OCID of the boot volume that needs to be backed up. Cannot be defined if
source_details
is defined.- Compartment
Id string (Updatable) The OCID of the compartment that contains the boot volume backup.
- 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"}
- Display
Name string (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- 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"}
- Kms
Key stringId The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
- Source
Details BootVolume Backup Source Details 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 stringId The OCID of the boot volume that needs to be backed up. Cannot be defined if
source_details
is defined.- Compartment
Id string (Updatable) The OCID of the compartment that contains the boot volume backup.
- 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"}
- Display
Name string (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- 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"}
- Kms
Key stringId The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
- Source
Details BootVolume Backup Source Details Args 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 StringId The OCID of the boot volume that needs to be backed up. Cannot be defined if
source_details
is defined.- compartment
Id String (Updatable) The OCID of the compartment that contains the boot volume backup.
- 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"}
- display
Name String (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- 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"}
- kms
Key StringId The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
- source
Details BootVolume Backup Source Details 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 stringId The OCID of the boot volume that needs to be backed up. Cannot be defined if
source_details
is defined.- compartment
Id string (Updatable) The OCID of the compartment that contains the boot volume backup.
- {[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"}
- display
Name string (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- {[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"}
- kms
Key stringId The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
- source
Details BootVolume Backup Source Details 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_ strid 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.
- 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.
- 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"}
- kms_
key_ strid The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
- source_
details BootVolume Backup Source Details Args 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'.
- boot
Volume StringId The OCID of the boot volume that needs to be backed up. Cannot be defined if
source_details
is defined.- compartment
Id String (Updatable) The OCID of the compartment that contains the boot volume backup.
- 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"}
- display
Name String (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- 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"}
- kms
Key StringId The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
- source
Details 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:
- Expiration
Time 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.
- Image
Id string The image OCID used to create the boot volume the backup is taken from.
- Size
In stringGbs The size of the boot volume, in GBs.
- Source
Boot stringVolume Backup Id The OCID of the source boot volume backup.
- Source
Type string Specifies whether the backup was created manually, or via scheduled backup policy.
- State string
The current state of a boot volume backup.
- Dictionary<string, object>
System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Time
Created 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.
- Time
Request stringReceived The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
- Unique
Size stringIn Gbs 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 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.
- Image
Id string The image OCID used to create the boot volume the backup is taken from.
- Size
In stringGbs The size of the boot volume, in GBs.
- Source
Boot stringVolume Backup Id The OCID of the source boot volume backup.
- Source
Type string Specifies whether the backup was created manually, or via scheduled backup policy.
- State string
The current state of a boot volume backup.
- map[string]interface{}
System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Time
Created 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.
- Time
Request stringReceived The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
- Unique
Size stringIn Gbs 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 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.
- image
Id String The image OCID used to create the boot volume the backup is taken from.
- size
In StringGbs The size of the boot volume, in GBs.
- source
Boot StringVolume Backup Id The OCID of the source boot volume backup.
- source
Type String Specifies whether the backup was created manually, or via scheduled backup policy.
- state String
The current state of a boot volume backup.
- Map<String,Object>
System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- time
Created 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.
- time
Request StringReceived The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
- unique
Size StringIn Gbs 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 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.
- image
Id string The image OCID used to create the boot volume the backup is taken from.
- size
In stringGbs The size of the boot volume, in GBs.
- source
Boot stringVolume Backup Id The OCID of the source boot volume backup.
- source
Type string Specifies whether the backup was created manually, or via scheduled backup policy.
- state string
The current state of a boot volume backup.
- {[key: string]: any}
System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- time
Created 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.
- time
Request stringReceived The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
- unique
Size stringIn Gbs 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.
- size_
in_ strgbs The size of the boot volume, in GBs.
- source_
boot_ strvolume_ backup_ id 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.
- 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_ strreceived The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
- unique_
size_ strin_ gbs 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 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.
- image
Id String The image OCID used to create the boot volume the backup is taken from.
- size
In StringGbs The size of the boot volume, in GBs.
- source
Boot StringVolume Backup Id The OCID of the source boot volume backup.
- source
Type String Specifies whether the backup was created manually, or via scheduled backup policy.
- state String
The current state of a boot volume backup.
- Map<Any>
System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- time
Created 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.
- time
Request StringReceived The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
- unique
Size StringIn Gbs 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.
- Boot
Volume stringId The OCID of the boot volume that needs to be backed up. Cannot be defined if
source_details
is defined.- Compartment
Id string (Updatable) The OCID of the compartment that contains the boot volume backup.
- 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"}
- Display
Name string (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Expiration
Time 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.
- 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"}
- Image
Id string The image OCID used to create the boot volume the backup is taken from.
- Kms
Key stringId The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
- Size
In stringGbs The size of the boot volume, in GBs.
- Source
Boot stringVolume Backup Id The OCID of the source boot volume backup.
- Source
Details BootVolume Backup Source Details Details of the volume backup source in the cloud. Cannot be defined if
boot_volume_id
is defined.- Source
Type string Specifies whether the backup was created manually, or via scheduled backup policy.
- State string
The current state of a boot volume backup.
- Dictionary<string, object>
System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Time
Created 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.
- Time
Request stringReceived 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'.
- Unique
Size stringIn Gbs 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 stringId The OCID of the boot volume that needs to be backed up. Cannot be defined if
source_details
is defined.- Compartment
Id string (Updatable) The OCID of the compartment that contains the boot volume backup.
- 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"}
- Display
Name string (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Expiration
Time 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.
- 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"}
- Image
Id string The image OCID used to create the boot volume the backup is taken from.
- Kms
Key stringId The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
- Size
In stringGbs The size of the boot volume, in GBs.
- Source
Boot stringVolume Backup Id The OCID of the source boot volume backup.
- Source
Details BootVolume Backup Source Details Args Details of the volume backup source in the cloud. Cannot be defined if
boot_volume_id
is defined.- Source
Type string Specifies whether the backup was created manually, or via scheduled backup policy.
- State string
The current state of a boot volume backup.
- map[string]interface{}
System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Time
Created 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.
- Time
Request stringReceived 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'.
- Unique
Size stringIn Gbs 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 StringId The OCID of the boot volume that needs to be backed up. Cannot be defined if
source_details
is defined.- compartment
Id String (Updatable) The OCID of the compartment that contains the boot volume backup.
- 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"}
- display
Name String (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- expiration
Time 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.
- 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"}
- image
Id String The image OCID used to create the boot volume the backup is taken from.
- kms
Key StringId The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
- size
In StringGbs The size of the boot volume, in GBs.
- source
Boot StringVolume Backup Id The OCID of the source boot volume backup.
- source
Details BootVolume Backup Source Details Details of the volume backup source in the cloud. Cannot be defined if
boot_volume_id
is defined.- source
Type String Specifies whether the backup was created manually, or via scheduled backup policy.
- state String
The current state of a boot volume backup.
- Map<String,Object>
System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- time
Created 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.
- time
Request StringReceived 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'.
- unique
Size StringIn Gbs 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 stringId The OCID of the boot volume that needs to be backed up. Cannot be defined if
source_details
is defined.- compartment
Id string (Updatable) The OCID of the compartment that contains the boot volume backup.
- {[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"}
- display
Name string (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- expiration
Time 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.
- {[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"}
- image
Id string The image OCID used to create the boot volume the backup is taken from.
- kms
Key stringId The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
- size
In stringGbs The size of the boot volume, in GBs.
- source
Boot stringVolume Backup Id The OCID of the source boot volume backup.
- source
Details BootVolume Backup Source Details Details of the volume backup source in the cloud. Cannot be defined if
boot_volume_id
is defined.- source
Type string Specifies whether the backup was created manually, or via scheduled backup policy.
- state string
The current state of a boot volume backup.
- {[key: string]: any}
System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- time
Created 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.
- time
Request stringReceived 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'.
- unique
Size stringIn Gbs 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_ strid 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.
- 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.
- 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_ strid The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
- size_
in_ strgbs The size of the boot volume, in GBs.
- source_
boot_ strvolume_ backup_ id The OCID of the source boot volume backup.
- source_
details BootVolume Backup Source Details Args 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.
- 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_ strreceived 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_ strin_ gbs 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 StringId The OCID of the boot volume that needs to be backed up. Cannot be defined if
source_details
is defined.- compartment
Id String (Updatable) The OCID of the compartment that contains the boot volume backup.
- 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"}
- display
Name String (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- expiration
Time 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.
- 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"}
- image
Id String The image OCID used to create the boot volume the backup is taken from.
- kms
Key StringId The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
- size
In StringGbs The size of the boot volume, in GBs.
- source
Boot StringVolume Backup Id The OCID of the source boot volume backup.
- source
Details Property Map Details of the volume backup source in the cloud. Cannot be defined if
boot_volume_id
is defined.- source
Type String Specifies whether the backup was created manually, or via scheduled backup policy.
- state String
The current state of a boot volume backup.
- Map<Any>
System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- time
Created 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.
- time
Request StringReceived 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'.
- unique
Size StringIn Gbs 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, BootVolumeBackupSourceDetailsArgs
- Boot
Volume stringBackup Id - Region string
The region of the volume backup source.
- Kms
Key stringId The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
- Boot
Volume stringBackup Id - Region string
The region of the volume backup source.
- Kms
Key stringId The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
- boot
Volume StringBackup Id - region String
The region of the volume backup source.
- kms
Key StringId The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
- boot
Volume stringBackup Id - region string
The region of the volume backup source.
- kms
Key stringId The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
- boot_
volume_ strbackup_ id - region str
The region of the volume backup source.
- kms_
key_ strid The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
- boot
Volume StringBackup Id - region String
The region of the volume backup source.
- kms
Key StringId 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.