1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Database
  5. AutonomousDatabaseBackup
Oracle Cloud Infrastructure v2.19.0 published on Thursday, Dec 12, 2024 by Pulumi

oci.Database.AutonomousDatabaseBackup

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.19.0 published on Thursday, Dec 12, 2024 by Pulumi

    This resource provides the Autonomous Database Backup resource in Oracle Cloud Infrastructure Database service.

    Creates a new Autonomous Database backup for the specified database based on the provided request parameters.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testAutonomousDatabaseBackup = new oci.database.AutonomousDatabaseBackup("test_autonomous_database_backup", {
        autonomousDatabaseId: testAutonomousDatabase.id,
        displayName: autonomousDatabaseBackupDisplayName,
        isLongTermBackup: autonomousDatabaseBackupIsLongTermBackup,
        retentionPeriodInDays: autonomousDatabaseBackupRetentionPeriodInDays,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_autonomous_database_backup = oci.database.AutonomousDatabaseBackup("test_autonomous_database_backup",
        autonomous_database_id=test_autonomous_database["id"],
        display_name=autonomous_database_backup_display_name,
        is_long_term_backup=autonomous_database_backup_is_long_term_backup,
        retention_period_in_days=autonomous_database_backup_retention_period_in_days)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Database"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Database.NewAutonomousDatabaseBackup(ctx, "test_autonomous_database_backup", &Database.AutonomousDatabaseBackupArgs{
    			AutonomousDatabaseId:  pulumi.Any(testAutonomousDatabase.Id),
    			DisplayName:           pulumi.Any(autonomousDatabaseBackupDisplayName),
    			IsLongTermBackup:      pulumi.Any(autonomousDatabaseBackupIsLongTermBackup),
    			RetentionPeriodInDays: pulumi.Any(autonomousDatabaseBackupRetentionPeriodInDays),
    		})
    		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 testAutonomousDatabaseBackup = new Oci.Database.AutonomousDatabaseBackup("test_autonomous_database_backup", new()
        {
            AutonomousDatabaseId = testAutonomousDatabase.Id,
            DisplayName = autonomousDatabaseBackupDisplayName,
            IsLongTermBackup = autonomousDatabaseBackupIsLongTermBackup,
            RetentionPeriodInDays = autonomousDatabaseBackupRetentionPeriodInDays,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Database.AutonomousDatabaseBackup;
    import com.pulumi.oci.Database.AutonomousDatabaseBackupArgs;
    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 testAutonomousDatabaseBackup = new AutonomousDatabaseBackup("testAutonomousDatabaseBackup", AutonomousDatabaseBackupArgs.builder()
                .autonomousDatabaseId(testAutonomousDatabase.id())
                .displayName(autonomousDatabaseBackupDisplayName)
                .isLongTermBackup(autonomousDatabaseBackupIsLongTermBackup)
                .retentionPeriodInDays(autonomousDatabaseBackupRetentionPeriodInDays)
                .build());
    
        }
    }
    
    resources:
      testAutonomousDatabaseBackup:
        type: oci:Database:AutonomousDatabaseBackup
        name: test_autonomous_database_backup
        properties:
          autonomousDatabaseId: ${testAutonomousDatabase.id}
          displayName: ${autonomousDatabaseBackupDisplayName}
          isLongTermBackup: ${autonomousDatabaseBackupIsLongTermBackup}
          retentionPeriodInDays: ${autonomousDatabaseBackupRetentionPeriodInDays}
    

    Create AutonomousDatabaseBackup Resource

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

    Constructor syntax

    new AutonomousDatabaseBackup(name: string, args: AutonomousDatabaseBackupArgs, opts?: CustomResourceOptions);
    @overload
    def AutonomousDatabaseBackup(resource_name: str,
                                 args: AutonomousDatabaseBackupArgs,
                                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def AutonomousDatabaseBackup(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 autonomous_database_id: Optional[str] = None,
                                 backup_destination_details: Optional[_database.AutonomousDatabaseBackupBackupDestinationDetailsArgs] = None,
                                 display_name: Optional[str] = None,
                                 is_long_term_backup: Optional[bool] = None,
                                 retention_period_in_days: Optional[int] = None)
    func NewAutonomousDatabaseBackup(ctx *Context, name string, args AutonomousDatabaseBackupArgs, opts ...ResourceOption) (*AutonomousDatabaseBackup, error)
    public AutonomousDatabaseBackup(string name, AutonomousDatabaseBackupArgs args, CustomResourceOptions? opts = null)
    public AutonomousDatabaseBackup(String name, AutonomousDatabaseBackupArgs args)
    public AutonomousDatabaseBackup(String name, AutonomousDatabaseBackupArgs args, CustomResourceOptions options)
    
    type: oci:Database:AutonomousDatabaseBackup
    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 AutonomousDatabaseBackupArgs
    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 AutonomousDatabaseBackupArgs
    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 AutonomousDatabaseBackupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AutonomousDatabaseBackupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AutonomousDatabaseBackupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var autonomousDatabaseBackupResource = new Oci.Database.AutonomousDatabaseBackup("autonomousDatabaseBackupResource", new()
    {
        AutonomousDatabaseId = "string",
        BackupDestinationDetails = new Oci.Database.Inputs.AutonomousDatabaseBackupBackupDestinationDetailsArgs
        {
            Type = "string",
            Id = "string",
            InternetProxy = "string",
            VpcPassword = "string",
            VpcUser = "string",
        },
        DisplayName = "string",
        IsLongTermBackup = false,
        RetentionPeriodInDays = 0,
    });
    
    example, err := Database.NewAutonomousDatabaseBackup(ctx, "autonomousDatabaseBackupResource", &Database.AutonomousDatabaseBackupArgs{
    	AutonomousDatabaseId: pulumi.String("string"),
    	BackupDestinationDetails: &database.AutonomousDatabaseBackupBackupDestinationDetailsArgs{
    		Type:          pulumi.String("string"),
    		Id:            pulumi.String("string"),
    		InternetProxy: pulumi.String("string"),
    		VpcPassword:   pulumi.String("string"),
    		VpcUser:       pulumi.String("string"),
    	},
    	DisplayName:           pulumi.String("string"),
    	IsLongTermBackup:      pulumi.Bool(false),
    	RetentionPeriodInDays: pulumi.Int(0),
    })
    
    var autonomousDatabaseBackupResource = new AutonomousDatabaseBackup("autonomousDatabaseBackupResource", AutonomousDatabaseBackupArgs.builder()
        .autonomousDatabaseId("string")
        .backupDestinationDetails(AutonomousDatabaseBackupBackupDestinationDetailsArgs.builder()
            .type("string")
            .id("string")
            .internetProxy("string")
            .vpcPassword("string")
            .vpcUser("string")
            .build())
        .displayName("string")
        .isLongTermBackup(false)
        .retentionPeriodInDays(0)
        .build());
    
    autonomous_database_backup_resource = oci.database.AutonomousDatabaseBackup("autonomousDatabaseBackupResource",
        autonomous_database_id="string",
        backup_destination_details={
            "type": "string",
            "id": "string",
            "internet_proxy": "string",
            "vpc_password": "string",
            "vpc_user": "string",
        },
        display_name="string",
        is_long_term_backup=False,
        retention_period_in_days=0)
    
    const autonomousDatabaseBackupResource = new oci.database.AutonomousDatabaseBackup("autonomousDatabaseBackupResource", {
        autonomousDatabaseId: "string",
        backupDestinationDetails: {
            type: "string",
            id: "string",
            internetProxy: "string",
            vpcPassword: "string",
            vpcUser: "string",
        },
        displayName: "string",
        isLongTermBackup: false,
        retentionPeriodInDays: 0,
    });
    
    type: oci:Database:AutonomousDatabaseBackup
    properties:
        autonomousDatabaseId: string
        backupDestinationDetails:
            id: string
            internetProxy: string
            type: string
            vpcPassword: string
            vpcUser: string
        displayName: string
        isLongTermBackup: false
        retentionPeriodInDays: 0
    

    AutonomousDatabaseBackup Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The AutonomousDatabaseBackup resource accepts the following input properties:

    AutonomousDatabaseId string
    The OCID of the Autonomous Database backup.
    BackupDestinationDetails AutonomousDatabaseBackupBackupDestinationDetails
    Backup destination details
    DisplayName string
    The user-friendly name for the backup. The name does not have to be unique.
    IsLongTermBackup bool
    Indicates whether the backup is long-term
    RetentionPeriodInDays int

    (Updatable) Retention period, in days, for long-term backups

    ** 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

    AutonomousDatabaseId string
    The OCID of the Autonomous Database backup.
    BackupDestinationDetails AutonomousDatabaseBackupBackupDestinationDetailsArgs
    Backup destination details
    DisplayName string
    The user-friendly name for the backup. The name does not have to be unique.
    IsLongTermBackup bool
    Indicates whether the backup is long-term
    RetentionPeriodInDays int

    (Updatable) Retention period, in days, for long-term backups

    ** 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

    autonomousDatabaseId String
    The OCID of the Autonomous Database backup.
    backupDestinationDetails AutonomousBackupBackupDestinationDetails
    Backup destination details
    displayName String
    The user-friendly name for the backup. The name does not have to be unique.
    isLongTermBackup Boolean
    Indicates whether the backup is long-term
    retentionPeriodInDays Integer

    (Updatable) Retention period, in days, for long-term backups

    ** 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

    autonomousDatabaseId string
    The OCID of the Autonomous Database backup.
    backupDestinationDetails AutonomousDatabaseBackupBackupDestinationDetails
    Backup destination details
    displayName string
    The user-friendly name for the backup. The name does not have to be unique.
    isLongTermBackup boolean
    Indicates whether the backup is long-term
    retentionPeriodInDays number

    (Updatable) Retention period, in days, for long-term backups

    ** 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

    autonomous_database_id str
    The OCID of the Autonomous Database backup.
    backup_destination_details database.AutonomousDatabaseBackupBackupDestinationDetailsArgs
    Backup destination details
    display_name str
    The user-friendly name for the backup. The name does not have to be unique.
    is_long_term_backup bool
    Indicates whether the backup is long-term
    retention_period_in_days int

    (Updatable) Retention period, in days, for long-term backups

    ** 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

    autonomousDatabaseId String
    The OCID of the Autonomous Database backup.
    backupDestinationDetails Property Map
    Backup destination details
    displayName String
    The user-friendly name for the backup. The name does not have to be unique.
    isLongTermBackup Boolean
    Indicates whether the backup is long-term
    retentionPeriodInDays Number

    (Updatable) Retention period, in days, for long-term backups

    ** 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

    Outputs

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

    CompartmentId string
    The OCID of the compartment.
    DatabaseSizeInTbs double
    The size of the database in terabytes at the time the backup was taken.
    DbVersion string
    A valid Oracle Database version for Autonomous Database.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsAutomatic bool
    Indicates whether the backup is user-initiated or automatic.
    IsRestorable bool
    Indicates whether the backup can be used to restore the associated Autonomous Database.
    KeyStoreId string
    The OCID of the key store of Oracle Vault.
    KeyStoreWalletName string
    The wallet name for Oracle Key Vault.
    KmsKeyId string
    The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
    KmsKeyVersionId string
    The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    SizeInTbs double
    The backup size in terrabytes (TB).
    State string
    The current state of the backup.
    TimeAvailableTill string
    Timestamp until when the backup will be available
    TimeEnded string
    The date and time the backup completed.
    TimeStarted string
    The date and time the backup started.
    Type string
    The type of backup.
    VaultId string
    The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
    CompartmentId string
    The OCID of the compartment.
    DatabaseSizeInTbs float64
    The size of the database in terabytes at the time the backup was taken.
    DbVersion string
    A valid Oracle Database version for Autonomous Database.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsAutomatic bool
    Indicates whether the backup is user-initiated or automatic.
    IsRestorable bool
    Indicates whether the backup can be used to restore the associated Autonomous Database.
    KeyStoreId string
    The OCID of the key store of Oracle Vault.
    KeyStoreWalletName string
    The wallet name for Oracle Key Vault.
    KmsKeyId string
    The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
    KmsKeyVersionId string
    The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    SizeInTbs float64
    The backup size in terrabytes (TB).
    State string
    The current state of the backup.
    TimeAvailableTill string
    Timestamp until when the backup will be available
    TimeEnded string
    The date and time the backup completed.
    TimeStarted string
    The date and time the backup started.
    Type string
    The type of backup.
    VaultId string
    The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
    compartmentId String
    The OCID of the compartment.
    databaseSizeInTbs Double
    The size of the database in terabytes at the time the backup was taken.
    dbVersion String
    A valid Oracle Database version for Autonomous Database.
    id String
    The provider-assigned unique ID for this managed resource.
    isAutomatic Boolean
    Indicates whether the backup is user-initiated or automatic.
    isRestorable Boolean
    Indicates whether the backup can be used to restore the associated Autonomous Database.
    keyStoreId String
    The OCID of the key store of Oracle Vault.
    keyStoreWalletName String
    The wallet name for Oracle Key Vault.
    kmsKeyId String
    The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
    kmsKeyVersionId String
    The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    sizeInTbs Double
    The backup size in terrabytes (TB).
    state String
    The current state of the backup.
    timeAvailableTill String
    Timestamp until when the backup will be available
    timeEnded String
    The date and time the backup completed.
    timeStarted String
    The date and time the backup started.
    type String
    The type of backup.
    vaultId String
    The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
    compartmentId string
    The OCID of the compartment.
    databaseSizeInTbs number
    The size of the database in terabytes at the time the backup was taken.
    dbVersion string
    A valid Oracle Database version for Autonomous Database.
    id string
    The provider-assigned unique ID for this managed resource.
    isAutomatic boolean
    Indicates whether the backup is user-initiated or automatic.
    isRestorable boolean
    Indicates whether the backup can be used to restore the associated Autonomous Database.
    keyStoreId string
    The OCID of the key store of Oracle Vault.
    keyStoreWalletName string
    The wallet name for Oracle Key Vault.
    kmsKeyId string
    The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
    kmsKeyVersionId string
    The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
    lifecycleDetails string
    Additional information about the current lifecycle state.
    sizeInTbs number
    The backup size in terrabytes (TB).
    state string
    The current state of the backup.
    timeAvailableTill string
    Timestamp until when the backup will be available
    timeEnded string
    The date and time the backup completed.
    timeStarted string
    The date and time the backup started.
    type string
    The type of backup.
    vaultId string
    The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
    compartment_id str
    The OCID of the compartment.
    database_size_in_tbs float
    The size of the database in terabytes at the time the backup was taken.
    db_version str
    A valid Oracle Database version for Autonomous Database.
    id str
    The provider-assigned unique ID for this managed resource.
    is_automatic bool
    Indicates whether the backup is user-initiated or automatic.
    is_restorable bool
    Indicates whether the backup can be used to restore the associated Autonomous Database.
    key_store_id str
    The OCID of the key store of Oracle Vault.
    key_store_wallet_name str
    The wallet name for Oracle Key Vault.
    kms_key_id str
    The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
    kms_key_version_id str
    The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
    lifecycle_details str
    Additional information about the current lifecycle state.
    size_in_tbs float
    The backup size in terrabytes (TB).
    state str
    The current state of the backup.
    time_available_till str
    Timestamp until when the backup will be available
    time_ended str
    The date and time the backup completed.
    time_started str
    The date and time the backup started.
    type str
    The type of backup.
    vault_id str
    The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
    compartmentId String
    The OCID of the compartment.
    databaseSizeInTbs Number
    The size of the database in terabytes at the time the backup was taken.
    dbVersion String
    A valid Oracle Database version for Autonomous Database.
    id String
    The provider-assigned unique ID for this managed resource.
    isAutomatic Boolean
    Indicates whether the backup is user-initiated or automatic.
    isRestorable Boolean
    Indicates whether the backup can be used to restore the associated Autonomous Database.
    keyStoreId String
    The OCID of the key store of Oracle Vault.
    keyStoreWalletName String
    The wallet name for Oracle Key Vault.
    kmsKeyId String
    The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
    kmsKeyVersionId String
    The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    sizeInTbs Number
    The backup size in terrabytes (TB).
    state String
    The current state of the backup.
    timeAvailableTill String
    Timestamp until when the backup will be available
    timeEnded String
    The date and time the backup completed.
    timeStarted String
    The date and time the backup started.
    type String
    The type of backup.
    vaultId String
    The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

    Look up Existing AutonomousDatabaseBackup Resource

    Get an existing AutonomousDatabaseBackup 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?: AutonomousDatabaseBackupState, opts?: CustomResourceOptions): AutonomousDatabaseBackup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            autonomous_database_id: Optional[str] = None,
            backup_destination_details: Optional[_database.AutonomousDatabaseBackupBackupDestinationDetailsArgs] = None,
            compartment_id: Optional[str] = None,
            database_size_in_tbs: Optional[float] = None,
            db_version: Optional[str] = None,
            display_name: Optional[str] = None,
            is_automatic: Optional[bool] = None,
            is_long_term_backup: Optional[bool] = None,
            is_restorable: Optional[bool] = None,
            key_store_id: Optional[str] = None,
            key_store_wallet_name: Optional[str] = None,
            kms_key_id: Optional[str] = None,
            kms_key_version_id: Optional[str] = None,
            lifecycle_details: Optional[str] = None,
            retention_period_in_days: Optional[int] = None,
            size_in_tbs: Optional[float] = None,
            state: Optional[str] = None,
            time_available_till: Optional[str] = None,
            time_ended: Optional[str] = None,
            time_started: Optional[str] = None,
            type: Optional[str] = None,
            vault_id: Optional[str] = None) -> AutonomousDatabaseBackup
    func GetAutonomousDatabaseBackup(ctx *Context, name string, id IDInput, state *AutonomousDatabaseBackupState, opts ...ResourceOption) (*AutonomousDatabaseBackup, error)
    public static AutonomousDatabaseBackup Get(string name, Input<string> id, AutonomousDatabaseBackupState? state, CustomResourceOptions? opts = null)
    public static AutonomousDatabaseBackup get(String name, Output<String> id, AutonomousDatabaseBackupState 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:
    AutonomousDatabaseId string
    The OCID of the Autonomous Database backup.
    BackupDestinationDetails AutonomousDatabaseBackupBackupDestinationDetails
    Backup destination details
    CompartmentId string
    The OCID of the compartment.
    DatabaseSizeInTbs double
    The size of the database in terabytes at the time the backup was taken.
    DbVersion string
    A valid Oracle Database version for Autonomous Database.
    DisplayName string
    The user-friendly name for the backup. The name does not have to be unique.
    IsAutomatic bool
    Indicates whether the backup is user-initiated or automatic.
    IsLongTermBackup bool
    Indicates whether the backup is long-term
    IsRestorable bool
    Indicates whether the backup can be used to restore the associated Autonomous Database.
    KeyStoreId string
    The OCID of the key store of Oracle Vault.
    KeyStoreWalletName string
    The wallet name for Oracle Key Vault.
    KmsKeyId string
    The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
    KmsKeyVersionId string
    The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    RetentionPeriodInDays int

    (Updatable) Retention period, in days, for long-term backups

    ** 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

    SizeInTbs double
    The backup size in terrabytes (TB).
    State string
    The current state of the backup.
    TimeAvailableTill string
    Timestamp until when the backup will be available
    TimeEnded string
    The date and time the backup completed.
    TimeStarted string
    The date and time the backup started.
    Type string
    The type of backup.
    VaultId string
    The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
    AutonomousDatabaseId string
    The OCID of the Autonomous Database backup.
    BackupDestinationDetails AutonomousDatabaseBackupBackupDestinationDetailsArgs
    Backup destination details
    CompartmentId string
    The OCID of the compartment.
    DatabaseSizeInTbs float64
    The size of the database in terabytes at the time the backup was taken.
    DbVersion string
    A valid Oracle Database version for Autonomous Database.
    DisplayName string
    The user-friendly name for the backup. The name does not have to be unique.
    IsAutomatic bool
    Indicates whether the backup is user-initiated or automatic.
    IsLongTermBackup bool
    Indicates whether the backup is long-term
    IsRestorable bool
    Indicates whether the backup can be used to restore the associated Autonomous Database.
    KeyStoreId string
    The OCID of the key store of Oracle Vault.
    KeyStoreWalletName string
    The wallet name for Oracle Key Vault.
    KmsKeyId string
    The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
    KmsKeyVersionId string
    The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    RetentionPeriodInDays int

    (Updatable) Retention period, in days, for long-term backups

    ** 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

    SizeInTbs float64
    The backup size in terrabytes (TB).
    State string
    The current state of the backup.
    TimeAvailableTill string
    Timestamp until when the backup will be available
    TimeEnded string
    The date and time the backup completed.
    TimeStarted string
    The date and time the backup started.
    Type string
    The type of backup.
    VaultId string
    The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
    autonomousDatabaseId String
    The OCID of the Autonomous Database backup.
    backupDestinationDetails AutonomousBackupBackupDestinationDetails
    Backup destination details
    compartmentId String
    The OCID of the compartment.
    databaseSizeInTbs Double
    The size of the database in terabytes at the time the backup was taken.
    dbVersion String
    A valid Oracle Database version for Autonomous Database.
    displayName String
    The user-friendly name for the backup. The name does not have to be unique.
    isAutomatic Boolean
    Indicates whether the backup is user-initiated or automatic.
    isLongTermBackup Boolean
    Indicates whether the backup is long-term
    isRestorable Boolean
    Indicates whether the backup can be used to restore the associated Autonomous Database.
    keyStoreId String
    The OCID of the key store of Oracle Vault.
    keyStoreWalletName String
    The wallet name for Oracle Key Vault.
    kmsKeyId String
    The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
    kmsKeyVersionId String
    The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    retentionPeriodInDays Integer

    (Updatable) Retention period, in days, for long-term backups

    ** 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

    sizeInTbs Double
    The backup size in terrabytes (TB).
    state String
    The current state of the backup.
    timeAvailableTill String
    Timestamp until when the backup will be available
    timeEnded String
    The date and time the backup completed.
    timeStarted String
    The date and time the backup started.
    type String
    The type of backup.
    vaultId String
    The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
    autonomousDatabaseId string
    The OCID of the Autonomous Database backup.
    backupDestinationDetails AutonomousDatabaseBackupBackupDestinationDetails
    Backup destination details
    compartmentId string
    The OCID of the compartment.
    databaseSizeInTbs number
    The size of the database in terabytes at the time the backup was taken.
    dbVersion string
    A valid Oracle Database version for Autonomous Database.
    displayName string
    The user-friendly name for the backup. The name does not have to be unique.
    isAutomatic boolean
    Indicates whether the backup is user-initiated or automatic.
    isLongTermBackup boolean
    Indicates whether the backup is long-term
    isRestorable boolean
    Indicates whether the backup can be used to restore the associated Autonomous Database.
    keyStoreId string
    The OCID of the key store of Oracle Vault.
    keyStoreWalletName string
    The wallet name for Oracle Key Vault.
    kmsKeyId string
    The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
    kmsKeyVersionId string
    The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
    lifecycleDetails string
    Additional information about the current lifecycle state.
    retentionPeriodInDays number

    (Updatable) Retention period, in days, for long-term backups

    ** 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

    sizeInTbs number
    The backup size in terrabytes (TB).
    state string
    The current state of the backup.
    timeAvailableTill string
    Timestamp until when the backup will be available
    timeEnded string
    The date and time the backup completed.
    timeStarted string
    The date and time the backup started.
    type string
    The type of backup.
    vaultId string
    The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
    autonomous_database_id str
    The OCID of the Autonomous Database backup.
    backup_destination_details database.AutonomousDatabaseBackupBackupDestinationDetailsArgs
    Backup destination details
    compartment_id str
    The OCID of the compartment.
    database_size_in_tbs float
    The size of the database in terabytes at the time the backup was taken.
    db_version str
    A valid Oracle Database version for Autonomous Database.
    display_name str
    The user-friendly name for the backup. The name does not have to be unique.
    is_automatic bool
    Indicates whether the backup is user-initiated or automatic.
    is_long_term_backup bool
    Indicates whether the backup is long-term
    is_restorable bool
    Indicates whether the backup can be used to restore the associated Autonomous Database.
    key_store_id str
    The OCID of the key store of Oracle Vault.
    key_store_wallet_name str
    The wallet name for Oracle Key Vault.
    kms_key_id str
    The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
    kms_key_version_id str
    The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
    lifecycle_details str
    Additional information about the current lifecycle state.
    retention_period_in_days int

    (Updatable) Retention period, in days, for long-term backups

    ** 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

    size_in_tbs float
    The backup size in terrabytes (TB).
    state str
    The current state of the backup.
    time_available_till str
    Timestamp until when the backup will be available
    time_ended str
    The date and time the backup completed.
    time_started str
    The date and time the backup started.
    type str
    The type of backup.
    vault_id str
    The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
    autonomousDatabaseId String
    The OCID of the Autonomous Database backup.
    backupDestinationDetails Property Map
    Backup destination details
    compartmentId String
    The OCID of the compartment.
    databaseSizeInTbs Number
    The size of the database in terabytes at the time the backup was taken.
    dbVersion String
    A valid Oracle Database version for Autonomous Database.
    displayName String
    The user-friendly name for the backup. The name does not have to be unique.
    isAutomatic Boolean
    Indicates whether the backup is user-initiated or automatic.
    isLongTermBackup Boolean
    Indicates whether the backup is long-term
    isRestorable Boolean
    Indicates whether the backup can be used to restore the associated Autonomous Database.
    keyStoreId String
    The OCID of the key store of Oracle Vault.
    keyStoreWalletName String
    The wallet name for Oracle Key Vault.
    kmsKeyId String
    The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
    kmsKeyVersionId String
    The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    retentionPeriodInDays Number

    (Updatable) Retention period, in days, for long-term backups

    ** 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

    sizeInTbs Number
    The backup size in terrabytes (TB).
    state String
    The current state of the backup.
    timeAvailableTill String
    Timestamp until when the backup will be available
    timeEnded String
    The date and time the backup completed.
    timeStarted String
    The date and time the backup started.
    type String
    The type of backup.
    vaultId String
    The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

    Supporting Types

    AutonomousDatabaseBackupBackupDestinationDetails, AutonomousDatabaseBackupBackupDestinationDetailsArgs

    Type string
    The type of backup.
    Id string
    The OCID of the Autonomous Database backup.
    InternetProxy string
    Proxy URL to connect to object store.
    VpcPassword string
    For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
    VpcUser string
    For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.
    Type string
    The type of backup.
    Id string
    The OCID of the Autonomous Database backup.
    InternetProxy string
    Proxy URL to connect to object store.
    VpcPassword string
    For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
    VpcUser string
    For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.
    type String
    The type of backup.
    id String
    The OCID of the Autonomous Database backup.
    internetProxy String
    Proxy URL to connect to object store.
    vpcPassword String
    For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
    vpcUser String
    For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.
    type string
    The type of backup.
    id string
    The OCID of the Autonomous Database backup.
    internetProxy string
    Proxy URL to connect to object store.
    vpcPassword string
    For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
    vpcUser string
    For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.
    type str
    The type of backup.
    id str
    The OCID of the Autonomous Database backup.
    internet_proxy str
    Proxy URL to connect to object store.
    vpc_password str
    For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
    vpc_user str
    For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.
    type String
    The type of backup.
    id String
    The OCID of the Autonomous Database backup.
    internetProxy String
    Proxy URL to connect to object store.
    vpcPassword String
    For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
    vpcUser String
    For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.

    Import

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

    $ pulumi import oci:Database/autonomousDatabaseBackup:AutonomousDatabaseBackup test_autonomous_database_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 v2.19.0 published on Thursday, Dec 12, 2024 by Pulumi