Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

AutonomousDatabaseBackup

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

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testAutonomousDatabaseBackup = new Oci.Database.AutonomousDatabaseBackup("testAutonomousDatabaseBackup", new()
    {
        AutonomousDatabaseId = oci_database_autonomous_database.Test_autonomous_database.Id,
        DisplayName = @var.Autonomous_database_backup_display_name,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Database.NewAutonomousDatabaseBackup(ctx, "testAutonomousDatabaseBackup", &Database.AutonomousDatabaseBackupArgs{
			AutonomousDatabaseId: pulumi.Any(oci_database_autonomous_database.Test_autonomous_database.Id),
			DisplayName:          pulumi.Any(_var.Autonomous_database_backup_display_name),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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(oci_database_autonomous_database.test_autonomous_database().id())
            .displayName(var_.autonomous_database_backup_display_name())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_autonomous_database_backup = oci.database.AutonomousDatabaseBackup("testAutonomousDatabaseBackup",
    autonomous_database_id=oci_database_autonomous_database["test_autonomous_database"]["id"],
    display_name=var["autonomous_database_backup_display_name"])

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

const testAutonomousDatabaseBackup = new oci.database.AutonomousDatabaseBackup("testAutonomousDatabaseBackup", {
    autonomousDatabaseId: oci_database_autonomous_database.test_autonomous_database.id,
    displayName: _var.autonomous_database_backup_display_name,
});

resources:
  testAutonomousDatabaseBackup:
    type: oci:Database:AutonomousDatabaseBackup
    properties:
      #Required
      autonomousDatabaseId: ${oci_database_autonomous_database.test_autonomous_database.id}
      displayName: ${var.autonomous_database_backup_display_name}

Create AutonomousDatabaseBackup Resource

new AutonomousDatabaseBackup(name: string, args: AutonomousDatabaseBackupArgs, opts?: CustomResourceOptions);

@overload
def AutonomousDatabaseBackup(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             autonomous_database_id: Optional[str] = None,
                             display_name: Optional[str] = None)
@overload
def AutonomousDatabaseBackup(resource_name: str,
                             args: AutonomousDatabaseBackupArgs,
                             opts: Optional[ResourceOptions] = 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.

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.

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

The AutonomousDatabaseBackup resource accepts the following input properties:

AutonomousDatabaseId string: The OCID of the Autonomous Database backup.
DisplayName string: The user-friendly name for the backup. The name does not have to be unique.

AutonomousDatabaseId string: The OCID of the Autonomous Database backup.
DisplayName string: The user-friendly name for the backup. The name does not have to be unique.

autonomousDatabaseId String: The OCID of the Autonomous Database backup.
displayName String: The user-friendly name for the backup. The name does not have to be unique.

autonomousDatabaseId string: The OCID of the Autonomous Database backup.
displayName string: The user-friendly name for the backup. The name does not have to be unique.

autonomous_database_id str: The OCID of the Autonomous Database backup.
display_name str: The user-friendly name for the backup. The name does not have to be unique.

autonomousDatabaseId String: The OCID of the Autonomous Database backup.
displayName String: The user-friendly name for the backup. The name does not have to be unique.

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.
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.
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.
LifecycleDetails string: Additional information about the current lifecycle state.
State string: The current state of the backup.
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.

CompartmentId string: The OCID of the compartment.
DatabaseSizeInTbs float64: The size of the database in terabytes at the time the backup was taken.
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.
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.
LifecycleDetails string: Additional information about the current lifecycle state.
State string: The current state of the backup.
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.

compartmentId String: The OCID of the compartment.
databaseSizeInTbs Double: The size of the database in terabytes at the time the backup was taken.
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.
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.
lifecycleDetails String: Additional information about the current lifecycle state.
state String: The current state of the backup.
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.

compartmentId string: The OCID of the compartment.
databaseSizeInTbs number: The size of the database in terabytes at the time the backup was taken.
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.
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.
lifecycleDetails string: Additional information about the current lifecycle state.
state string: The current state of the backup.
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.

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.
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.
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.
lifecycle_details str: Additional information about the current lifecycle state.
state str: The current state of the backup.
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.

compartmentId String: The OCID of the compartment.
databaseSizeInTbs Number: The size of the database in terabytes at the time the backup was taken.
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.
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.
lifecycleDetails String: Additional information about the current lifecycle state.
state String: The current state of the backup.
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.

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,
        compartment_id: Optional[str] = None,
        database_size_in_tbs: Optional[float] = None,
        display_name: Optional[str] = None,
        is_automatic: 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,
        state: 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.
CompartmentId string: The OCID of the compartment.
DatabaseSizeInTbs double: The size of the database in terabytes at the time the backup was taken.
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.
IsRestorable bool: Indicates whether the backup can be used to restore the associated Autonomous Database.
KeyStoreId string: The OCID of the key store.
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.
LifecycleDetails string: Additional information about the current lifecycle state.
State string: The current state of the backup.
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.

AutonomousDatabaseId string: The OCID of the Autonomous Database backup.
CompartmentId string: The OCID of the compartment.
DatabaseSizeInTbs float64: The size of the database in terabytes at the time the backup was taken.
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.
IsRestorable bool: Indicates whether the backup can be used to restore the associated Autonomous Database.
KeyStoreId string: The OCID of the key store.
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.
LifecycleDetails string: Additional information about the current lifecycle state.
State string: The current state of the backup.
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.

autonomousDatabaseId String: The OCID of the Autonomous Database backup.
compartmentId String: The OCID of the compartment.
databaseSizeInTbs Double: The size of the database in terabytes at the time the backup was taken.
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.
isRestorable Boolean: Indicates whether the backup can be used to restore the associated Autonomous Database.
keyStoreId String: The OCID of the key store.
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.
lifecycleDetails String: Additional information about the current lifecycle state.
state String: The current state of the backup.
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.

autonomousDatabaseId string: The OCID of the Autonomous Database backup.
compartmentId string: The OCID of the compartment.
databaseSizeInTbs number: The size of the database in terabytes at the time the backup was taken.
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.
isRestorable boolean: Indicates whether the backup can be used to restore the associated Autonomous Database.
keyStoreId string: The OCID of the key store.
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.
lifecycleDetails string: Additional information about the current lifecycle state.
state string: The current state of the backup.
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.

autonomous_database_id str: The OCID of the Autonomous Database backup.
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.
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_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.
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.
lifecycle_details str: Additional information about the current lifecycle state.
state str: The current state of the backup.
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.

autonomousDatabaseId String: The OCID of the Autonomous Database backup.
compartmentId String: The OCID of the compartment.
databaseSizeInTbs Number: The size of the database in terabytes at the time the backup was taken.
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.
isRestorable Boolean: Indicates whether the backup can be used to restore the associated Autonomous Database.
keyStoreId String: The OCID of the key store.
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.
lifecycleDetails String: Additional information about the current lifecycle state.
state String: The current state of the backup.
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.

Import

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

 $ pulumi import oci:Database/autonomousDatabaseBackup:AutonomousDatabaseBackup test_autonomous_database_backup "id"

Package Details

Repository: https://github.com/pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.