1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. BootVolumeBackup
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

oci.Core.BootVolumeBackup

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

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

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

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testBootVolumeBackup = new oci.core.BootVolumeBackup("test_boot_volume_backup", {
        bootVolumeId: testBootVolume.id,
        definedTags: {
            "Operations.CostCenter": "42",
        },
        displayName: bootVolumeBackupDisplayName,
        freeformTags: {
            Department: "Finance",
        },
        kmsKeyId: testKey.id,
        type: bootVolumeBackupType,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_boot_volume_backup = oci.core.BootVolumeBackup("test_boot_volume_backup",
        boot_volume_id=test_boot_volume["id"],
        defined_tags={
            "Operations.CostCenter": "42",
        },
        display_name=boot_volume_backup_display_name,
        freeform_tags={
            "Department": "Finance",
        },
        kms_key_id=test_key["id"],
        type=boot_volume_backup_type)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/Core"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Core.NewBootVolumeBackup(ctx, "test_boot_volume_backup", &Core.BootVolumeBackupArgs{
    			BootVolumeId: pulumi.Any(testBootVolume.Id),
    			DefinedTags: pulumi.Map{
    				"Operations.CostCenter": pulumi.Any("42"),
    			},
    			DisplayName: pulumi.Any(bootVolumeBackupDisplayName),
    			FreeformTags: pulumi.Map{
    				"Department": pulumi.Any("Finance"),
    			},
    			KmsKeyId: pulumi.Any(testKey.Id),
    			Type:     pulumi.Any(bootVolumeBackupType),
    		})
    		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 testBootVolumeBackup = new Oci.Core.BootVolumeBackup("test_boot_volume_backup", new()
        {
            BootVolumeId = testBootVolume.Id,
            DefinedTags = 
            {
                { "Operations.CostCenter", "42" },
            },
            DisplayName = bootVolumeBackupDisplayName,
            FreeformTags = 
            {
                { "Department", "Finance" },
            },
            KmsKeyId = testKey.Id,
            Type = bootVolumeBackupType,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Core.BootVolumeBackup;
    import com.pulumi.oci.Core.BootVolumeBackupArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var testBootVolumeBackup = new BootVolumeBackup("testBootVolumeBackup", BootVolumeBackupArgs.builder()
                .bootVolumeId(testBootVolume.id())
                .definedTags(Map.of("Operations.CostCenter", "42"))
                .displayName(bootVolumeBackupDisplayName)
                .freeformTags(Map.of("Department", "Finance"))
                .kmsKeyId(testKey.id())
                .type(bootVolumeBackupType)
                .build());
    
        }
    }
    
    resources:
      testBootVolumeBackup:
        type: oci:Core:BootVolumeBackup
        name: test_boot_volume_backup
        properties:
          bootVolumeId: ${testBootVolume.id}
          definedTags:
            Operations.CostCenter: '42'
          displayName: ${bootVolumeBackupDisplayName}
          freeformTags:
            Department: Finance
          kmsKeyId: ${testKey.id}
          type: ${bootVolumeBackupType}
    

    Create BootVolumeBackup Resource

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

    Constructor syntax

    new BootVolumeBackup(name: string, args?: BootVolumeBackupArgs, opts?: CustomResourceOptions);
    @overload
    def BootVolumeBackup(resource_name: str,
                         args: Optional[BootVolumeBackupArgs] = None,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def BootVolumeBackup(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         boot_volume_id: Optional[str] = None,
                         compartment_id: Optional[str] = None,
                         defined_tags: Optional[Mapping[str, Any]] = None,
                         display_name: Optional[str] = None,
                         freeform_tags: Optional[Mapping[str, Any]] = None,
                         kms_key_id: Optional[str] = None,
                         source_details: Optional[_core.BootVolumeBackupSourceDetailsArgs] = None,
                         type: Optional[str] = None)
    func NewBootVolumeBackup(ctx *Context, name string, args *BootVolumeBackupArgs, opts ...ResourceOption) (*BootVolumeBackup, error)
    public BootVolumeBackup(string name, BootVolumeBackupArgs? args = null, CustomResourceOptions? opts = null)
    public BootVolumeBackup(String name, BootVolumeBackupArgs args)
    public BootVolumeBackup(String name, BootVolumeBackupArgs args, CustomResourceOptions options)
    
    type: oci:Core:BootVolumeBackup
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Example

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

    var bootVolumeBackupResource = new Oci.Core.BootVolumeBackup("bootVolumeBackupResource", new()
    {
        BootVolumeId = "string",
        CompartmentId = "string",
        DefinedTags = 
        {
            { "string", "any" },
        },
        DisplayName = "string",
        FreeformTags = 
        {
            { "string", "any" },
        },
        KmsKeyId = "string",
        SourceDetails = new Oci.Core.Inputs.BootVolumeBackupSourceDetailsArgs
        {
            BootVolumeBackupId = "string",
            Region = "string",
            KmsKeyId = "string",
        },
        Type = "string",
    });
    
    example, err := Core.NewBootVolumeBackup(ctx, "bootVolumeBackupResource", &Core.BootVolumeBackupArgs{
    	BootVolumeId:  pulumi.String("string"),
    	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.BootVolumeBackupSourceDetailsArgs{
    		BootVolumeBackupId: pulumi.String("string"),
    		Region:             pulumi.String("string"),
    		KmsKeyId:           pulumi.String("string"),
    	},
    	Type: pulumi.String("string"),
    })
    
    var bootVolumeBackupResource = new BootVolumeBackup("bootVolumeBackupResource", BootVolumeBackupArgs.builder()
        .bootVolumeId("string")
        .compartmentId("string")
        .definedTags(Map.of("string", "any"))
        .displayName("string")
        .freeformTags(Map.of("string", "any"))
        .kmsKeyId("string")
        .sourceDetails(BootVolumeBackupSourceDetailsArgs.builder()
            .bootVolumeBackupId("string")
            .region("string")
            .kmsKeyId("string")
            .build())
        .type("string")
        .build());
    
    boot_volume_backup_resource = oci.core.BootVolumeBackup("bootVolumeBackupResource",
        boot_volume_id="string",
        compartment_id="string",
        defined_tags={
            "string": "any",
        },
        display_name="string",
        freeform_tags={
            "string": "any",
        },
        kms_key_id="string",
        source_details=oci.core.BootVolumeBackupSourceDetailsArgs(
            boot_volume_backup_id="string",
            region="string",
            kms_key_id="string",
        ),
        type="string")
    
    const bootVolumeBackupResource = new oci.core.BootVolumeBackup("bootVolumeBackupResource", {
        bootVolumeId: "string",
        compartmentId: "string",
        definedTags: {
            string: "any",
        },
        displayName: "string",
        freeformTags: {
            string: "any",
        },
        kmsKeyId: "string",
        sourceDetails: {
            bootVolumeBackupId: "string",
            region: "string",
            kmsKeyId: "string",
        },
        type: "string",
    });
    
    type: oci:Core:BootVolumeBackup
    properties:
        bootVolumeId: string
        compartmentId: string
        definedTags:
            string: any
        displayName: string
        freeformTags:
            string: any
        kmsKeyId: string
        sourceDetails:
            bootVolumeBackupId: string
            kmsKeyId: string
            region: string
        type: string
    

    BootVolumeBackup Resource Properties

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

    Inputs

    The BootVolumeBackup resource accepts the following input properties:

    BootVolumeId string
    The OCID of the boot volume that needs to be backed up. Cannot be defined if source_details is defined.
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the boot volume backup.
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags Dictionary<string, object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    KmsKeyId string
    (Updatable) The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    SourceDetails BootVolumeBackupSourceDetails
    Details of the volume backup source in the cloud. Cannot be defined if boot_volume_id is defined.
    Type string
    The type of backup to create. If omitted, defaults to incremental. Supported values are 'FULL' or 'INCREMENTAL'.
    BootVolumeId string
    The OCID of the boot volume that needs to be backed up. Cannot be defined if source_details is defined.
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the boot volume backup.
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags map[string]interface{}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    KmsKeyId string
    (Updatable) The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    SourceDetails BootVolumeBackupSourceDetailsArgs
    Details of the volume backup source in the cloud. Cannot be defined if boot_volume_id is defined.
    Type string
    The type of backup to create. If omitted, defaults to incremental. Supported values are 'FULL' or 'INCREMENTAL'.
    bootVolumeId String
    The OCID of the boot volume that needs to be backed up. Cannot be defined if source_details is defined.
    compartmentId String
    (Updatable) The OCID of the compartment that contains the boot volume backup.
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String,Object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    kmsKeyId String
    (Updatable) The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    sourceDetails BootVolumeBackupSourceDetails
    Details of the volume backup source in the cloud. Cannot be defined if boot_volume_id is defined.
    type String
    The type of backup to create. If omitted, defaults to incremental. Supported values are 'FULL' or 'INCREMENTAL'.
    bootVolumeId string
    The OCID of the boot volume that needs to be backed up. Cannot be defined if source_details is defined.
    compartmentId string
    (Updatable) The OCID of the compartment that contains the boot volume backup.
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags {[key: string]: any}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    kmsKeyId string
    (Updatable) The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    sourceDetails BootVolumeBackupSourceDetails
    Details of the volume backup source in the cloud. Cannot be defined if boot_volume_id is defined.
    type string
    The type of backup to create. If omitted, defaults to incremental. Supported values are 'FULL' or 'INCREMENTAL'.
    boot_volume_id str
    The OCID of the boot volume that needs to be backed up. Cannot be defined if source_details is defined.
    compartment_id str
    (Updatable) The OCID of the compartment that contains the boot volume backup.
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeform_tags Mapping[str, Any]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    kms_key_id str
    (Updatable) The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    source_details core.BootVolumeBackupSourceDetailsArgs
    Details of the volume backup source in the cloud. Cannot be defined if boot_volume_id is defined.
    type str
    The type of backup to create. If omitted, defaults to incremental. Supported values are 'FULL' or 'INCREMENTAL'.
    bootVolumeId String
    The OCID of the boot volume that needs to be backed up. Cannot be defined if source_details is defined.
    compartmentId String
    (Updatable) The OCID of the compartment that contains the boot volume backup.
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<Any>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    kmsKeyId String
    (Updatable) The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    sourceDetails Property Map
    Details of the volume backup source in the cloud. Cannot be defined if boot_volume_id is defined.
    type String
    The type of backup to create. If omitted, defaults to incremental. Supported values are 'FULL' or 'INCREMENTAL'.

    Outputs

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

    ExpirationTime string
    The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageId string
    The image OCID used to create the boot volume the backup is taken from.
    SizeInGbs string
    The size of the boot volume, in GBs.
    SourceBootVolumeBackupId string
    The OCID of the source boot volume backup.
    SourceType string
    Specifies whether the backup was created manually, or via scheduled backup policy.
    State string
    The current state of a boot volume backup.
    SystemTags Dictionary<string, object>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    TimeCreated string
    The date and time the boot volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    TimeRequestReceived string
    The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
    UniqueSizeInGbs string
    The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.
    ExpirationTime string
    The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageId string
    The image OCID used to create the boot volume the backup is taken from.
    SizeInGbs string
    The size of the boot volume, in GBs.
    SourceBootVolumeBackupId string
    The OCID of the source boot volume backup.
    SourceType string
    Specifies whether the backup was created manually, or via scheduled backup policy.
    State string
    The current state of a boot volume backup.
    SystemTags map[string]interface{}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    TimeCreated string
    The date and time the boot volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    TimeRequestReceived string
    The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
    UniqueSizeInGbs string
    The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.
    expirationTime String
    The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
    id String
    The provider-assigned unique ID for this managed resource.
    imageId String
    The image OCID used to create the boot volume the backup is taken from.
    sizeInGbs String
    The size of the boot volume, in GBs.
    sourceBootVolumeBackupId String
    The OCID of the source boot volume backup.
    sourceType String
    Specifies whether the backup was created manually, or via scheduled backup policy.
    state String
    The current state of a boot volume backup.
    systemTags Map<String,Object>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    timeCreated String
    The date and time the boot volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    timeRequestReceived String
    The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
    uniqueSizeInGbs String
    The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.
    expirationTime string
    The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
    id string
    The provider-assigned unique ID for this managed resource.
    imageId string
    The image OCID used to create the boot volume the backup is taken from.
    sizeInGbs string
    The size of the boot volume, in GBs.
    sourceBootVolumeBackupId string
    The OCID of the source boot volume backup.
    sourceType string
    Specifies whether the backup was created manually, or via scheduled backup policy.
    state string
    The current state of a boot volume backup.
    systemTags {[key: string]: any}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    timeCreated string
    The date and time the boot volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    timeRequestReceived string
    The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
    uniqueSizeInGbs string
    The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.
    expiration_time str
    The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
    id str
    The provider-assigned unique ID for this managed resource.
    image_id str
    The image OCID used to create the boot volume the backup is taken from.
    size_in_gbs str
    The size of the boot volume, in GBs.
    source_boot_volume_backup_id str
    The OCID of the source boot volume backup.
    source_type str
    Specifies whether the backup was created manually, or via scheduled backup policy.
    state str
    The current state of a boot volume backup.
    system_tags Mapping[str, Any]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    time_created str
    The date and time the boot volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    time_request_received str
    The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
    unique_size_in_gbs str
    The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.
    expirationTime String
    The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
    id String
    The provider-assigned unique ID for this managed resource.
    imageId String
    The image OCID used to create the boot volume the backup is taken from.
    sizeInGbs String
    The size of the boot volume, in GBs.
    sourceBootVolumeBackupId String
    The OCID of the source boot volume backup.
    sourceType String
    Specifies whether the backup was created manually, or via scheduled backup policy.
    state String
    The current state of a boot volume backup.
    systemTags Map<Any>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    timeCreated String
    The date and time the boot volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    timeRequestReceived String
    The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
    uniqueSizeInGbs String
    The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.

    Look up Existing BootVolumeBackup Resource

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

    public static get(name: string, id: Input<ID>, state?: BootVolumeBackupState, opts?: CustomResourceOptions): BootVolumeBackup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            boot_volume_id: Optional[str] = None,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, Any]] = None,
            display_name: Optional[str] = None,
            expiration_time: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            image_id: Optional[str] = None,
            kms_key_id: Optional[str] = None,
            size_in_gbs: Optional[str] = None,
            source_boot_volume_backup_id: Optional[str] = None,
            source_details: Optional[_core.BootVolumeBackupSourceDetailsArgs] = None,
            source_type: Optional[str] = None,
            state: Optional[str] = None,
            system_tags: Optional[Mapping[str, Any]] = None,
            time_created: Optional[str] = None,
            time_request_received: Optional[str] = None,
            type: Optional[str] = None,
            unique_size_in_gbs: Optional[str] = None) -> BootVolumeBackup
    func GetBootVolumeBackup(ctx *Context, name string, id IDInput, state *BootVolumeBackupState, opts ...ResourceOption) (*BootVolumeBackup, error)
    public static BootVolumeBackup Get(string name, Input<string> id, BootVolumeBackupState? state, CustomResourceOptions? opts = null)
    public static BootVolumeBackup get(String name, Output<String> id, BootVolumeBackupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    BootVolumeId string
    The OCID of the boot volume that needs to be backed up. Cannot be defined if source_details is defined.
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the boot volume backup.
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    ExpirationTime string
    The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
    FreeformTags Dictionary<string, object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    ImageId string
    The image OCID used to create the boot volume the backup is taken from.
    KmsKeyId string
    (Updatable) The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    SizeInGbs string
    The size of the boot volume, in GBs.
    SourceBootVolumeBackupId string
    The OCID of the source boot volume backup.
    SourceDetails BootVolumeBackupSourceDetails
    Details of the volume backup source in the cloud. Cannot be defined if boot_volume_id is defined.
    SourceType string
    Specifies whether the backup was created manually, or via scheduled backup policy.
    State string
    The current state of a boot volume backup.
    SystemTags Dictionary<string, object>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    TimeCreated string
    The date and time the boot volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    TimeRequestReceived string
    The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
    Type string
    The type of backup to create. If omitted, defaults to incremental. Supported values are 'FULL' or 'INCREMENTAL'.
    UniqueSizeInGbs string
    The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.
    BootVolumeId string
    The OCID of the boot volume that needs to be backed up. Cannot be defined if source_details is defined.
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the boot volume backup.
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    ExpirationTime string
    The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
    FreeformTags map[string]interface{}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    ImageId string
    The image OCID used to create the boot volume the backup is taken from.
    KmsKeyId string
    (Updatable) The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    SizeInGbs string
    The size of the boot volume, in GBs.
    SourceBootVolumeBackupId string
    The OCID of the source boot volume backup.
    SourceDetails BootVolumeBackupSourceDetailsArgs
    Details of the volume backup source in the cloud. Cannot be defined if boot_volume_id is defined.
    SourceType string
    Specifies whether the backup was created manually, or via scheduled backup policy.
    State string
    The current state of a boot volume backup.
    SystemTags map[string]interface{}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    TimeCreated string
    The date and time the boot volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    TimeRequestReceived string
    The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
    Type string
    The type of backup to create. If omitted, defaults to incremental. Supported values are 'FULL' or 'INCREMENTAL'.
    UniqueSizeInGbs string
    The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.
    bootVolumeId String
    The OCID of the boot volume that needs to be backed up. Cannot be defined if source_details is defined.
    compartmentId String
    (Updatable) The OCID of the compartment that contains the boot volume backup.
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    expirationTime String
    The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
    freeformTags Map<String,Object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    imageId String
    The image OCID used to create the boot volume the backup is taken from.
    kmsKeyId String
    (Updatable) The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    sizeInGbs String
    The size of the boot volume, in GBs.
    sourceBootVolumeBackupId String
    The OCID of the source boot volume backup.
    sourceDetails BootVolumeBackupSourceDetails
    Details of the volume backup source in the cloud. Cannot be defined if boot_volume_id is defined.
    sourceType String
    Specifies whether the backup was created manually, or via scheduled backup policy.
    state String
    The current state of a boot volume backup.
    systemTags Map<String,Object>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    timeCreated String
    The date and time the boot volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    timeRequestReceived String
    The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
    type String
    The type of backup to create. If omitted, defaults to incremental. Supported values are 'FULL' or 'INCREMENTAL'.
    uniqueSizeInGbs String
    The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.
    bootVolumeId string
    The OCID of the boot volume that needs to be backed up. Cannot be defined if source_details is defined.
    compartmentId string
    (Updatable) The OCID of the compartment that contains the boot volume backup.
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    expirationTime string
    The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
    freeformTags {[key: string]: any}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    imageId string
    The image OCID used to create the boot volume the backup is taken from.
    kmsKeyId string
    (Updatable) The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    sizeInGbs string
    The size of the boot volume, in GBs.
    sourceBootVolumeBackupId string
    The OCID of the source boot volume backup.
    sourceDetails BootVolumeBackupSourceDetails
    Details of the volume backup source in the cloud. Cannot be defined if boot_volume_id is defined.
    sourceType string
    Specifies whether the backup was created manually, or via scheduled backup policy.
    state string
    The current state of a boot volume backup.
    systemTags {[key: string]: any}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    timeCreated string
    The date and time the boot volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    timeRequestReceived string
    The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
    type string
    The type of backup to create. If omitted, defaults to incremental. Supported values are 'FULL' or 'INCREMENTAL'.
    uniqueSizeInGbs string
    The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.
    boot_volume_id str
    The OCID of the boot volume that needs to be backed up. Cannot be defined if source_details is defined.
    compartment_id str
    (Updatable) The OCID of the compartment that contains the boot volume backup.
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    expiration_time str
    The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
    freeform_tags Mapping[str, Any]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    image_id str
    The image OCID used to create the boot volume the backup is taken from.
    kms_key_id str
    (Updatable) The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    size_in_gbs str
    The size of the boot volume, in GBs.
    source_boot_volume_backup_id str
    The OCID of the source boot volume backup.
    source_details core.BootVolumeBackupSourceDetailsArgs
    Details of the volume backup source in the cloud. Cannot be defined if boot_volume_id is defined.
    source_type str
    Specifies whether the backup was created manually, or via scheduled backup policy.
    state str
    The current state of a boot volume backup.
    system_tags Mapping[str, Any]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    time_created str
    The date and time the boot volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    time_request_received str
    The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
    type str
    The type of backup to create. If omitted, defaults to incremental. Supported values are 'FULL' or 'INCREMENTAL'.
    unique_size_in_gbs str
    The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.
    bootVolumeId String
    The OCID of the boot volume that needs to be backed up. Cannot be defined if source_details is defined.
    compartmentId String
    (Updatable) The OCID of the compartment that contains the boot volume backup.
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    expirationTime String
    The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
    freeformTags Map<Any>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    imageId String
    The image OCID used to create the boot volume the backup is taken from.
    kmsKeyId String
    (Updatable) The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
    sizeInGbs String
    The size of the boot volume, in GBs.
    sourceBootVolumeBackupId String
    The OCID of the source boot volume backup.
    sourceDetails Property Map
    Details of the volume backup source in the cloud. Cannot be defined if boot_volume_id is defined.
    sourceType String
    Specifies whether the backup was created manually, or via scheduled backup policy.
    state String
    The current state of a boot volume backup.
    systemTags Map<Any>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    timeCreated String
    The date and time the boot volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
    timeRequestReceived String
    The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
    type String
    The type of backup to create. If omitted, defaults to incremental. Supported values are 'FULL' or 'INCREMENTAL'.
    uniqueSizeInGbs String
    The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.

    Supporting Types

    BootVolumeBackupSourceDetails, BootVolumeBackupSourceDetailsArgs

    BootVolumeBackupId string
    Region string
    The region of the volume backup source.
    KmsKeyId string
    The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
    BootVolumeBackupId string
    Region string
    The region of the volume backup source.
    KmsKeyId string
    The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
    bootVolumeBackupId String
    region String
    The region of the volume backup source.
    kmsKeyId String
    The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
    bootVolumeBackupId string
    region string
    The region of the volume backup source.
    kmsKeyId string
    The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
    boot_volume_backup_id str
    region str
    The region of the volume backup source.
    kms_key_id str
    The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.
    bootVolumeBackupId String
    region String
    The region of the volume backup source.
    kmsKeyId String
    The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.

    Import

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

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

    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.41.0 published on Wednesday, Jun 19, 2024 by Pulumi