Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. VolumeGroupBackup
Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-oci

oci.Core.VolumeGroupBackup

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-oci

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

Creates a new backup volume group of the specified volume group. For more information, see Volume Groups.

Example Usage

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

const testVolumeGroupBackup = new oci.core.VolumeGroupBackup("test_volume_group_backup", {
    volumeGroupId: testVolumeGroup.id,
    compartmentId: compartmentId,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    displayName: volumeGroupBackupDisplayName,
    freeformTags: {
        Department: "Finance",
    },
    type: volumeGroupBackupType,
});
Copy
import pulumi
import pulumi_oci as oci

test_volume_group_backup = oci.core.VolumeGroupBackup("test_volume_group_backup",
    volume_group_id=test_volume_group["id"],
    compartment_id=compartment_id,
    defined_tags={
        "Operations.CostCenter": "42",
    },
    display_name=volume_group_backup_display_name,
    freeform_tags={
        "Department": "Finance",
    },
    type=volume_group_backup_type)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := core.NewVolumeGroupBackup(ctx, "test_volume_group_backup", &core.VolumeGroupBackupArgs{
			VolumeGroupId: pulumi.Any(testVolumeGroup.Id),
			CompartmentId: pulumi.Any(compartmentId),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			DisplayName: pulumi.Any(volumeGroupBackupDisplayName),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			Type: pulumi.Any(volumeGroupBackupType),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testVolumeGroupBackup = new Oci.Core.VolumeGroupBackup("test_volume_group_backup", new()
    {
        VolumeGroupId = testVolumeGroup.Id,
        CompartmentId = compartmentId,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        DisplayName = volumeGroupBackupDisplayName,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        Type = volumeGroupBackupType,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.VolumeGroupBackup;
import com.pulumi.oci.Core.VolumeGroupBackupArgs;
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 testVolumeGroupBackup = new VolumeGroupBackup("testVolumeGroupBackup", VolumeGroupBackupArgs.builder()
            .volumeGroupId(testVolumeGroup.id())
            .compartmentId(compartmentId)
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .displayName(volumeGroupBackupDisplayName)
            .freeformTags(Map.of("Department", "Finance"))
            .type(volumeGroupBackupType)
            .build());

    }
}
Copy
resources:
  testVolumeGroupBackup:
    type: oci:Core:VolumeGroupBackup
    name: test_volume_group_backup
    properties:
      volumeGroupId: ${testVolumeGroup.id}
      compartmentId: ${compartmentId}
      definedTags:
        Operations.CostCenter: '42'
      displayName: ${volumeGroupBackupDisplayName}
      freeformTags:
        Department: Finance
      type: ${volumeGroupBackupType}
Copy

Create VolumeGroupBackup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new VolumeGroupBackup(name: string, args?: VolumeGroupBackupArgs, opts?: CustomResourceOptions);
@overload
def VolumeGroupBackup(resource_name: str,
                      args: Optional[VolumeGroupBackupArgs] = None,
                      opts: Optional[ResourceOptions] = None)

@overload
def VolumeGroupBackup(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,
                      source_details: Optional[_core.VolumeGroupBackupSourceDetailsArgs] = None,
                      type: Optional[str] = None,
                      volume_group_id: Optional[str] = None)
func NewVolumeGroupBackup(ctx *Context, name string, args *VolumeGroupBackupArgs, opts ...ResourceOption) (*VolumeGroupBackup, error)
public VolumeGroupBackup(string name, VolumeGroupBackupArgs? args = null, CustomResourceOptions? opts = null)
public VolumeGroupBackup(String name, VolumeGroupBackupArgs args)
public VolumeGroupBackup(String name, VolumeGroupBackupArgs args, CustomResourceOptions options)

type: oci:Core:VolumeGroupBackup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args VolumeGroupBackupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args VolumeGroupBackupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args VolumeGroupBackupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args VolumeGroupBackupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. VolumeGroupBackupArgs
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 volumeGroupBackupResource = new Oci.Core.VolumeGroupBackup("volumeGroupBackupResource", new()
{
    CompartmentId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    SourceDetails = new Oci.Core.Inputs.VolumeGroupBackupSourceDetailsArgs
    {
        Region = "string",
        VolumeGroupBackupId = "string",
        KmsKeyId = "string",
    },
    Type = "string",
    VolumeGroupId = "string",
});
Copy
example, err := Core.NewVolumeGroupBackup(ctx, "volumeGroupBackupResource", &Core.VolumeGroupBackupArgs{
	CompartmentId: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	SourceDetails: &core.VolumeGroupBackupSourceDetailsArgs{
		Region:              pulumi.String("string"),
		VolumeGroupBackupId: pulumi.String("string"),
		KmsKeyId:            pulumi.String("string"),
	},
	Type:          pulumi.String("string"),
	VolumeGroupId: pulumi.String("string"),
})
Copy
var volumeGroupBackupResource = new VolumeGroupBackup("volumeGroupBackupResource", VolumeGroupBackupArgs.builder()
    .compartmentId("string")
    .definedTags(Map.of("string", "string"))
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .sourceDetails(VolumeGroupBackupSourceDetailsArgs.builder()
        .region("string")
        .volumeGroupBackupId("string")
        .kmsKeyId("string")
        .build())
    .type("string")
    .volumeGroupId("string")
    .build());
Copy
volume_group_backup_resource = oci.core.VolumeGroupBackup("volumeGroupBackupResource",
    compartment_id="string",
    defined_tags={
        "string": "string",
    },
    display_name="string",
    freeform_tags={
        "string": "string",
    },
    source_details={
        "region": "string",
        "volume_group_backup_id": "string",
        "kms_key_id": "string",
    },
    type="string",
    volume_group_id="string")
Copy
const volumeGroupBackupResource = new oci.core.VolumeGroupBackup("volumeGroupBackupResource", {
    compartmentId: "string",
    definedTags: {
        string: "string",
    },
    displayName: "string",
    freeformTags: {
        string: "string",
    },
    sourceDetails: {
        region: "string",
        volumeGroupBackupId: "string",
        kmsKeyId: "string",
    },
    type: "string",
    volumeGroupId: "string",
});
Copy
type: oci:Core:VolumeGroupBackup
properties:
    compartmentId: string
    definedTags:
        string: string
    displayName: string
    freeformTags:
        string: string
    sourceDetails:
        kmsKeyId: string
        region: string
        volumeGroupBackupId: string
    type: string
    volumeGroupId: string
Copy

VolumeGroupBackup 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 VolumeGroupBackup resource accepts the following input properties:

CompartmentId string
(Updatable) The OCID of the compartment that will contain the volume group backup. This parameter is optional, by default backup will be created in the same compartment and source volume group.
DefinedTags 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.
FreeformTags 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"}
SourceDetails Changes to this property will trigger replacement. VolumeGroupBackupSourceDetails
Details of the volume group backup source in the cloud.
Type Changes to this property will trigger replacement. string
The type of backup to create. If omitted, defaults to incremental.

  • Allowed values are :
  • FULL
  • INCREMENTAL
VolumeGroupId Changes to this property will trigger replacement. string
The OCID of the volume group that needs to be backed up.
CompartmentId string
(Updatable) The OCID of the compartment that will contain the volume group backup. This parameter is optional, by default backup will be created in the same compartment and source volume group.
DefinedTags 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.
FreeformTags 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"}
SourceDetails Changes to this property will trigger replacement. VolumeGroupBackupSourceDetailsArgs
Details of the volume group backup source in the cloud.
Type Changes to this property will trigger replacement. string
The type of backup to create. If omitted, defaults to incremental.

  • Allowed values are :
  • FULL
  • INCREMENTAL
VolumeGroupId Changes to this property will trigger replacement. string
The OCID of the volume group that needs to be backed up.
compartmentId String
(Updatable) The OCID of the compartment that will contain the volume group backup. This parameter is optional, by default backup will be created in the same compartment and source volume group.
definedTags 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.
freeformTags 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"}
sourceDetails Changes to this property will trigger replacement. VolumeGroupBackupSourceDetails
Details of the volume group backup source in the cloud.
type Changes to this property will trigger replacement. String
The type of backup to create. If omitted, defaults to incremental.

  • Allowed values are :
  • FULL
  • INCREMENTAL
volumeGroupId Changes to this property will trigger replacement. String
The OCID of the volume group that needs to be backed up.
compartmentId string
(Updatable) The OCID of the compartment that will contain the volume group backup. This parameter is optional, by default backup will be created in the same compartment and source volume group.
definedTags {[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.
freeformTags {[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"}
sourceDetails Changes to this property will trigger replacement. VolumeGroupBackupSourceDetails
Details of the volume group backup source in the cloud.
type Changes to this property will trigger replacement. string
The type of backup to create. If omitted, defaults to incremental.

  • Allowed values are :
  • FULL
  • INCREMENTAL
volumeGroupId Changes to this property will trigger replacement. string
The OCID of the volume group that needs to be backed up.
compartment_id str
(Updatable) The OCID of the compartment that will contain the volume group backup. This parameter is optional, by default backup will be created in the same compartment and source volume group.
defined_tags 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.
freeform_tags 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"}
source_details Changes to this property will trigger replacement. core.VolumeGroupBackupSourceDetailsArgs
Details of the volume group backup source in the cloud.
type Changes to this property will trigger replacement. str
The type of backup to create. If omitted, defaults to incremental.

  • Allowed values are :
  • FULL
  • INCREMENTAL
volume_group_id Changes to this property will trigger replacement. str
The OCID of the volume group that needs to be backed up.
compartmentId String
(Updatable) The OCID of the compartment that will contain the volume group backup. This parameter is optional, by default backup will be created in the same compartment and source volume group.
definedTags 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.
freeformTags 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"}
sourceDetails Changes to this property will trigger replacement. Property Map
Details of the volume group backup source in the cloud.
type Changes to this property will trigger replacement. String
The type of backup to create. If omitted, defaults to incremental.

  • Allowed values are :
  • FULL
  • INCREMENTAL
volumeGroupId Changes to this property will trigger replacement. String
The OCID of the volume group that needs to be backed up.

Outputs

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

ExpirationTime string
The date and time the volume group backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for volume group backups that were created automatically by a scheduled-backup policy. For manually created volume group 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.
SizeInGbs string
The aggregate size of the volume group backup, in GBs.
SizeInMbs string
The aggregate size of the volume group backup, in MBs.
SourceType string
Specifies whether the volume group backup was created manually, or via scheduled backup policy.
SourceVolumeGroupBackupId string
The OCID of the source volume group backup.
State string
The current state of a volume group backup.
TimeCreated string
The date and time the volume group backup was created. This is the time the actual point-in-time image of the volume group data was taken. Format defined by RFC3339.
TimeRequestReceived string
The date and time the request to create the volume group backup was received. Format defined by RFC3339.
UniqueSizeInGbs string
The aggregate size used by the volume group backup, in GBs. It is typically smaller than size_in_gbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
UniqueSizeInMbs string
The aggregate size used by the volume group backup, in MBs. It is typically smaller than size_in_mbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
VolumeBackupIds List<string>
OCIDs for the volume backups in this volume group backup.
ExpirationTime string
The date and time the volume group backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for volume group backups that were created automatically by a scheduled-backup policy. For manually created volume group 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.
SizeInGbs string
The aggregate size of the volume group backup, in GBs.
SizeInMbs string
The aggregate size of the volume group backup, in MBs.
SourceType string
Specifies whether the volume group backup was created manually, or via scheduled backup policy.
SourceVolumeGroupBackupId string
The OCID of the source volume group backup.
State string
The current state of a volume group backup.
TimeCreated string
The date and time the volume group backup was created. This is the time the actual point-in-time image of the volume group data was taken. Format defined by RFC3339.
TimeRequestReceived string
The date and time the request to create the volume group backup was received. Format defined by RFC3339.
UniqueSizeInGbs string
The aggregate size used by the volume group backup, in GBs. It is typically smaller than size_in_gbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
UniqueSizeInMbs string
The aggregate size used by the volume group backup, in MBs. It is typically smaller than size_in_mbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
VolumeBackupIds []string
OCIDs for the volume backups in this volume group backup.
expirationTime String
The date and time the volume group backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for volume group backups that were created automatically by a scheduled-backup policy. For manually created volume group 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.
sizeInGbs String
The aggregate size of the volume group backup, in GBs.
sizeInMbs String
The aggregate size of the volume group backup, in MBs.
sourceType String
Specifies whether the volume group backup was created manually, or via scheduled backup policy.
sourceVolumeGroupBackupId String
The OCID of the source volume group backup.
state String
The current state of a volume group backup.
timeCreated String
The date and time the volume group backup was created. This is the time the actual point-in-time image of the volume group data was taken. Format defined by RFC3339.
timeRequestReceived String
The date and time the request to create the volume group backup was received. Format defined by RFC3339.
uniqueSizeInGbs String
The aggregate size used by the volume group backup, in GBs. It is typically smaller than size_in_gbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
uniqueSizeInMbs String
The aggregate size used by the volume group backup, in MBs. It is typically smaller than size_in_mbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
volumeBackupIds List<String>
OCIDs for the volume backups in this volume group backup.
expirationTime string
The date and time the volume group backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for volume group backups that were created automatically by a scheduled-backup policy. For manually created volume group 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.
sizeInGbs string
The aggregate size of the volume group backup, in GBs.
sizeInMbs string
The aggregate size of the volume group backup, in MBs.
sourceType string
Specifies whether the volume group backup was created manually, or via scheduled backup policy.
sourceVolumeGroupBackupId string
The OCID of the source volume group backup.
state string
The current state of a volume group backup.
timeCreated string
The date and time the volume group backup was created. This is the time the actual point-in-time image of the volume group data was taken. Format defined by RFC3339.
timeRequestReceived string
The date and time the request to create the volume group backup was received. Format defined by RFC3339.
uniqueSizeInGbs string
The aggregate size used by the volume group backup, in GBs. It is typically smaller than size_in_gbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
uniqueSizeInMbs string
The aggregate size used by the volume group backup, in MBs. It is typically smaller than size_in_mbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
volumeBackupIds string[]
OCIDs for the volume backups in this volume group backup.
expiration_time str
The date and time the volume group backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for volume group backups that were created automatically by a scheduled-backup policy. For manually created volume group 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_gbs str
The aggregate size of the volume group backup, in GBs.
size_in_mbs str
The aggregate size of the volume group backup, in MBs.
source_type str
Specifies whether the volume group backup was created manually, or via scheduled backup policy.
source_volume_group_backup_id str
The OCID of the source volume group backup.
state str
The current state of a volume group backup.
time_created str
The date and time the volume group backup was created. This is the time the actual point-in-time image of the volume group data was taken. Format defined by RFC3339.
time_request_received str
The date and time the request to create the volume group backup was received. Format defined by RFC3339.
unique_size_in_gbs str
The aggregate size used by the volume group backup, in GBs. It is typically smaller than size_in_gbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
unique_size_in_mbs str
The aggregate size used by the volume group backup, in MBs. It is typically smaller than size_in_mbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
volume_backup_ids Sequence[str]
OCIDs for the volume backups in this volume group backup.
expirationTime String
The date and time the volume group backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for volume group backups that were created automatically by a scheduled-backup policy. For manually created volume group 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.
sizeInGbs String
The aggregate size of the volume group backup, in GBs.
sizeInMbs String
The aggregate size of the volume group backup, in MBs.
sourceType String
Specifies whether the volume group backup was created manually, or via scheduled backup policy.
sourceVolumeGroupBackupId String
The OCID of the source volume group backup.
state String
The current state of a volume group backup.
timeCreated String
The date and time the volume group backup was created. This is the time the actual point-in-time image of the volume group data was taken. Format defined by RFC3339.
timeRequestReceived String
The date and time the request to create the volume group backup was received. Format defined by RFC3339.
uniqueSizeInGbs String
The aggregate size used by the volume group backup, in GBs. It is typically smaller than size_in_gbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
uniqueSizeInMbs String
The aggregate size used by the volume group backup, in MBs. It is typically smaller than size_in_mbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
volumeBackupIds List<String>
OCIDs for the volume backups in this volume group backup.

Look up Existing VolumeGroupBackup Resource

Get an existing VolumeGroupBackup 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?: VolumeGroupBackupState, opts?: CustomResourceOptions): VolumeGroupBackup
@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,
        size_in_gbs: Optional[str] = None,
        size_in_mbs: Optional[str] = None,
        source_details: Optional[_core.VolumeGroupBackupSourceDetailsArgs] = None,
        source_type: Optional[str] = None,
        source_volume_group_backup_id: Optional[str] = None,
        state: Optional[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_backup_ids: Optional[Sequence[str]] = None,
        volume_group_id: Optional[str] = None) -> VolumeGroupBackup
func GetVolumeGroupBackup(ctx *Context, name string, id IDInput, state *VolumeGroupBackupState, opts ...ResourceOption) (*VolumeGroupBackup, error)
public static VolumeGroupBackup Get(string name, Input<string> id, VolumeGroupBackupState? state, CustomResourceOptions? opts = null)
public static VolumeGroupBackup get(String name, Output<String> id, VolumeGroupBackupState state, CustomResourceOptions options)
resources:  _:    type: oci:Core:VolumeGroupBackup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CompartmentId string
(Updatable) The OCID of the compartment that will contain the volume group backup. This parameter is optional, by default backup will be created in the same compartment and source volume group.
DefinedTags 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 group backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for volume group backups that were created automatically by a scheduled-backup policy. For manually created volume group backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
FreeformTags Dictionary<string, string>
(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"}
SizeInGbs string
The aggregate size of the volume group backup, in GBs.
SizeInMbs string
The aggregate size of the volume group backup, in MBs.
SourceDetails Changes to this property will trigger replacement. VolumeGroupBackupSourceDetails
Details of the volume group backup source in the cloud.
SourceType string
Specifies whether the volume group backup was created manually, or via scheduled backup policy.
SourceVolumeGroupBackupId string
The OCID of the source volume group backup.
State string
The current state of a volume group backup.
TimeCreated string
The date and time the volume group backup was created. This is the time the actual point-in-time image of the volume group data was taken. Format defined by RFC3339.
TimeRequestReceived string
The date and time the request to create the volume group backup was received. Format defined by RFC3339.
Type Changes to this property will trigger replacement. string
The type of backup to create. If omitted, defaults to incremental.

  • Allowed values are :
  • FULL
  • INCREMENTAL
UniqueSizeInGbs string
The aggregate size used by the volume group backup, in GBs. It is typically smaller than size_in_gbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
UniqueSizeInMbs string
The aggregate size used by the volume group backup, in MBs. It is typically smaller than size_in_mbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
VolumeBackupIds List<string>
OCIDs for the volume backups in this volume group backup.
VolumeGroupId Changes to this property will trigger replacement. string
The OCID of the volume group that needs to be backed up.
CompartmentId string
(Updatable) The OCID of the compartment that will contain the volume group backup. This parameter is optional, by default backup will be created in the same compartment and source volume group.
DefinedTags 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 group backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for volume group backups that were created automatically by a scheduled-backup policy. For manually created volume group backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
FreeformTags map[string]string
(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"}
SizeInGbs string
The aggregate size of the volume group backup, in GBs.
SizeInMbs string
The aggregate size of the volume group backup, in MBs.
SourceDetails Changes to this property will trigger replacement. VolumeGroupBackupSourceDetailsArgs
Details of the volume group backup source in the cloud.
SourceType string
Specifies whether the volume group backup was created manually, or via scheduled backup policy.
SourceVolumeGroupBackupId string
The OCID of the source volume group backup.
State string
The current state of a volume group backup.
TimeCreated string
The date and time the volume group backup was created. This is the time the actual point-in-time image of the volume group data was taken. Format defined by RFC3339.
TimeRequestReceived string
The date and time the request to create the volume group backup was received. Format defined by RFC3339.
Type Changes to this property will trigger replacement. string
The type of backup to create. If omitted, defaults to incremental.

  • Allowed values are :
  • FULL
  • INCREMENTAL
UniqueSizeInGbs string
The aggregate size used by the volume group backup, in GBs. It is typically smaller than size_in_gbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
UniqueSizeInMbs string
The aggregate size used by the volume group backup, in MBs. It is typically smaller than size_in_mbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
VolumeBackupIds []string
OCIDs for the volume backups in this volume group backup.
VolumeGroupId Changes to this property will trigger replacement. string
The OCID of the volume group that needs to be backed up.
compartmentId String
(Updatable) The OCID of the compartment that will contain the volume group backup. This parameter is optional, by default backup will be created in the same compartment and source volume group.
definedTags 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 group backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for volume group backups that were created automatically by a scheduled-backup policy. For manually created volume group backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
freeformTags Map<String,String>
(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"}
sizeInGbs String
The aggregate size of the volume group backup, in GBs.
sizeInMbs String
The aggregate size of the volume group backup, in MBs.
sourceDetails Changes to this property will trigger replacement. VolumeGroupBackupSourceDetails
Details of the volume group backup source in the cloud.
sourceType String
Specifies whether the volume group backup was created manually, or via scheduled backup policy.
sourceVolumeGroupBackupId String
The OCID of the source volume group backup.
state String
The current state of a volume group backup.
timeCreated String
The date and time the volume group backup was created. This is the time the actual point-in-time image of the volume group data was taken. Format defined by RFC3339.
timeRequestReceived String
The date and time the request to create the volume group backup was received. Format defined by RFC3339.
type Changes to this property will trigger replacement. String
The type of backup to create. If omitted, defaults to incremental.

  • Allowed values are :
  • FULL
  • INCREMENTAL
uniqueSizeInGbs String
The aggregate size used by the volume group backup, in GBs. It is typically smaller than size_in_gbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
uniqueSizeInMbs String
The aggregate size used by the volume group backup, in MBs. It is typically smaller than size_in_mbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
volumeBackupIds List<String>
OCIDs for the volume backups in this volume group backup.
volumeGroupId Changes to this property will trigger replacement. String
The OCID of the volume group that needs to be backed up.
compartmentId string
(Updatable) The OCID of the compartment that will contain the volume group backup. This parameter is optional, by default backup will be created in the same compartment and source volume group.
definedTags {[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 group backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for volume group backups that were created automatically by a scheduled-backup policy. For manually created volume group backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
freeformTags {[key: string]: string}
(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"}
sizeInGbs string
The aggregate size of the volume group backup, in GBs.
sizeInMbs string
The aggregate size of the volume group backup, in MBs.
sourceDetails Changes to this property will trigger replacement. VolumeGroupBackupSourceDetails
Details of the volume group backup source in the cloud.
sourceType string
Specifies whether the volume group backup was created manually, or via scheduled backup policy.
sourceVolumeGroupBackupId string
The OCID of the source volume group backup.
state string
The current state of a volume group backup.
timeCreated string
The date and time the volume group backup was created. This is the time the actual point-in-time image of the volume group data was taken. Format defined by RFC3339.
timeRequestReceived string
The date and time the request to create the volume group backup was received. Format defined by RFC3339.
type Changes to this property will trigger replacement. string
The type of backup to create. If omitted, defaults to incremental.

  • Allowed values are :
  • FULL
  • INCREMENTAL
uniqueSizeInGbs string
The aggregate size used by the volume group backup, in GBs. It is typically smaller than size_in_gbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
uniqueSizeInMbs string
The aggregate size used by the volume group backup, in MBs. It is typically smaller than size_in_mbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
volumeBackupIds string[]
OCIDs for the volume backups in this volume group backup.
volumeGroupId Changes to this property will trigger replacement. string
The OCID of the volume group that needs to be backed up.
compartment_id str
(Updatable) The OCID of the compartment that will contain the volume group backup. This parameter is optional, by default backup will be created in the same compartment and source volume group.
defined_tags 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 group backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for volume group backups that were created automatically by a scheduled-backup policy. For manually created volume group backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
freeform_tags Mapping[str, str]
(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"}
size_in_gbs str
The aggregate size of the volume group backup, in GBs.
size_in_mbs str
The aggregate size of the volume group backup, in MBs.
source_details Changes to this property will trigger replacement. core.VolumeGroupBackupSourceDetailsArgs
Details of the volume group backup source in the cloud.
source_type str
Specifies whether the volume group backup was created manually, or via scheduled backup policy.
source_volume_group_backup_id str
The OCID of the source volume group backup.
state str
The current state of a volume group backup.
time_created str
The date and time the volume group backup was created. This is the time the actual point-in-time image of the volume group data was taken. Format defined by RFC3339.
time_request_received str
The date and time the request to create the volume group backup was received. Format defined by RFC3339.
type Changes to this property will trigger replacement. str
The type of backup to create. If omitted, defaults to incremental.

  • Allowed values are :
  • FULL
  • INCREMENTAL
unique_size_in_gbs str
The aggregate size used by the volume group backup, in GBs. It is typically smaller than size_in_gbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
unique_size_in_mbs str
The aggregate size used by the volume group backup, in MBs. It is typically smaller than size_in_mbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
volume_backup_ids Sequence[str]
OCIDs for the volume backups in this volume group backup.
volume_group_id Changes to this property will trigger replacement. str
The OCID of the volume group that needs to be backed up.
compartmentId String
(Updatable) The OCID of the compartment that will contain the volume group backup. This parameter is optional, by default backup will be created in the same compartment and source volume group.
definedTags 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 group backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for volume group backups that were created automatically by a scheduled-backup policy. For manually created volume group backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
freeformTags 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"}
sizeInGbs String
The aggregate size of the volume group backup, in GBs.
sizeInMbs String
The aggregate size of the volume group backup, in MBs.
sourceDetails Changes to this property will trigger replacement. Property Map
Details of the volume group backup source in the cloud.
sourceType String
Specifies whether the volume group backup was created manually, or via scheduled backup policy.
sourceVolumeGroupBackupId String
The OCID of the source volume group backup.
state String
The current state of a volume group backup.
timeCreated String
The date and time the volume group backup was created. This is the time the actual point-in-time image of the volume group data was taken. Format defined by RFC3339.
timeRequestReceived String
The date and time the request to create the volume group backup was received. Format defined by RFC3339.
type Changes to this property will trigger replacement. String
The type of backup to create. If omitted, defaults to incremental.

  • Allowed values are :
  • FULL
  • INCREMENTAL
uniqueSizeInGbs String
The aggregate size used by the volume group backup, in GBs. It is typically smaller than size_in_gbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
uniqueSizeInMbs String
The aggregate size used by the volume group backup, in MBs. It is typically smaller than size_in_mbs, depending on the space consumed on the volume group and whether the volume backup is full or incremental.
volumeBackupIds List<String>
OCIDs for the volume backups in this volume group backup.
volumeGroupId Changes to this property will trigger replacement. String
The OCID of the volume group that needs to be backed up.

Supporting Types

VolumeGroupBackupSourceDetails
, VolumeGroupBackupSourceDetailsArgs

Region
This property is required.
Changes to this property will trigger replacement.
string
The region of the volume backup source.
VolumeGroupBackupId
This property is required.
Changes to this property will trigger replacement.
string

The OCID of the source volume group 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

KmsKeyId Changes to this property will trigger replacement. string
The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
Region
This property is required.
Changes to this property will trigger replacement.
string
The region of the volume backup source.
VolumeGroupBackupId
This property is required.
Changes to this property will trigger replacement.
string

The OCID of the source volume group 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

KmsKeyId Changes to this property will trigger replacement. string
The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
region
This property is required.
Changes to this property will trigger replacement.
String
The region of the volume backup source.
volumeGroupBackupId
This property is required.
Changes to this property will trigger replacement.
String

The OCID of the source volume group 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

kmsKeyId Changes to this property will trigger replacement. String
The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
region
This property is required.
Changes to this property will trigger replacement.
string
The region of the volume backup source.
volumeGroupBackupId
This property is required.
Changes to this property will trigger replacement.
string

The OCID of the source volume group 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

kmsKeyId Changes to this property will trigger replacement. string
The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
region
This property is required.
Changes to this property will trigger replacement.
str
The region of the volume backup source.
volume_group_backup_id
This property is required.
Changes to this property will trigger replacement.
str

The OCID of the source volume group 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_id Changes to this property will trigger replacement. str
The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
region
This property is required.
Changes to this property will trigger replacement.
String
The region of the volume backup source.
volumeGroupBackupId
This property is required.
Changes to this property will trigger replacement.
String

The OCID of the source volume group 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

kmsKeyId Changes to this property will trigger replacement. String
The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.

Import

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

$ pulumi import oci:Core/volumeGroupBackup:VolumeGroupBackup test_volume_group_backup "id"
Copy

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 oci Terraform Provider.
Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-oci