1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. VolumeBackup
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

oci.Core.VolumeBackup

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

    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("testVolumeBackup", {
        volumeId: oci_core_volume.test_volume.id,
        definedTags: {
            "Operations.CostCenter": "42",
        },
        displayName: _var.volume_backup_display_name,
        freeformTags: {
            Department: "Finance",
        },
        kmsKeyId: oci_kms_key.test_key.id,
        type: _var.volume_backup_type,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_volume_backup = oci.core.VolumeBackup("testVolumeBackup",
        volume_id=oci_core_volume["test_volume"]["id"],
        defined_tags={
            "Operations.CostCenter": "42",
        },
        display_name=var["volume_backup_display_name"],
        freeform_tags={
            "Department": "Finance",
        },
        kms_key_id=oci_kms_key["test_key"]["id"],
        type=var["volume_backup_type"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/Core"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Core.NewVolumeBackup(ctx, "testVolumeBackup", &Core.VolumeBackupArgs{
    			VolumeId: pulumi.Any(oci_core_volume.Test_volume.Id),
    			DefinedTags: pulumi.Map{
    				"Operations.CostCenter": pulumi.Any("42"),
    			},
    			DisplayName: pulumi.Any(_var.Volume_backup_display_name),
    			FreeformTags: pulumi.Map{
    				"Department": pulumi.Any("Finance"),
    			},
    			KmsKeyId: pulumi.Any(oci_kms_key.Test_key.Id),
    			Type:     pulumi.Any(_var.Volume_backup_type),
    		})
    		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("testVolumeBackup", new()
        {
            VolumeId = oci_core_volume.Test_volume.Id,
            DefinedTags = 
            {
                { "Operations.CostCenter", "42" },
            },
            DisplayName = @var.Volume_backup_display_name,
            FreeformTags = 
            {
                { "Department", "Finance" },
            },
            KmsKeyId = oci_kms_key.Test_key.Id,
            Type = @var.Volume_backup_type,
        });
    
    });
    
    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(oci_core_volume.test_volume().id())
                .definedTags(Map.of("Operations.CostCenter", "42"))
                .displayName(var_.volume_backup_display_name())
                .freeformTags(Map.of("Department", "Finance"))
                .kmsKeyId(oci_kms_key.test_key().id())
                .type(var_.volume_backup_type())
                .build());
    
        }
    }
    
    resources:
      testVolumeBackup:
        type: oci:Core:VolumeBackup
        properties:
          #Required
          volumeId: ${oci_core_volume.test_volume.id}
          #Optional
          definedTags:
            Operations.CostCenter: '42'
          displayName: ${var.volume_backup_display_name}
          freeformTags:
            Department: Finance
          kmsKeyId: ${oci_kms_key.test_key.id}
          type: ${var.volume_backup_type}
    

    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, Any]] = None,
                     display_name: Optional[str] = None,
                     freeform_tags: Optional[Mapping[str, Any]] = None,
                     kms_key_id: Optional[str] = None,
                     source_details: Optional[_core.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.

    Example

    The following reference example uses placeholder values for all input properties.

    var volumeBackupResource = new Oci.Core.VolumeBackup("volumeBackupResource", new()
    {
        CompartmentId = "string",
        DefinedTags = 
        {
            { "string", "any" },
        },
        DisplayName = "string",
        FreeformTags = 
        {
            { "string", "any" },
        },
        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.Map{
    		"string": pulumi.Any("any"),
    	},
    	DisplayName: pulumi.String("string"),
    	FreeformTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	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", "any"))
        .displayName("string")
        .freeformTags(Map.of("string", "any"))
        .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": "any",
        },
        display_name="string",
        freeform_tags={
            "string": "any",
        },
        kms_key_id="string",
        source_details=oci.core.VolumeBackupSourceDetailsArgs(
            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: "any",
        },
        displayName: "string",
        freeformTags: {
            string: "any",
        },
        kmsKeyId: "string",
        sourceDetails: {
            region: "string",
            volumeBackupId: "string",
            kmsKeyId: "string",
        },
        type: "string",
        volumeId: "string",
    });
    
    type: oci:Core:VolumeBackup
    properties:
        compartmentId: string
        definedTags:
            string: any
        displayName: string
        freeformTags:
            string: any
        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

    The VolumeBackup resource accepts the following input properties:

    CompartmentId string
    (Updatable) The OCID of the compartment that contains the volume backup.
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags Dictionary<string, object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    KmsKeyId string
    The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
    SourceDetails VolumeBackupSourceDetails
    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_id or source_details is required to be set.
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the volume backup.
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags map[string]interface{}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    KmsKeyId string
    The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
    SourceDetails VolumeBackupSourceDetailsArgs
    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_id or source_details is required to be set.
    compartmentId String
    (Updatable) The OCID of the compartment that contains the volume backup.
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String,Object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    kmsKeyId String
    The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
    sourceDetails VolumeBackupSourceDetails
    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_id or source_details is required to be set.
    compartmentId string
    (Updatable) The OCID of the compartment that contains the volume backup.
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags {[key: string]: any}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    kmsKeyId string
    The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
    sourceDetails VolumeBackupSourceDetails
    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_id or source_details is required to be set.
    compartment_id str
    (Updatable) The OCID of the compartment that contains the volume backup.
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeform_tags Mapping[str, Any]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    kms_key_id str
    The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
    source_details core.VolumeBackupSourceDetailsArgs
    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_id or source_details is required to be set.
    compartmentId String
    (Updatable) The OCID of the compartment that contains the volume backup.
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<Any>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    kmsKeyId String
    The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
    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_id or source_details is 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.
    SizeInGbs string
    The size of the volume, in GBs.
    SizeInMbs string
    The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.

    Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.

    SourceType string
    Specifies whether the backup was created manually, or via scheduled backup policy.
    SourceVolumeBackupId string
    The OCID of the source volume backup.
    State string
    The current state of a volume backup.
    SystemTags Dictionary<string, object>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    TimeCreated string
    The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    TimeRequestReceived string
    The date and time the request to create the volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/rfc3339.
    UniqueSizeInGbs string
    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.
    UniqueSizeInMbs string
    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.

    Deprecated: The 'unique_size_in_mbs' field has been deprecated. Please use 'unique_size_in_gbs' instead.

    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.
    SizeInGbs string
    The size of the volume, in GBs.
    SizeInMbs string
    The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.

    Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.

    SourceType string
    Specifies whether the backup was created manually, or via scheduled backup policy.
    SourceVolumeBackupId string
    The OCID of the source volume backup.
    State string
    The current state of a volume backup.
    SystemTags map[string]interface{}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    TimeCreated string
    The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    TimeRequestReceived string
    The date and time the request to create the volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/rfc3339.
    UniqueSizeInGbs string
    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.
    UniqueSizeInMbs string
    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.

    Deprecated: The 'unique_size_in_mbs' field has been deprecated. Please use 'unique_size_in_gbs' instead.

    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.
    sizeInGbs String
    The size of the volume, in GBs.
    sizeInMbs String
    The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.

    Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.

    sourceType String
    Specifies whether the backup was created manually, or via scheduled backup policy.
    sourceVolumeBackupId String
    The OCID of the source volume backup.
    state String
    The current state of a volume backup.
    systemTags Map<String,Object>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    timeCreated String
    The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    timeRequestReceived String
    The date and time the request to create the volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/rfc3339.
    uniqueSizeInGbs String
    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.
    uniqueSizeInMbs String
    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.

    Deprecated: The 'unique_size_in_mbs' field has been deprecated. Please use 'unique_size_in_gbs' instead.

    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.
    sizeInGbs string
    The size of the volume, in GBs.
    sizeInMbs string
    The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.

    Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.

    sourceType string
    Specifies whether the backup was created manually, or via scheduled backup policy.
    sourceVolumeBackupId string
    The OCID of the source volume backup.
    state string
    The current state of a volume backup.
    systemTags {[key: string]: any}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    timeCreated string
    The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    timeRequestReceived string
    The date and time the request to create the volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/rfc3339.
    uniqueSizeInGbs string
    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.
    uniqueSizeInMbs string
    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.

    Deprecated: The 'unique_size_in_mbs' field has been deprecated. Please use 'unique_size_in_gbs' instead.

    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_gbs str
    The size of the volume, in GBs.
    size_in_mbs str
    The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.

    Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.

    source_type str
    Specifies whether the backup was created manually, or via scheduled backup policy.
    source_volume_backup_id str
    The OCID of the source volume backup.
    state str
    The current state of a volume backup.
    system_tags Mapping[str, Any]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    time_created str
    The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    time_request_received str
    The date and time the request to create the volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/rfc3339.
    unique_size_in_gbs str
    The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the volume and whether the backup is full or incremental.
    unique_size_in_mbs str
    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.

    Deprecated: The 'unique_size_in_mbs' field has been deprecated. Please use 'unique_size_in_gbs' instead.

    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.
    sizeInGbs String
    The size of the volume, in GBs.
    sizeInMbs String
    The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.

    Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.

    sourceType String
    Specifies whether the backup was created manually, or via scheduled backup policy.
    sourceVolumeBackupId String
    The OCID of the source volume backup.
    state String
    The current state of a volume backup.
    systemTags Map<Any>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    timeCreated String
    The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    timeRequestReceived String
    The date and time the request to create the volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/rfc3339.
    uniqueSizeInGbs String
    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.
    uniqueSizeInMbs String
    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.

    Deprecated: The 'unique_size_in_mbs' field has been deprecated. Please use 'unique_size_in_gbs' instead.

    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, Any]] = None,
            display_name: Optional[str] = None,
            expiration_time: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            kms_key_id: Optional[str] = None,
            size_in_gbs: Optional[str] = None,
            size_in_mbs: Optional[str] = None,
            source_details: Optional[_core.VolumeBackupSourceDetailsArgs] = None,
            source_type: Optional[str] = None,
            source_volume_backup_id: Optional[str] = None,
            state: Optional[str] = None,
            system_tags: Optional[Mapping[str, Any]] = None,
            time_created: Optional[str] = None,
            time_request_received: Optional[str] = None,
            type: Optional[str] = None,
            unique_size_in_gbs: Optional[str] = None,
            unique_size_in_mbs: Optional[str] = None,
            volume_id: Optional[str] = None) -> VolumeBackup
    func 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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the volume backup.
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    ExpirationTime string
    The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
    FreeformTags Dictionary<string, object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    KmsKeyId string
    The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
    SizeInGbs string
    The size of the volume, in GBs.
    SizeInMbs string
    The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.

    Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.

    SourceDetails VolumeBackupSourceDetails
    Details of the volume backup source in the cloud.
    SourceType string
    Specifies whether the backup was created manually, or via scheduled backup policy.
    SourceVolumeBackupId string
    The OCID of the source volume backup.
    State string
    The current state of a volume backup.
    SystemTags Dictionary<string, object>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    TimeCreated string
    The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    TimeRequestReceived string
    The date and time the request to create the 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'.
    UniqueSizeInGbs string
    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.
    UniqueSizeInMbs string
    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.

    Deprecated: The 'unique_size_in_mbs' field has been deprecated. Please use 'unique_size_in_gbs' instead.

    VolumeId string
    The OCID of the volume that needs to be backed up.**Note: To create the resource either volume_id or source_details is required to be set.
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the volume backup.
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    ExpirationTime string
    The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
    FreeformTags map[string]interface{}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    KmsKeyId string
    The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
    SizeInGbs string
    The size of the volume, in GBs.
    SizeInMbs string
    The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.

    Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.

    SourceDetails VolumeBackupSourceDetailsArgs
    Details of the volume backup source in the cloud.
    SourceType string
    Specifies whether the backup was created manually, or via scheduled backup policy.
    SourceVolumeBackupId string
    The OCID of the source volume backup.
    State string
    The current state of a volume backup.
    SystemTags map[string]interface{}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    TimeCreated string
    The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    TimeRequestReceived string
    The date and time the request to create the 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'.
    UniqueSizeInGbs string
    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.
    UniqueSizeInMbs string
    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.

    Deprecated: The 'unique_size_in_mbs' field has been deprecated. Please use 'unique_size_in_gbs' instead.

    VolumeId string
    The OCID of the volume that needs to be backed up.**Note: To create the resource either volume_id or source_details is required to be set.
    compartmentId String
    (Updatable) The OCID of the compartment that contains the volume backup.
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    expirationTime String
    The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
    freeformTags Map<String,Object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    kmsKeyId String
    The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
    sizeInGbs String
    The size of the volume, in GBs.
    sizeInMbs String
    The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.

    Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.

    sourceDetails VolumeBackupSourceDetails
    Details of the volume backup source in the cloud.
    sourceType String
    Specifies whether the backup was created manually, or via scheduled backup policy.
    sourceVolumeBackupId String
    The OCID of the source volume backup.
    state String
    The current state of a volume backup.
    systemTags Map<String,Object>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    timeCreated String
    The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    timeRequestReceived String
    The date and time the request to create the 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'.
    uniqueSizeInGbs String
    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.
    uniqueSizeInMbs String
    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.

    Deprecated: The 'unique_size_in_mbs' field has been deprecated. Please use 'unique_size_in_gbs' instead.

    volumeId String
    The OCID of the volume that needs to be backed up.**Note: To create the resource either volume_id or source_details is required to be set.
    compartmentId string
    (Updatable) The OCID of the compartment that contains the volume backup.
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    expirationTime string
    The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
    freeformTags {[key: string]: any}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    kmsKeyId string
    The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
    sizeInGbs string
    The size of the volume, in GBs.
    sizeInMbs string
    The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.

    Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.

    sourceDetails VolumeBackupSourceDetails
    Details of the volume backup source in the cloud.
    sourceType string
    Specifies whether the backup was created manually, or via scheduled backup policy.
    sourceVolumeBackupId string
    The OCID of the source volume backup.
    state string
    The current state of a volume backup.
    systemTags {[key: string]: any}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    timeCreated string
    The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    timeRequestReceived string
    The date and time the request to create the 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'.
    uniqueSizeInGbs string
    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.
    uniqueSizeInMbs string
    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.

    Deprecated: The 'unique_size_in_mbs' field has been deprecated. Please use 'unique_size_in_gbs' instead.

    volumeId string
    The OCID of the volume that needs to be backed up.**Note: To create the resource either volume_id or source_details is required to be set.
    compartment_id str
    (Updatable) The OCID of the compartment that contains the volume backup.
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    expiration_time str
    The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
    freeform_tags Mapping[str, Any]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    kms_key_id str
    The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
    size_in_gbs str
    The size of the volume, in GBs.
    size_in_mbs str
    The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.

    Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.

    source_details core.VolumeBackupSourceDetailsArgs
    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_backup_id str
    The OCID of the source volume backup.
    state str
    The current state of a volume backup.
    system_tags Mapping[str, Any]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    time_created str
    The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    time_request_received str
    The date and time the request to create the 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_in_gbs str
    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_in_mbs str
    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.

    Deprecated: The 'unique_size_in_mbs' field has been deprecated. Please use 'unique_size_in_gbs' instead.

    volume_id str
    The OCID of the volume that needs to be backed up.**Note: To create the resource either volume_id or source_details is required to be set.
    compartmentId String
    (Updatable) The OCID of the compartment that contains the volume backup.
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    expirationTime String
    The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
    freeformTags Map<Any>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    kmsKeyId String
    The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
    sizeInGbs String
    The size of the volume, in GBs.
    sizeInMbs String
    The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use size_in_gbs.

    Deprecated: The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead.

    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.
    sourceVolumeBackupId String
    The OCID of the source volume backup.
    state String
    The current state of a volume backup.
    systemTags Map<Any>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    timeCreated String
    The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    timeRequestReceived String
    The date and time the request to create the 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'.
    uniqueSizeInGbs String
    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.
    uniqueSizeInMbs String
    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.

    Deprecated: The 'unique_size_in_mbs' field has been deprecated. Please use 'unique_size_in_gbs' instead.

    volumeId String
    The OCID of the volume that needs to be backed up.**Note: To create the resource either volume_id or source_details is required to be set.

    Supporting Types

    VolumeBackupSourceDetails, VolumeBackupSourceDetailsArgs

    Region string
    The region of the volume backup source.
    VolumeBackupId string

    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

    KmsKeyId string
    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.
    VolumeBackupId string

    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

    KmsKeyId string
    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.
    volumeBackupId String

    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

    kmsKeyId String
    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.
    volumeBackupId string

    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

    kmsKeyId string
    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_id str

    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_id str
    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.
    volumeBackupId String

    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

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

    Import

    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 oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi