oci.Core.VolumeBackup
This resource provides the Volume Backup resource in Oracle Cloud Infrastructure Core service.
Creates a new backup of the specified volume. For general information about volume backups, see Overview of Block Volume Service 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
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testVolumeBackup = new oci.core.VolumeBackup("test_volume_backup", {
    volumeId: testVolume.id,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    displayName: volumeBackupDisplayName,
    freeformTags: {
        Department: "Finance",
    },
    kmsKeyId: testKey.id,
    type: volumeBackupType,
});
import pulumi
import pulumi_oci as oci
test_volume_backup = oci.core.VolumeBackup("test_volume_backup",
    volume_id=test_volume["id"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    display_name=volume_backup_display_name,
    freeform_tags={
        "Department": "Finance",
    },
    kms_key_id=test_key["id"],
    type=volume_backup_type)
package main
import (
	"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := core.NewVolumeBackup(ctx, "test_volume_backup", &core.VolumeBackupArgs{
			VolumeId: pulumi.Any(testVolume.Id),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			DisplayName: pulumi.Any(volumeBackupDisplayName),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			KmsKeyId: pulumi.Any(testKey.Id),
			Type:     pulumi.Any(volumeBackupType),
		})
		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 testVolumeBackup = new Oci.Core.VolumeBackup("test_volume_backup", new()
    {
        VolumeId = testVolume.Id,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        DisplayName = volumeBackupDisplayName,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        KmsKeyId = testKey.Id,
        Type = volumeBackupType,
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.VolumeBackup;
import com.pulumi.oci.Core.VolumeBackupArgs;
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 testVolumeBackup = new VolumeBackup("testVolumeBackup", VolumeBackupArgs.builder()
            .volumeId(testVolume.id())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .displayName(volumeBackupDisplayName)
            .freeformTags(Map.of("Department", "Finance"))
            .kmsKeyId(testKey.id())
            .type(volumeBackupType)
            .build());
    }
}
resources:
  testVolumeBackup:
    type: oci:Core:VolumeBackup
    name: test_volume_backup
    properties:
      volumeId: ${testVolume.id}
      definedTags:
        Operations.CostCenter: '42'
      displayName: ${volumeBackupDisplayName}
      freeformTags:
        Department: Finance
      kmsKeyId: ${testKey.id}
      type: ${volumeBackupType}
Create VolumeBackup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new VolumeBackup(name: string, args?: VolumeBackupArgs, opts?: CustomResourceOptions);@overload
def VolumeBackup(resource_name: str,
                 args: Optional[VolumeBackupArgs] = None,
                 opts: Optional[ResourceOptions] = None)
@overload
def VolumeBackup(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 compartment_id: Optional[str] = None,
                 defined_tags: Optional[Mapping[str, str]] = None,
                 display_name: Optional[str] = None,
                 freeform_tags: Optional[Mapping[str, str]] = None,
                 kms_key_id: Optional[str] = None,
                 source_details: Optional[VolumeBackupSourceDetailsArgs] = None,
                 type: Optional[str] = None,
                 volume_id: Optional[str] = None)func NewVolumeBackup(ctx *Context, name string, args *VolumeBackupArgs, opts ...ResourceOption) (*VolumeBackup, error)public VolumeBackup(string name, VolumeBackupArgs? args = null, CustomResourceOptions? opts = null)
public VolumeBackup(String name, VolumeBackupArgs args)
public VolumeBackup(String name, VolumeBackupArgs args, CustomResourceOptions options)
type: oci:Core:VolumeBackup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args VolumeBackupArgs
- 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 VolumeBackupArgs
- 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 VolumeBackupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args VolumeBackupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args VolumeBackupArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var volumeBackupResource = new Oci.Core.VolumeBackup("volumeBackupResource", new()
{
    CompartmentId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    KmsKeyId = "string",
    SourceDetails = new Oci.Core.Inputs.VolumeBackupSourceDetailsArgs
    {
        Region = "string",
        VolumeBackupId = "string",
        KmsKeyId = "string",
    },
    Type = "string",
    VolumeId = "string",
});
example, err := core.NewVolumeBackup(ctx, "volumeBackupResource", &core.VolumeBackupArgs{
	CompartmentId: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	KmsKeyId: pulumi.String("string"),
	SourceDetails: &core.VolumeBackupSourceDetailsArgs{
		Region:         pulumi.String("string"),
		VolumeBackupId: pulumi.String("string"),
		KmsKeyId:       pulumi.String("string"),
	},
	Type:     pulumi.String("string"),
	VolumeId: pulumi.String("string"),
})
var volumeBackupResource = new VolumeBackup("volumeBackupResource", VolumeBackupArgs.builder()
    .compartmentId("string")
    .definedTags(Map.of("string", "string"))
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .kmsKeyId("string")
    .sourceDetails(VolumeBackupSourceDetailsArgs.builder()
        .region("string")
        .volumeBackupId("string")
        .kmsKeyId("string")
        .build())
    .type("string")
    .volumeId("string")
    .build());
volume_backup_resource = oci.core.VolumeBackup("volumeBackupResource",
    compartment_id="string",
    defined_tags={
        "string": "string",
    },
    display_name="string",
    freeform_tags={
        "string": "string",
    },
    kms_key_id="string",
    source_details={
        "region": "string",
        "volume_backup_id": "string",
        "kms_key_id": "string",
    },
    type="string",
    volume_id="string")
const volumeBackupResource = new oci.core.VolumeBackup("volumeBackupResource", {
    compartmentId: "string",
    definedTags: {
        string: "string",
    },
    displayName: "string",
    freeformTags: {
        string: "string",
    },
    kmsKeyId: "string",
    sourceDetails: {
        region: "string",
        volumeBackupId: "string",
        kmsKeyId: "string",
    },
    type: "string",
    volumeId: "string",
});
type: oci:Core:VolumeBackup
properties:
    compartmentId: string
    definedTags:
        string: string
    displayName: string
    freeformTags:
        string: string
    kmsKeyId: string
    sourceDetails:
        kmsKeyId: string
        region: string
        volumeBackupId: string
    type: string
    volumeId: string
VolumeBackup Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The VolumeBackup resource accepts the following input properties:
- CompartmentId string
- (Updatable) The OCID of the compartment that contains the volume backup.
- Dictionary<string, string>
- (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.
- Dictionary<string, string>
- (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"}
- KmsKey stringId 
- (Updatable) The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
- SourceDetails VolumeBackup Source Details 
- Details of the volume backup source in the cloud.
- Type string
- The type of backup to create. If omitted, defaults to INCREMENTAL. Supported values are 'FULL' or 'INCREMENTAL'.
- VolumeId string
- The OCID of the volume that needs to be backed up.**Note: To create the resource either volume_idorsource_detailsis required to be set.
- CompartmentId string
- (Updatable) The OCID of the compartment that contains the volume backup.
- map[string]string
- (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.
- map[string]string
- (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"}
- KmsKey stringId 
- (Updatable) The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
- SourceDetails VolumeBackup Source Details Args 
- Details of the volume backup source in the cloud.
- Type string
- The type of backup to create. If omitted, defaults to INCREMENTAL. Supported values are 'FULL' or 'INCREMENTAL'.
- VolumeId string
- The OCID of the volume that needs to be backed up.**Note: To create the resource either volume_idorsource_detailsis required to be set.
- compartmentId String
- (Updatable) The OCID of the compartment that contains the volume backup.
- Map<String,String>
- (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.
- Map<String,String>
- (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"}
- kmsKey StringId 
- (Updatable) The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
- sourceDetails VolumeBackup Source Details 
- Details of the volume backup source in the cloud.
- type String
- The type of backup to create. If omitted, defaults to INCREMENTAL. Supported values are 'FULL' or 'INCREMENTAL'.
- volumeId String
- The OCID of the volume that needs to be backed up.**Note: To create the resource either volume_idorsource_detailsis required to be set.
- compartmentId string
- (Updatable) The OCID of the compartment that contains the volume backup.
- {[key: string]: string}
- (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.
- {[key: string]: string}
- (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"}
- kmsKey stringId 
- (Updatable) The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
- sourceDetails VolumeBackup Source Details 
- Details of the volume backup source in the cloud.
- type string
- The type of backup to create. If omitted, defaults to INCREMENTAL. Supported values are 'FULL' or 'INCREMENTAL'.
- volumeId string
- The OCID of the volume that needs to be backed up.**Note: To create the resource either volume_idorsource_detailsis required to be set.
- compartment_id str
- (Updatable) The OCID of the compartment that contains the volume backup.
- Mapping[str, str]
- (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, str]
- (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 
- (Updatable) The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
- source_details VolumeBackup Source Details Args 
- Details of the volume backup source in the cloud.
- type str
- The type of backup to create. If omitted, defaults to INCREMENTAL. Supported values are 'FULL' or 'INCREMENTAL'.
- volume_id str
- The OCID of the volume that needs to be backed up.**Note: To create the resource either volume_idorsource_detailsis required to be set.
- compartmentId String
- (Updatable) The OCID of the compartment that contains the volume backup.
- Map<String>
- (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.
- Map<String>
- (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"}
- kmsKey StringId 
- (Updatable) The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
- sourceDetails Property Map
- Details of the volume backup source in the cloud.
- type String
- The type of backup to create. If omitted, defaults to INCREMENTAL. Supported values are 'FULL' or 'INCREMENTAL'.
- volumeId String
- The OCID of the volume that needs to be backed up.**Note: To create the resource either volume_idorsource_detailsis required to be set.
Outputs
All input properties are implicitly available as output properties. Additionally, the VolumeBackup 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.
- SizeIn stringGbs 
- The size of the volume, in GBs.
- SizeIn stringMbs 
- The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.
- SourceType string
- Specifies whether the backup was created manually, or via scheduled backup policy.
- SourceVolume stringBackup Id 
- The OCID of the source volume backup.
- State string
- The current state of a volume backup.
- Dictionary<string, string>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- TimeCreated string
- The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
- TimeRequest stringReceived 
- The date and time the request to create the volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/rfc3339.
- UniqueSize stringIn Gbs 
- The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the volume and whether the backup is full or incremental.
- UniqueSize stringIn Mbs 
- The size used by the backup, in MBs. It is typically smaller than sizeInMBs, depending on the space consumed on the volume and whether the backup is full or incremental. This field is deprecated. Please use uniqueSizeInGBs.
- 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.
- SizeIn stringGbs 
- The size of the volume, in GBs.
- SizeIn stringMbs 
- The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.
- SourceType string
- Specifies whether the backup was created manually, or via scheduled backup policy.
- SourceVolume stringBackup Id 
- The OCID of the source volume backup.
- State string
- The current state of a volume backup.
- map[string]string
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- TimeCreated string
- The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
- TimeRequest stringReceived 
- The date and time the request to create the volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/rfc3339.
- UniqueSize stringIn Gbs 
- The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the volume and whether the backup is full or incremental.
- UniqueSize stringIn Mbs 
- The size used by the backup, in MBs. It is typically smaller than sizeInMBs, depending on the space consumed on the volume and whether the backup is full or incremental. This field is deprecated. Please use uniqueSizeInGBs.
- 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.
- sizeIn StringGbs 
- The size of the volume, in GBs.
- sizeIn StringMbs 
- The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.
- sourceType String
- Specifies whether the backup was created manually, or via scheduled backup policy.
- sourceVolume StringBackup Id 
- The OCID of the source volume backup.
- state String
- The current state of a volume backup.
- Map<String,String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- timeCreated String
- The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
- timeRequest StringReceived 
- The date and time the request to create the volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/rfc3339.
- uniqueSize StringIn Gbs 
- The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the volume and whether the backup is full or incremental.
- uniqueSize StringIn Mbs 
- The size used by the backup, in MBs. It is typically smaller than sizeInMBs, depending on the space consumed on the volume and whether the backup is full or incremental. This field is deprecated. Please use uniqueSizeInGBs.
- 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.
- sizeIn stringGbs 
- The size of the volume, in GBs.
- sizeIn stringMbs 
- The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.
- sourceType string
- Specifies whether the backup was created manually, or via scheduled backup policy.
- sourceVolume stringBackup Id 
- The OCID of the source volume backup.
- state string
- The current state of a volume backup.
- {[key: string]: string}
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- timeCreated string
- The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
- timeRequest stringReceived 
- The date and time the request to create the volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/rfc3339.
- uniqueSize stringIn Gbs 
- The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the volume and whether the backup is full or incremental.
- uniqueSize stringIn Mbs 
- The size used by the backup, in MBs. It is typically smaller than sizeInMBs, depending on the space consumed on the volume and whether the backup is full or incremental. This field is deprecated. Please use uniqueSizeInGBs.
- 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.
- size_in_ strgbs 
- The size of the volume, in GBs.
- size_in_ strmbs 
- The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.
- source_type str
- Specifies whether the backup was created manually, or via scheduled backup policy.
- source_volume_ strbackup_ id 
- The OCID of the source volume backup.
- state str
- The current state of a volume backup.
- Mapping[str, str]
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- time_created str
- The date and time the volume 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 volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/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 volume and whether the backup is full or incremental.
- unique_size_ strin_ mbs 
- The size used by the backup, in MBs. It is typically smaller than sizeInMBs, depending on the space consumed on the volume and whether the backup is full or incremental. This field is deprecated. Please use uniqueSizeInGBs.
- 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.
- sizeIn StringGbs 
- The size of the volume, in GBs.
- sizeIn StringMbs 
- The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.
- sourceType String
- Specifies whether the backup was created manually, or via scheduled backup policy.
- sourceVolume StringBackup Id 
- The OCID of the source volume backup.
- state String
- The current state of a volume backup.
- Map<String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- timeCreated String
- The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
- timeRequest StringReceived 
- The date and time the request to create the volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/rfc3339.
- uniqueSize StringIn Gbs 
- The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the volume and whether the backup is full or incremental.
- uniqueSize StringIn Mbs 
- The size used by the backup, in MBs. It is typically smaller than sizeInMBs, depending on the space consumed on the volume and whether the backup is full or incremental. This field is deprecated. Please use uniqueSizeInGBs.
Look up Existing VolumeBackup Resource
Get an existing VolumeBackup 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?: VolumeBackupState, opts?: CustomResourceOptions): VolumeBackup@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        expiration_time: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        kms_key_id: Optional[str] = None,
        size_in_gbs: Optional[str] = None,
        size_in_mbs: Optional[str] = None,
        source_details: Optional[VolumeBackupSourceDetailsArgs] = None,
        source_type: Optional[str] = None,
        source_volume_backup_id: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_request_received: Optional[str] = None,
        type: Optional[str] = None,
        unique_size_in_gbs: Optional[str] = None,
        unique_size_in_mbs: Optional[str] = None,
        volume_id: Optional[str] = None) -> VolumeBackupfunc GetVolumeBackup(ctx *Context, name string, id IDInput, state *VolumeBackupState, opts ...ResourceOption) (*VolumeBackup, error)public static VolumeBackup Get(string name, Input<string> id, VolumeBackupState? state, CustomResourceOptions? opts = null)public static VolumeBackup get(String name, Output<String> id, VolumeBackupState state, CustomResourceOptions options)resources:  _:    type: oci:Core:VolumeBackup    get:      id: ${id}- 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.
- CompartmentId string
- (Updatable) The OCID of the compartment that contains the volume backup.
- Dictionary<string, string>
- (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.
- Dictionary<string, string>
- (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"}
- KmsKey stringId 
- (Updatable) The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
- SizeIn stringGbs 
- The size of the volume, in GBs.
- SizeIn stringMbs 
- The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.
- SourceDetails VolumeBackup Source Details 
- Details of the volume backup source in the cloud.
- SourceType string
- Specifies whether the backup was created manually, or via scheduled backup policy.
- SourceVolume stringBackup Id 
- The OCID of the source volume backup.
- State string
- The current state of a volume backup.
- Dictionary<string, string>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- TimeCreated string
- The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
- TimeRequest stringReceived 
- The date and time the request to create the volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/rfc3339.
- Type string
- The type of backup to create. If omitted, defaults to INCREMENTAL. Supported values are 'FULL' or 'INCREMENTAL'.
- UniqueSize stringIn Gbs 
- The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the volume and whether the backup is full or incremental.
- UniqueSize stringIn Mbs 
- The size used by the backup, in MBs. It is typically smaller than sizeInMBs, depending on the space consumed on the volume and whether the backup is full or incremental. This field is deprecated. Please use uniqueSizeInGBs.
- VolumeId string
- The OCID of the volume that needs to be backed up.**Note: To create the resource either volume_idorsource_detailsis required to be set.
- CompartmentId string
- (Updatable) The OCID of the compartment that contains the volume backup.
- map[string]string
- (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.
- map[string]string
- (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"}
- KmsKey stringId 
- (Updatable) The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
- SizeIn stringGbs 
- The size of the volume, in GBs.
- SizeIn stringMbs 
- The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.
- SourceDetails VolumeBackup Source Details Args 
- Details of the volume backup source in the cloud.
- SourceType string
- Specifies whether the backup was created manually, or via scheduled backup policy.
- SourceVolume stringBackup Id 
- The OCID of the source volume backup.
- State string
- The current state of a volume backup.
- map[string]string
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- TimeCreated string
- The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
- TimeRequest stringReceived 
- The date and time the request to create the volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/rfc3339.
- Type string
- The type of backup to create. If omitted, defaults to INCREMENTAL. Supported values are 'FULL' or 'INCREMENTAL'.
- UniqueSize stringIn Gbs 
- The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the volume and whether the backup is full or incremental.
- UniqueSize stringIn Mbs 
- The size used by the backup, in MBs. It is typically smaller than sizeInMBs, depending on the space consumed on the volume and whether the backup is full or incremental. This field is deprecated. Please use uniqueSizeInGBs.
- VolumeId string
- The OCID of the volume that needs to be backed up.**Note: To create the resource either volume_idorsource_detailsis required to be set.
- compartmentId String
- (Updatable) The OCID of the compartment that contains the volume backup.
- Map<String,String>
- (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.
- Map<String,String>
- (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"}
- kmsKey StringId 
- (Updatable) The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
- sizeIn StringGbs 
- The size of the volume, in GBs.
- sizeIn StringMbs 
- The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.
- sourceDetails VolumeBackup Source Details 
- Details of the volume backup source in the cloud.
- sourceType String
- Specifies whether the backup was created manually, or via scheduled backup policy.
- sourceVolume StringBackup Id 
- The OCID of the source volume backup.
- state String
- The current state of a volume backup.
- Map<String,String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- timeCreated String
- The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
- timeRequest StringReceived 
- The date and time the request to create the volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/rfc3339.
- type String
- The type of backup to create. If omitted, defaults to INCREMENTAL. Supported values are 'FULL' or 'INCREMENTAL'.
- uniqueSize StringIn Gbs 
- The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the volume and whether the backup is full or incremental.
- uniqueSize StringIn Mbs 
- The size used by the backup, in MBs. It is typically smaller than sizeInMBs, depending on the space consumed on the volume and whether the backup is full or incremental. This field is deprecated. Please use uniqueSizeInGBs.
- volumeId String
- The OCID of the volume that needs to be backed up.**Note: To create the resource either volume_idorsource_detailsis required to be set.
- compartmentId string
- (Updatable) The OCID of the compartment that contains the volume backup.
- {[key: string]: string}
- (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.
- {[key: string]: string}
- (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"}
- kmsKey stringId 
- (Updatable) The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
- sizeIn stringGbs 
- The size of the volume, in GBs.
- sizeIn stringMbs 
- The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.
- sourceDetails VolumeBackup Source Details 
- Details of the volume backup source in the cloud.
- sourceType string
- Specifies whether the backup was created manually, or via scheduled backup policy.
- sourceVolume stringBackup Id 
- The OCID of the source volume backup.
- state string
- The current state of a volume backup.
- {[key: string]: string}
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- timeCreated string
- The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
- timeRequest stringReceived 
- The date and time the request to create the volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/rfc3339.
- type string
- The type of backup to create. If omitted, defaults to INCREMENTAL. Supported values are 'FULL' or 'INCREMENTAL'.
- uniqueSize stringIn Gbs 
- The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the volume and whether the backup is full or incremental.
- uniqueSize stringIn Mbs 
- The size used by the backup, in MBs. It is typically smaller than sizeInMBs, depending on the space consumed on the volume and whether the backup is full or incremental. This field is deprecated. Please use uniqueSizeInGBs.
- volumeId string
- The OCID of the volume that needs to be backed up.**Note: To create the resource either volume_idorsource_detailsis required to be set.
- compartment_id str
- (Updatable) The OCID of the compartment that contains the volume backup.
- Mapping[str, str]
- (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, str]
- (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 
- (Updatable) The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
- size_in_ strgbs 
- The size of the volume, in GBs.
- size_in_ strmbs 
- The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.
- source_details VolumeBackup Source Details Args 
- Details of the volume backup source in the cloud.
- source_type str
- Specifies whether the backup was created manually, or via scheduled backup policy.
- source_volume_ strbackup_ id 
- The OCID of the source volume backup.
- state str
- The current state of a volume backup.
- Mapping[str, str]
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- time_created str
- The date and time the volume 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 volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/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 volume and whether the backup is full or incremental.
- unique_size_ strin_ mbs 
- The size used by the backup, in MBs. It is typically smaller than sizeInMBs, depending on the space consumed on the volume and whether the backup is full or incremental. This field is deprecated. Please use uniqueSizeInGBs.
- volume_id str
- The OCID of the volume that needs to be backed up.**Note: To create the resource either volume_idorsource_detailsis required to be set.
- compartmentId String
- (Updatable) The OCID of the compartment that contains the volume backup.
- Map<String>
- (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.
- Map<String>
- (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"}
- kmsKey StringId 
- (Updatable) The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
- sizeIn StringGbs 
- The size of the volume, in GBs.
- sizeIn StringMbs 
- The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.
- sourceDetails Property Map
- Details of the volume backup source in the cloud.
- sourceType String
- Specifies whether the backup was created manually, or via scheduled backup policy.
- sourceVolume StringBackup Id 
- The OCID of the source volume backup.
- state String
- The current state of a volume backup.
- Map<String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- timeCreated String
- The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
- timeRequest StringReceived 
- The date and time the request to create the volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/rfc3339.
- type String
- The type of backup to create. If omitted, defaults to INCREMENTAL. Supported values are 'FULL' or 'INCREMENTAL'.
- uniqueSize StringIn Gbs 
- The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the volume and whether the backup is full or incremental.
- uniqueSize StringIn Mbs 
- The size used by the backup, in MBs. It is typically smaller than sizeInMBs, depending on the space consumed on the volume and whether the backup is full or incremental. This field is deprecated. Please use uniqueSizeInGBs.
- volumeId String
- The OCID of the volume that needs to be backed up.**Note: To create the resource either volume_idorsource_detailsis required to be set.
Supporting Types
VolumeBackupSourceDetails, VolumeBackupSourceDetailsArgs        
- Region string
- The region of the volume backup source.
- VolumeBackup stringId 
- The OCID of the source volume backup. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- KmsKey stringId 
- The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
- Region string
- The region of the volume backup source.
- VolumeBackup stringId 
- The OCID of the source volume backup. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- KmsKey stringId 
- The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
- region String
- The region of the volume backup source.
- volumeBackup StringId 
- The OCID of the source volume backup. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- kmsKey StringId 
- The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
- region string
- The region of the volume backup source.
- volumeBackup stringId 
- The OCID of the source volume backup. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- kmsKey stringId 
- The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
- region str
- The region of the volume backup source.
- volume_backup_ strid 
- The OCID of the source volume backup. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- 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.
- region String
- The region of the volume backup source.
- volumeBackup StringId 
- The OCID of the source volume backup. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- kmsKey StringId 
- The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
Import
VolumeBackups can be imported using the id, e.g.
$ pulumi import oci:Core/volumeBackup:VolumeBackup test_volume_backup "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the ociTerraform Provider.
