Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. RecoveryMod
  5. ProtectedDatabase
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

oci.RecoveryMod.ProtectedDatabase

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

This resource provides the Protected Database resource in Oracle Cloud Infrastructure Recovery service.

Creates a new Protected Database.

Example Usage

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

const testProtectedDatabase = new oci.recoverymod.ProtectedDatabase("test_protected_database", {
    compartmentId: compartmentId,
    dbUniqueName: protectedDatabaseDbUniqueName,
    displayName: protectedDatabaseDisplayName,
    password: protectedDatabasePassword,
    protectionPolicyId: testProtectionPolicy.id,
    recoveryServiceSubnets: [{
        recoveryServiceSubnetId: testRecoveryServiceSubnet.id,
    }],
    databaseId: testDatabase.id,
    databaseSize: protectedDatabaseDatabaseSize,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    deletionSchedule: "DELETE_AFTER_72_HOURS",
    freeformTags: {
        "bar-key": "value",
    },
    isRedoLogsShipped: protectedDatabaseIsRedoLogsShipped,
    subscriptionId: testSubscription.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_protected_database = oci.recovery_mod.ProtectedDatabase("test_protected_database",
    compartment_id=compartment_id,
    db_unique_name=protected_database_db_unique_name,
    display_name=protected_database_display_name,
    password=protected_database_password,
    protection_policy_id=test_protection_policy["id"],
    recovery_service_subnets=[{
        "recovery_service_subnet_id": test_recovery_service_subnet["id"],
    }],
    database_id=test_database["id"],
    database_size=protected_database_database_size,
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    deletion_schedule="DELETE_AFTER_72_HOURS",
    freeform_tags={
        "bar-key": "value",
    },
    is_redo_logs_shipped=protected_database_is_redo_logs_shipped,
    subscription_id=test_subscription["id"])
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := recoverymod.NewProtectedDatabase(ctx, "test_protected_database", &recoverymod.ProtectedDatabaseArgs{
			CompartmentId:      pulumi.Any(compartmentId),
			DbUniqueName:       pulumi.Any(protectedDatabaseDbUniqueName),
			DisplayName:        pulumi.Any(protectedDatabaseDisplayName),
			Password:           pulumi.Any(protectedDatabasePassword),
			ProtectionPolicyId: pulumi.Any(testProtectionPolicy.Id),
			RecoveryServiceSubnets: recoverymod.ProtectedDatabaseRecoveryServiceSubnetArray{
				&recoverymod.ProtectedDatabaseRecoveryServiceSubnetArgs{
					RecoveryServiceSubnetId: pulumi.Any(testRecoveryServiceSubnet.Id),
				},
			},
			DatabaseId:   pulumi.Any(testDatabase.Id),
			DatabaseSize: pulumi.Any(protectedDatabaseDatabaseSize),
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			DeletionSchedule: pulumi.String("DELETE_AFTER_72_HOURS"),
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
			IsRedoLogsShipped: pulumi.Any(protectedDatabaseIsRedoLogsShipped),
			SubscriptionId:    pulumi.Any(testSubscription.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testProtectedDatabase = new Oci.RecoveryMod.ProtectedDatabase("test_protected_database", new()
    {
        CompartmentId = compartmentId,
        DbUniqueName = protectedDatabaseDbUniqueName,
        DisplayName = protectedDatabaseDisplayName,
        Password = protectedDatabasePassword,
        ProtectionPolicyId = testProtectionPolicy.Id,
        RecoveryServiceSubnets = new[]
        {
            new Oci.RecoveryMod.Inputs.ProtectedDatabaseRecoveryServiceSubnetArgs
            {
                RecoveryServiceSubnetId = testRecoveryServiceSubnet.Id,
            },
        },
        DatabaseId = testDatabase.Id,
        DatabaseSize = protectedDatabaseDatabaseSize,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        DeletionSchedule = "DELETE_AFTER_72_HOURS",
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        IsRedoLogsShipped = protectedDatabaseIsRedoLogsShipped,
        SubscriptionId = testSubscription.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.RecoveryMod.ProtectedDatabase;
import com.pulumi.oci.RecoveryMod.ProtectedDatabaseArgs;
import com.pulumi.oci.RecoveryMod.inputs.ProtectedDatabaseRecoveryServiceSubnetArgs;
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 testProtectedDatabase = new ProtectedDatabase("testProtectedDatabase", ProtectedDatabaseArgs.builder()
            .compartmentId(compartmentId)
            .dbUniqueName(protectedDatabaseDbUniqueName)
            .displayName(protectedDatabaseDisplayName)
            .password(protectedDatabasePassword)
            .protectionPolicyId(testProtectionPolicy.id())
            .recoveryServiceSubnets(ProtectedDatabaseRecoveryServiceSubnetArgs.builder()
                .recoveryServiceSubnetId(testRecoveryServiceSubnet.id())
                .build())
            .databaseId(testDatabase.id())
            .databaseSize(protectedDatabaseDatabaseSize)
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .deletionSchedule("DELETE_AFTER_72_HOURS")
            .freeformTags(Map.of("bar-key", "value"))
            .isRedoLogsShipped(protectedDatabaseIsRedoLogsShipped)
            .subscriptionId(testSubscription.id())
            .build());

    }
}
Copy
resources:
  testProtectedDatabase:
    type: oci:RecoveryMod:ProtectedDatabase
    name: test_protected_database
    properties:
      compartmentId: ${compartmentId}
      dbUniqueName: ${protectedDatabaseDbUniqueName}
      displayName: ${protectedDatabaseDisplayName}
      password: ${protectedDatabasePassword}
      protectionPolicyId: ${testProtectionPolicy.id}
      recoveryServiceSubnets:
        - recoveryServiceSubnetId: ${testRecoveryServiceSubnet.id}
      databaseId: ${testDatabase.id}
      databaseSize: ${protectedDatabaseDatabaseSize}
      definedTags:
        foo-namespace.bar-key: value
      deletionSchedule: DELETE_AFTER_72_HOURS
      freeformTags:
        bar-key: value
      isRedoLogsShipped: ${protectedDatabaseIsRedoLogsShipped}
      subscriptionId: ${testSubscription.id}
Copy

Create ProtectedDatabase Resource

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

Constructor syntax

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

@overload
def ProtectedDatabase(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      display_name: Optional[str] = None,
                      db_unique_name: Optional[str] = None,
                      compartment_id: Optional[str] = None,
                      password: Optional[str] = None,
                      protection_policy_id: Optional[str] = None,
                      recovery_service_subnets: Optional[Sequence[_recoverymod.ProtectedDatabaseRecoveryServiceSubnetArgs]] = None,
                      database_id: Optional[str] = None,
                      database_size: Optional[str] = None,
                      defined_tags: Optional[Mapping[str, str]] = None,
                      deletion_schedule: Optional[str] = None,
                      freeform_tags: Optional[Mapping[str, str]] = None,
                      is_redo_logs_shipped: Optional[bool] = None,
                      subscription_id: Optional[str] = None)
func NewProtectedDatabase(ctx *Context, name string, args ProtectedDatabaseArgs, opts ...ResourceOption) (*ProtectedDatabase, error)
public ProtectedDatabase(string name, ProtectedDatabaseArgs args, CustomResourceOptions? opts = null)
public ProtectedDatabase(String name, ProtectedDatabaseArgs args)
public ProtectedDatabase(String name, ProtectedDatabaseArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ProtectedDatabaseArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ProtectedDatabaseArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ProtectedDatabaseArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ProtectedDatabaseArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ProtectedDatabaseArgs
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 protectedDatabaseResource = new Oci.RecoveryMod.ProtectedDatabase("protectedDatabaseResource", new()
{
    DisplayName = "string",
    DbUniqueName = "string",
    CompartmentId = "string",
    Password = "string",
    ProtectionPolicyId = "string",
    RecoveryServiceSubnets = new[]
    {
        new Oci.RecoveryMod.Inputs.ProtectedDatabaseRecoveryServiceSubnetArgs
        {
            RecoveryServiceSubnetId = "string",
            State = "string",
        },
    },
    DatabaseId = "string",
    DatabaseSize = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    DeletionSchedule = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    IsRedoLogsShipped = false,
    SubscriptionId = "string",
});
Copy
example, err := recoverymod.NewProtectedDatabase(ctx, "protectedDatabaseResource", &recoverymod.ProtectedDatabaseArgs{
	DisplayName:        pulumi.String("string"),
	DbUniqueName:       pulumi.String("string"),
	CompartmentId:      pulumi.String("string"),
	Password:           pulumi.String("string"),
	ProtectionPolicyId: pulumi.String("string"),
	RecoveryServiceSubnets: recoverymod.ProtectedDatabaseRecoveryServiceSubnetArray{
		&recoverymod.ProtectedDatabaseRecoveryServiceSubnetArgs{
			RecoveryServiceSubnetId: pulumi.String("string"),
			State:                   pulumi.String("string"),
		},
	},
	DatabaseId:   pulumi.String("string"),
	DatabaseSize: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DeletionSchedule: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	IsRedoLogsShipped: pulumi.Bool(false),
	SubscriptionId:    pulumi.String("string"),
})
Copy
var protectedDatabaseResource = new ProtectedDatabase("protectedDatabaseResource", ProtectedDatabaseArgs.builder()
    .displayName("string")
    .dbUniqueName("string")
    .compartmentId("string")
    .password("string")
    .protectionPolicyId("string")
    .recoveryServiceSubnets(ProtectedDatabaseRecoveryServiceSubnetArgs.builder()
        .recoveryServiceSubnetId("string")
        .state("string")
        .build())
    .databaseId("string")
    .databaseSize("string")
    .definedTags(Map.of("string", "string"))
    .deletionSchedule("string")
    .freeformTags(Map.of("string", "string"))
    .isRedoLogsShipped(false)
    .subscriptionId("string")
    .build());
Copy
protected_database_resource = oci.recovery_mod.ProtectedDatabase("protectedDatabaseResource",
    display_name="string",
    db_unique_name="string",
    compartment_id="string",
    password="string",
    protection_policy_id="string",
    recovery_service_subnets=[{
        "recovery_service_subnet_id": "string",
        "state": "string",
    }],
    database_id="string",
    database_size="string",
    defined_tags={
        "string": "string",
    },
    deletion_schedule="string",
    freeform_tags={
        "string": "string",
    },
    is_redo_logs_shipped=False,
    subscription_id="string")
Copy
const protectedDatabaseResource = new oci.recoverymod.ProtectedDatabase("protectedDatabaseResource", {
    displayName: "string",
    dbUniqueName: "string",
    compartmentId: "string",
    password: "string",
    protectionPolicyId: "string",
    recoveryServiceSubnets: [{
        recoveryServiceSubnetId: "string",
        state: "string",
    }],
    databaseId: "string",
    databaseSize: "string",
    definedTags: {
        string: "string",
    },
    deletionSchedule: "string",
    freeformTags: {
        string: "string",
    },
    isRedoLogsShipped: false,
    subscriptionId: "string",
});
Copy
type: oci:RecoveryMod:ProtectedDatabase
properties:
    compartmentId: string
    databaseId: string
    databaseSize: string
    dbUniqueName: string
    definedTags:
        string: string
    deletionSchedule: string
    displayName: string
    freeformTags:
        string: string
    isRedoLogsShipped: false
    password: string
    protectionPolicyId: string
    recoveryServiceSubnets:
        - recoveryServiceSubnetId: string
          state: string
    subscriptionId: string
Copy

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

CompartmentId This property is required. string
(Updatable) The OCID of the compartment that contains the protected database.
DbUniqueName
This property is required.
Changes to this property will trigger replacement.
string
The dbUniqueName of the protected database in Recovery Service. You cannot change the unique name.
DisplayName This property is required. string
(Updatable) The protected database name. You can change the displayName. Avoid entering confidential information.
Password This property is required. string
(Updatable) Password credential which can be used to connect to Protected Database. It must contain at least 2 uppercase, 2 lowercase, 2 numeric and 2 special characters. The special characters must be underscore (_), number sign (https://docs.cloud.oracle.com/iaas/api/#) or hyphen (-). The password must not contain the username "admin", regardless of casing.
ProtectionPolicyId This property is required. string
(Updatable) The OCID of the protection policy associated with the protected database.
RecoveryServiceSubnets This property is required. List<ProtectedDatabaseRecoveryServiceSubnet>
(Updatable) List of recovery service subnet resources associated with the protected database.
DatabaseId Changes to this property will trigger replacement. string
The OCID of the protected database.
DatabaseSize string
(Updatable) The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB.
DefinedTags Dictionary<string, string>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}. For more information, see Resource Tags
DeletionSchedule string
(Updatable) Defines a preferred schedule to delete a protected database after you terminate the source database.

  • The default schedule is DELETE_AFTER_72_HOURS, so that the delete operation can occur 72 hours (3 days) after the source database is terminated.
  • The alternate schedule is DELETE_AFTER_RETENTION_PERIOD. Specify this option if you want to delete a protected database only after the policy-defined backup retention period expires.
FreeformTags Dictionary<string, string>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
IsRedoLogsShipped bool
(Updatable) The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups.
SubscriptionId string

(Updatable) The OCID of the cloud service subscription to which you want to link the protected database. For example, specify the Microsoft Azure subscription ID if you want to provision the protected database in Azure.

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

CompartmentId This property is required. string
(Updatable) The OCID of the compartment that contains the protected database.
DbUniqueName
This property is required.
Changes to this property will trigger replacement.
string
The dbUniqueName of the protected database in Recovery Service. You cannot change the unique name.
DisplayName This property is required. string
(Updatable) The protected database name. You can change the displayName. Avoid entering confidential information.
Password This property is required. string
(Updatable) Password credential which can be used to connect to Protected Database. It must contain at least 2 uppercase, 2 lowercase, 2 numeric and 2 special characters. The special characters must be underscore (_), number sign (https://docs.cloud.oracle.com/iaas/api/#) or hyphen (-). The password must not contain the username "admin", regardless of casing.
ProtectionPolicyId This property is required. string
(Updatable) The OCID of the protection policy associated with the protected database.
RecoveryServiceSubnets This property is required. []ProtectedDatabaseRecoveryServiceSubnetArgs
(Updatable) List of recovery service subnet resources associated with the protected database.
DatabaseId Changes to this property will trigger replacement. string
The OCID of the protected database.
DatabaseSize string
(Updatable) The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB.
DefinedTags map[string]string
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}. For more information, see Resource Tags
DeletionSchedule string
(Updatable) Defines a preferred schedule to delete a protected database after you terminate the source database.

  • The default schedule is DELETE_AFTER_72_HOURS, so that the delete operation can occur 72 hours (3 days) after the source database is terminated.
  • The alternate schedule is DELETE_AFTER_RETENTION_PERIOD. Specify this option if you want to delete a protected database only after the policy-defined backup retention period expires.
FreeformTags map[string]string
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
IsRedoLogsShipped bool
(Updatable) The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups.
SubscriptionId string

(Updatable) The OCID of the cloud service subscription to which you want to link the protected database. For example, specify the Microsoft Azure subscription ID if you want to provision the protected database in Azure.

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

compartmentId This property is required. String
(Updatable) The OCID of the compartment that contains the protected database.
dbUniqueName
This property is required.
Changes to this property will trigger replacement.
String
The dbUniqueName of the protected database in Recovery Service. You cannot change the unique name.
displayName This property is required. String
(Updatable) The protected database name. You can change the displayName. Avoid entering confidential information.
password This property is required. String
(Updatable) Password credential which can be used to connect to Protected Database. It must contain at least 2 uppercase, 2 lowercase, 2 numeric and 2 special characters. The special characters must be underscore (_), number sign (https://docs.cloud.oracle.com/iaas/api/#) or hyphen (-). The password must not contain the username "admin", regardless of casing.
protectionPolicyId This property is required. String
(Updatable) The OCID of the protection policy associated with the protected database.
recoveryServiceSubnets This property is required. List<ProtectedDatabaseRecoveryServiceSubnet>
(Updatable) List of recovery service subnet resources associated with the protected database.
databaseId Changes to this property will trigger replacement. String
The OCID of the protected database.
databaseSize String
(Updatable) The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB.
definedTags Map<String,String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}. For more information, see Resource Tags
deletionSchedule String
(Updatable) Defines a preferred schedule to delete a protected database after you terminate the source database.

  • The default schedule is DELETE_AFTER_72_HOURS, so that the delete operation can occur 72 hours (3 days) after the source database is terminated.
  • The alternate schedule is DELETE_AFTER_RETENTION_PERIOD. Specify this option if you want to delete a protected database only after the policy-defined backup retention period expires.
freeformTags Map<String,String>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
isRedoLogsShipped Boolean
(Updatable) The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups.
subscriptionId String

(Updatable) The OCID of the cloud service subscription to which you want to link the protected database. For example, specify the Microsoft Azure subscription ID if you want to provision the protected database in Azure.

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

compartmentId This property is required. string
(Updatable) The OCID of the compartment that contains the protected database.
dbUniqueName
This property is required.
Changes to this property will trigger replacement.
string
The dbUniqueName of the protected database in Recovery Service. You cannot change the unique name.
displayName This property is required. string
(Updatable) The protected database name. You can change the displayName. Avoid entering confidential information.
password This property is required. string
(Updatable) Password credential which can be used to connect to Protected Database. It must contain at least 2 uppercase, 2 lowercase, 2 numeric and 2 special characters. The special characters must be underscore (_), number sign (https://docs.cloud.oracle.com/iaas/api/#) or hyphen (-). The password must not contain the username "admin", regardless of casing.
protectionPolicyId This property is required. string
(Updatable) The OCID of the protection policy associated with the protected database.
recoveryServiceSubnets This property is required. ProtectedDatabaseRecoveryServiceSubnet[]
(Updatable) List of recovery service subnet resources associated with the protected database.
databaseId Changes to this property will trigger replacement. string
The OCID of the protected database.
databaseSize string
(Updatable) The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB.
definedTags {[key: string]: string}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}. For more information, see Resource Tags
deletionSchedule string
(Updatable) Defines a preferred schedule to delete a protected database after you terminate the source database.

  • The default schedule is DELETE_AFTER_72_HOURS, so that the delete operation can occur 72 hours (3 days) after the source database is terminated.
  • The alternate schedule is DELETE_AFTER_RETENTION_PERIOD. Specify this option if you want to delete a protected database only after the policy-defined backup retention period expires.
freeformTags {[key: string]: string}
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
isRedoLogsShipped boolean
(Updatable) The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups.
subscriptionId string

(Updatable) The OCID of the cloud service subscription to which you want to link the protected database. For example, specify the Microsoft Azure subscription ID if you want to provision the protected database in Azure.

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

compartment_id This property is required. str
(Updatable) The OCID of the compartment that contains the protected database.
db_unique_name
This property is required.
Changes to this property will trigger replacement.
str
The dbUniqueName of the protected database in Recovery Service. You cannot change the unique name.
display_name This property is required. str
(Updatable) The protected database name. You can change the displayName. Avoid entering confidential information.
password This property is required. str
(Updatable) Password credential which can be used to connect to Protected Database. It must contain at least 2 uppercase, 2 lowercase, 2 numeric and 2 special characters. The special characters must be underscore (_), number sign (https://docs.cloud.oracle.com/iaas/api/#) or hyphen (-). The password must not contain the username "admin", regardless of casing.
protection_policy_id This property is required. str
(Updatable) The OCID of the protection policy associated with the protected database.
recovery_service_subnets This property is required. Sequence[recoverymod.ProtectedDatabaseRecoveryServiceSubnetArgs]
(Updatable) List of recovery service subnet resources associated with the protected database.
database_id Changes to this property will trigger replacement. str
The OCID of the protected database.
database_size str
(Updatable) The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB.
defined_tags Mapping[str, str]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}. For more information, see Resource Tags
deletion_schedule str
(Updatable) Defines a preferred schedule to delete a protected database after you terminate the source database.

  • The default schedule is DELETE_AFTER_72_HOURS, so that the delete operation can occur 72 hours (3 days) after the source database is terminated.
  • The alternate schedule is DELETE_AFTER_RETENTION_PERIOD. Specify this option if you want to delete a protected database only after the policy-defined backup retention period expires.
freeform_tags Mapping[str, str]
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
is_redo_logs_shipped bool
(Updatable) The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups.
subscription_id str

(Updatable) The OCID of the cloud service subscription to which you want to link the protected database. For example, specify the Microsoft Azure subscription ID if you want to provision the protected database in Azure.

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

compartmentId This property is required. String
(Updatable) The OCID of the compartment that contains the protected database.
dbUniqueName
This property is required.
Changes to this property will trigger replacement.
String
The dbUniqueName of the protected database in Recovery Service. You cannot change the unique name.
displayName This property is required. String
(Updatable) The protected database name. You can change the displayName. Avoid entering confidential information.
password This property is required. String
(Updatable) Password credential which can be used to connect to Protected Database. It must contain at least 2 uppercase, 2 lowercase, 2 numeric and 2 special characters. The special characters must be underscore (_), number sign (https://docs.cloud.oracle.com/iaas/api/#) or hyphen (-). The password must not contain the username "admin", regardless of casing.
protectionPolicyId This property is required. String
(Updatable) The OCID of the protection policy associated with the protected database.
recoveryServiceSubnets This property is required. List<Property Map>
(Updatable) List of recovery service subnet resources associated with the protected database.
databaseId Changes to this property will trigger replacement. String
The OCID of the protected database.
databaseSize String
(Updatable) The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB.
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}. For more information, see Resource Tags
deletionSchedule String
(Updatable) Defines a preferred schedule to delete a protected database after you terminate the source database.

  • The default schedule is DELETE_AFTER_72_HOURS, so that the delete operation can occur 72 hours (3 days) after the source database is terminated.
  • The alternate schedule is DELETE_AFTER_RETENTION_PERIOD. Specify this option if you want to delete a protected database only after the policy-defined backup retention period expires.
freeformTags Map<String>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
isRedoLogsShipped Boolean
(Updatable) The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups.
subscriptionId String

(Updatable) The OCID of the cloud service subscription to which you want to link the protected database. For example, specify the Microsoft Azure subscription ID if you want to provision the protected database in Azure.

** 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 ProtectedDatabase resource produces the following output properties:

Health string
Indicates the protection status of the database.
HealthDetails string
A message describing the current health of the protected database.
Id string
The provider-assigned unique ID for this managed resource.
IsReadOnlyResource bool
Indicates whether the protected database is created by Recovery Service or created manually. Set to TRUE for a service-defined protected database. When you enable the OCI-managed automatic backups option for a database and set Recovery Service as the backup destination, then Recovery Service creates the associated protected database resource. Set to FALSE for a user-defined protected database.
LifecycleDetails string
Detailed description about the current lifecycle state of the protected database. For example, it can be used to provide actionable information for a resource in a Failed state.
Metrics List<ProtectedDatabaseMetric>
Backup performance and storage utilization metrics for the protected database.
PolicyLockedDateTime string
An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy.
State string
The current state of the Protected Database.
SystemTags Dictionary<string, string>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}. For more information, see Resource Tags
TimeCreated string
An RFC3339 formatted datetime string that indicates the created time for a protected database. For example: '2020-05-22T21:10:29.600Z'
TimeUpdated string
An RFC3339 formatted datetime string that indicates the last updated time for a protected database. For example: '2020-05-22T21:10:29.600Z'
VpcUserName string
The virtual private catalog (VPC) user credentials that authenticates the protected database to access Recovery Service.
Health string
Indicates the protection status of the database.
HealthDetails string
A message describing the current health of the protected database.
Id string
The provider-assigned unique ID for this managed resource.
IsReadOnlyResource bool
Indicates whether the protected database is created by Recovery Service or created manually. Set to TRUE for a service-defined protected database. When you enable the OCI-managed automatic backups option for a database and set Recovery Service as the backup destination, then Recovery Service creates the associated protected database resource. Set to FALSE for a user-defined protected database.
LifecycleDetails string
Detailed description about the current lifecycle state of the protected database. For example, it can be used to provide actionable information for a resource in a Failed state.
Metrics []ProtectedDatabaseMetric
Backup performance and storage utilization metrics for the protected database.
PolicyLockedDateTime string
An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy.
State string
The current state of the Protected Database.
SystemTags map[string]string
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}. For more information, see Resource Tags
TimeCreated string
An RFC3339 formatted datetime string that indicates the created time for a protected database. For example: '2020-05-22T21:10:29.600Z'
TimeUpdated string
An RFC3339 formatted datetime string that indicates the last updated time for a protected database. For example: '2020-05-22T21:10:29.600Z'
VpcUserName string
The virtual private catalog (VPC) user credentials that authenticates the protected database to access Recovery Service.
health String
Indicates the protection status of the database.
healthDetails String
A message describing the current health of the protected database.
id String
The provider-assigned unique ID for this managed resource.
isReadOnlyResource Boolean
Indicates whether the protected database is created by Recovery Service or created manually. Set to TRUE for a service-defined protected database. When you enable the OCI-managed automatic backups option for a database and set Recovery Service as the backup destination, then Recovery Service creates the associated protected database resource. Set to FALSE for a user-defined protected database.
lifecycleDetails String
Detailed description about the current lifecycle state of the protected database. For example, it can be used to provide actionable information for a resource in a Failed state.
metrics List<ProtectedDatabaseMetric>
Backup performance and storage utilization metrics for the protected database.
policyLockedDateTime String
An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy.
state String
The current state of the Protected Database.
systemTags Map<String,String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}. For more information, see Resource Tags
timeCreated String
An RFC3339 formatted datetime string that indicates the created time for a protected database. For example: '2020-05-22T21:10:29.600Z'
timeUpdated String
An RFC3339 formatted datetime string that indicates the last updated time for a protected database. For example: '2020-05-22T21:10:29.600Z'
vpcUserName String
The virtual private catalog (VPC) user credentials that authenticates the protected database to access Recovery Service.
health string
Indicates the protection status of the database.
healthDetails string
A message describing the current health of the protected database.
id string
The provider-assigned unique ID for this managed resource.
isReadOnlyResource boolean
Indicates whether the protected database is created by Recovery Service or created manually. Set to TRUE for a service-defined protected database. When you enable the OCI-managed automatic backups option for a database and set Recovery Service as the backup destination, then Recovery Service creates the associated protected database resource. Set to FALSE for a user-defined protected database.
lifecycleDetails string
Detailed description about the current lifecycle state of the protected database. For example, it can be used to provide actionable information for a resource in a Failed state.
metrics ProtectedDatabaseMetric[]
Backup performance and storage utilization metrics for the protected database.
policyLockedDateTime string
An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy.
state string
The current state of the Protected Database.
systemTags {[key: string]: string}
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}. For more information, see Resource Tags
timeCreated string
An RFC3339 formatted datetime string that indicates the created time for a protected database. For example: '2020-05-22T21:10:29.600Z'
timeUpdated string
An RFC3339 formatted datetime string that indicates the last updated time for a protected database. For example: '2020-05-22T21:10:29.600Z'
vpcUserName string
The virtual private catalog (VPC) user credentials that authenticates the protected database to access Recovery Service.
health str
Indicates the protection status of the database.
health_details str
A message describing the current health of the protected database.
id str
The provider-assigned unique ID for this managed resource.
is_read_only_resource bool
Indicates whether the protected database is created by Recovery Service or created manually. Set to TRUE for a service-defined protected database. When you enable the OCI-managed automatic backups option for a database and set Recovery Service as the backup destination, then Recovery Service creates the associated protected database resource. Set to FALSE for a user-defined protected database.
lifecycle_details str
Detailed description about the current lifecycle state of the protected database. For example, it can be used to provide actionable information for a resource in a Failed state.
metrics Sequence[recoverymod.ProtectedDatabaseMetric]
Backup performance and storage utilization metrics for the protected database.
policy_locked_date_time str
An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy.
state str
The current state of the Protected Database.
system_tags Mapping[str, str]
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}. For more information, see Resource Tags
time_created str
An RFC3339 formatted datetime string that indicates the created time for a protected database. For example: '2020-05-22T21:10:29.600Z'
time_updated str
An RFC3339 formatted datetime string that indicates the last updated time for a protected database. For example: '2020-05-22T21:10:29.600Z'
vpc_user_name str
The virtual private catalog (VPC) user credentials that authenticates the protected database to access Recovery Service.
health String
Indicates the protection status of the database.
healthDetails String
A message describing the current health of the protected database.
id String
The provider-assigned unique ID for this managed resource.
isReadOnlyResource Boolean
Indicates whether the protected database is created by Recovery Service or created manually. Set to TRUE for a service-defined protected database. When you enable the OCI-managed automatic backups option for a database and set Recovery Service as the backup destination, then Recovery Service creates the associated protected database resource. Set to FALSE for a user-defined protected database.
lifecycleDetails String
Detailed description about the current lifecycle state of the protected database. For example, it can be used to provide actionable information for a resource in a Failed state.
metrics List<Property Map>
Backup performance and storage utilization metrics for the protected database.
policyLockedDateTime String
An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy.
state String
The current state of the Protected Database.
systemTags Map<String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}. For more information, see Resource Tags
timeCreated String
An RFC3339 formatted datetime string that indicates the created time for a protected database. For example: '2020-05-22T21:10:29.600Z'
timeUpdated String
An RFC3339 formatted datetime string that indicates the last updated time for a protected database. For example: '2020-05-22T21:10:29.600Z'
vpcUserName String
The virtual private catalog (VPC) user credentials that authenticates the protected database to access Recovery Service.

Look up Existing ProtectedDatabase Resource

Get an existing ProtectedDatabase 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?: ProtectedDatabaseState, opts?: CustomResourceOptions): ProtectedDatabase
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        database_id: Optional[str] = None,
        database_size: Optional[str] = None,
        db_unique_name: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        deletion_schedule: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        health: Optional[str] = None,
        health_details: Optional[str] = None,
        is_read_only_resource: Optional[bool] = None,
        is_redo_logs_shipped: Optional[bool] = None,
        lifecycle_details: Optional[str] = None,
        metrics: Optional[Sequence[_recoverymod.ProtectedDatabaseMetricArgs]] = None,
        password: Optional[str] = None,
        policy_locked_date_time: Optional[str] = None,
        protection_policy_id: Optional[str] = None,
        recovery_service_subnets: Optional[Sequence[_recoverymod.ProtectedDatabaseRecoveryServiceSubnetArgs]] = None,
        state: Optional[str] = None,
        subscription_id: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None,
        vpc_user_name: Optional[str] = None) -> ProtectedDatabase
func GetProtectedDatabase(ctx *Context, name string, id IDInput, state *ProtectedDatabaseState, opts ...ResourceOption) (*ProtectedDatabase, error)
public static ProtectedDatabase Get(string name, Input<string> id, ProtectedDatabaseState? state, CustomResourceOptions? opts = null)
public static ProtectedDatabase get(String name, Output<String> id, ProtectedDatabaseState state, CustomResourceOptions options)
resources:  _:    type: oci:RecoveryMod:ProtectedDatabase    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CompartmentId string
(Updatable) The OCID of the compartment that contains the protected database.
DatabaseId Changes to this property will trigger replacement. string
The OCID of the protected database.
DatabaseSize string
(Updatable) The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB.
DbUniqueName Changes to this property will trigger replacement. string
The dbUniqueName of the protected database in Recovery Service. You cannot change the unique name.
DefinedTags Dictionary<string, string>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}. For more information, see Resource Tags
DeletionSchedule string
(Updatable) Defines a preferred schedule to delete a protected database after you terminate the source database.

  • The default schedule is DELETE_AFTER_72_HOURS, so that the delete operation can occur 72 hours (3 days) after the source database is terminated.
  • The alternate schedule is DELETE_AFTER_RETENTION_PERIOD. Specify this option if you want to delete a protected database only after the policy-defined backup retention period expires.
DisplayName string
(Updatable) The protected database name. You can change the displayName. Avoid entering confidential information.
FreeformTags Dictionary<string, string>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Health string
Indicates the protection status of the database.
HealthDetails string
A message describing the current health of the protected database.
IsReadOnlyResource bool
Indicates whether the protected database is created by Recovery Service or created manually. Set to TRUE for a service-defined protected database. When you enable the OCI-managed automatic backups option for a database and set Recovery Service as the backup destination, then Recovery Service creates the associated protected database resource. Set to FALSE for a user-defined protected database.
IsRedoLogsShipped bool
(Updatable) The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups.
LifecycleDetails string
Detailed description about the current lifecycle state of the protected database. For example, it can be used to provide actionable information for a resource in a Failed state.
Metrics List<ProtectedDatabaseMetric>
Backup performance and storage utilization metrics for the protected database.
Password string
(Updatable) Password credential which can be used to connect to Protected Database. It must contain at least 2 uppercase, 2 lowercase, 2 numeric and 2 special characters. The special characters must be underscore (_), number sign (https://docs.cloud.oracle.com/iaas/api/#) or hyphen (-). The password must not contain the username "admin", regardless of casing.
PolicyLockedDateTime string
An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy.
ProtectionPolicyId string
(Updatable) The OCID of the protection policy associated with the protected database.
RecoveryServiceSubnets List<ProtectedDatabaseRecoveryServiceSubnet>
(Updatable) List of recovery service subnet resources associated with the protected database.
State string
The current state of the Protected Database.
SubscriptionId string

(Updatable) The OCID of the cloud service subscription to which you want to link the protected database. For example, specify the Microsoft Azure subscription ID if you want to provision the protected database in Azure.

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

SystemTags Dictionary<string, string>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}. For more information, see Resource Tags
TimeCreated string
An RFC3339 formatted datetime string that indicates the created time for a protected database. For example: '2020-05-22T21:10:29.600Z'
TimeUpdated string
An RFC3339 formatted datetime string that indicates the last updated time for a protected database. For example: '2020-05-22T21:10:29.600Z'
VpcUserName string
The virtual private catalog (VPC) user credentials that authenticates the protected database to access Recovery Service.
CompartmentId string
(Updatable) The OCID of the compartment that contains the protected database.
DatabaseId Changes to this property will trigger replacement. string
The OCID of the protected database.
DatabaseSize string
(Updatable) The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB.
DbUniqueName Changes to this property will trigger replacement. string
The dbUniqueName of the protected database in Recovery Service. You cannot change the unique name.
DefinedTags map[string]string
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}. For more information, see Resource Tags
DeletionSchedule string
(Updatable) Defines a preferred schedule to delete a protected database after you terminate the source database.

  • The default schedule is DELETE_AFTER_72_HOURS, so that the delete operation can occur 72 hours (3 days) after the source database is terminated.
  • The alternate schedule is DELETE_AFTER_RETENTION_PERIOD. Specify this option if you want to delete a protected database only after the policy-defined backup retention period expires.
DisplayName string
(Updatable) The protected database name. You can change the displayName. Avoid entering confidential information.
FreeformTags map[string]string
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Health string
Indicates the protection status of the database.
HealthDetails string
A message describing the current health of the protected database.
IsReadOnlyResource bool
Indicates whether the protected database is created by Recovery Service or created manually. Set to TRUE for a service-defined protected database. When you enable the OCI-managed automatic backups option for a database and set Recovery Service as the backup destination, then Recovery Service creates the associated protected database resource. Set to FALSE for a user-defined protected database.
IsRedoLogsShipped bool
(Updatable) The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups.
LifecycleDetails string
Detailed description about the current lifecycle state of the protected database. For example, it can be used to provide actionable information for a resource in a Failed state.
Metrics []ProtectedDatabaseMetricArgs
Backup performance and storage utilization metrics for the protected database.
Password string
(Updatable) Password credential which can be used to connect to Protected Database. It must contain at least 2 uppercase, 2 lowercase, 2 numeric and 2 special characters. The special characters must be underscore (_), number sign (https://docs.cloud.oracle.com/iaas/api/#) or hyphen (-). The password must not contain the username "admin", regardless of casing.
PolicyLockedDateTime string
An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy.
ProtectionPolicyId string
(Updatable) The OCID of the protection policy associated with the protected database.
RecoveryServiceSubnets []ProtectedDatabaseRecoveryServiceSubnetArgs
(Updatable) List of recovery service subnet resources associated with the protected database.
State string
The current state of the Protected Database.
SubscriptionId string

(Updatable) The OCID of the cloud service subscription to which you want to link the protected database. For example, specify the Microsoft Azure subscription ID if you want to provision the protected database in Azure.

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

SystemTags map[string]string
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}. For more information, see Resource Tags
TimeCreated string
An RFC3339 formatted datetime string that indicates the created time for a protected database. For example: '2020-05-22T21:10:29.600Z'
TimeUpdated string
An RFC3339 formatted datetime string that indicates the last updated time for a protected database. For example: '2020-05-22T21:10:29.600Z'
VpcUserName string
The virtual private catalog (VPC) user credentials that authenticates the protected database to access Recovery Service.
compartmentId String
(Updatable) The OCID of the compartment that contains the protected database.
databaseId Changes to this property will trigger replacement. String
The OCID of the protected database.
databaseSize String
(Updatable) The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB.
dbUniqueName Changes to this property will trigger replacement. String
The dbUniqueName of the protected database in Recovery Service. You cannot change the unique name.
definedTags Map<String,String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}. For more information, see Resource Tags
deletionSchedule String
(Updatable) Defines a preferred schedule to delete a protected database after you terminate the source database.

  • The default schedule is DELETE_AFTER_72_HOURS, so that the delete operation can occur 72 hours (3 days) after the source database is terminated.
  • The alternate schedule is DELETE_AFTER_RETENTION_PERIOD. Specify this option if you want to delete a protected database only after the policy-defined backup retention period expires.
displayName String
(Updatable) The protected database name. You can change the displayName. Avoid entering confidential information.
freeformTags Map<String,String>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
health String
Indicates the protection status of the database.
healthDetails String
A message describing the current health of the protected database.
isReadOnlyResource Boolean
Indicates whether the protected database is created by Recovery Service or created manually. Set to TRUE for a service-defined protected database. When you enable the OCI-managed automatic backups option for a database and set Recovery Service as the backup destination, then Recovery Service creates the associated protected database resource. Set to FALSE for a user-defined protected database.
isRedoLogsShipped Boolean
(Updatable) The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups.
lifecycleDetails String
Detailed description about the current lifecycle state of the protected database. For example, it can be used to provide actionable information for a resource in a Failed state.
metrics List<ProtectedDatabaseMetric>
Backup performance and storage utilization metrics for the protected database.
password String
(Updatable) Password credential which can be used to connect to Protected Database. It must contain at least 2 uppercase, 2 lowercase, 2 numeric and 2 special characters. The special characters must be underscore (_), number sign (https://docs.cloud.oracle.com/iaas/api/#) or hyphen (-). The password must not contain the username "admin", regardless of casing.
policyLockedDateTime String
An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy.
protectionPolicyId String
(Updatable) The OCID of the protection policy associated with the protected database.
recoveryServiceSubnets List<ProtectedDatabaseRecoveryServiceSubnet>
(Updatable) List of recovery service subnet resources associated with the protected database.
state String
The current state of the Protected Database.
subscriptionId String

(Updatable) The OCID of the cloud service subscription to which you want to link the protected database. For example, specify the Microsoft Azure subscription ID if you want to provision the protected database in Azure.

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

systemTags Map<String,String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}. For more information, see Resource Tags
timeCreated String
An RFC3339 formatted datetime string that indicates the created time for a protected database. For example: '2020-05-22T21:10:29.600Z'
timeUpdated String
An RFC3339 formatted datetime string that indicates the last updated time for a protected database. For example: '2020-05-22T21:10:29.600Z'
vpcUserName String
The virtual private catalog (VPC) user credentials that authenticates the protected database to access Recovery Service.
compartmentId string
(Updatable) The OCID of the compartment that contains the protected database.
databaseId Changes to this property will trigger replacement. string
The OCID of the protected database.
databaseSize string
(Updatable) The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB.
dbUniqueName Changes to this property will trigger replacement. string
The dbUniqueName of the protected database in Recovery Service. You cannot change the unique name.
definedTags {[key: string]: string}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}. For more information, see Resource Tags
deletionSchedule string
(Updatable) Defines a preferred schedule to delete a protected database after you terminate the source database.

  • The default schedule is DELETE_AFTER_72_HOURS, so that the delete operation can occur 72 hours (3 days) after the source database is terminated.
  • The alternate schedule is DELETE_AFTER_RETENTION_PERIOD. Specify this option if you want to delete a protected database only after the policy-defined backup retention period expires.
displayName string
(Updatable) The protected database name. You can change the displayName. Avoid entering confidential information.
freeformTags {[key: string]: string}
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
health string
Indicates the protection status of the database.
healthDetails string
A message describing the current health of the protected database.
isReadOnlyResource boolean
Indicates whether the protected database is created by Recovery Service or created manually. Set to TRUE for a service-defined protected database. When you enable the OCI-managed automatic backups option for a database and set Recovery Service as the backup destination, then Recovery Service creates the associated protected database resource. Set to FALSE for a user-defined protected database.
isRedoLogsShipped boolean
(Updatable) The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups.
lifecycleDetails string
Detailed description about the current lifecycle state of the protected database. For example, it can be used to provide actionable information for a resource in a Failed state.
metrics ProtectedDatabaseMetric[]
Backup performance and storage utilization metrics for the protected database.
password string
(Updatable) Password credential which can be used to connect to Protected Database. It must contain at least 2 uppercase, 2 lowercase, 2 numeric and 2 special characters. The special characters must be underscore (_), number sign (https://docs.cloud.oracle.com/iaas/api/#) or hyphen (-). The password must not contain the username "admin", regardless of casing.
policyLockedDateTime string
An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy.
protectionPolicyId string
(Updatable) The OCID of the protection policy associated with the protected database.
recoveryServiceSubnets ProtectedDatabaseRecoveryServiceSubnet[]
(Updatable) List of recovery service subnet resources associated with the protected database.
state string
The current state of the Protected Database.
subscriptionId string

(Updatable) The OCID of the cloud service subscription to which you want to link the protected database. For example, specify the Microsoft Azure subscription ID if you want to provision the protected database in Azure.

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

systemTags {[key: string]: string}
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}. For more information, see Resource Tags
timeCreated string
An RFC3339 formatted datetime string that indicates the created time for a protected database. For example: '2020-05-22T21:10:29.600Z'
timeUpdated string
An RFC3339 formatted datetime string that indicates the last updated time for a protected database. For example: '2020-05-22T21:10:29.600Z'
vpcUserName string
The virtual private catalog (VPC) user credentials that authenticates the protected database to access Recovery Service.
compartment_id str
(Updatable) The OCID of the compartment that contains the protected database.
database_id Changes to this property will trigger replacement. str
The OCID of the protected database.
database_size str
(Updatable) The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB.
db_unique_name Changes to this property will trigger replacement. str
The dbUniqueName of the protected database in Recovery Service. You cannot change the unique name.
defined_tags Mapping[str, str]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}. For more information, see Resource Tags
deletion_schedule str
(Updatable) Defines a preferred schedule to delete a protected database after you terminate the source database.

  • The default schedule is DELETE_AFTER_72_HOURS, so that the delete operation can occur 72 hours (3 days) after the source database is terminated.
  • The alternate schedule is DELETE_AFTER_RETENTION_PERIOD. Specify this option if you want to delete a protected database only after the policy-defined backup retention period expires.
display_name str
(Updatable) The protected database name. You can change the displayName. Avoid entering confidential information.
freeform_tags Mapping[str, str]
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
health str
Indicates the protection status of the database.
health_details str
A message describing the current health of the protected database.
is_read_only_resource bool
Indicates whether the protected database is created by Recovery Service or created manually. Set to TRUE for a service-defined protected database. When you enable the OCI-managed automatic backups option for a database and set Recovery Service as the backup destination, then Recovery Service creates the associated protected database resource. Set to FALSE for a user-defined protected database.
is_redo_logs_shipped bool
(Updatable) The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups.
lifecycle_details str
Detailed description about the current lifecycle state of the protected database. For example, it can be used to provide actionable information for a resource in a Failed state.
metrics Sequence[recoverymod.ProtectedDatabaseMetricArgs]
Backup performance and storage utilization metrics for the protected database.
password str
(Updatable) Password credential which can be used to connect to Protected Database. It must contain at least 2 uppercase, 2 lowercase, 2 numeric and 2 special characters. The special characters must be underscore (_), number sign (https://docs.cloud.oracle.com/iaas/api/#) or hyphen (-). The password must not contain the username "admin", regardless of casing.
policy_locked_date_time str
An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy.
protection_policy_id str
(Updatable) The OCID of the protection policy associated with the protected database.
recovery_service_subnets Sequence[recoverymod.ProtectedDatabaseRecoveryServiceSubnetArgs]
(Updatable) List of recovery service subnet resources associated with the protected database.
state str
The current state of the Protected Database.
subscription_id str

(Updatable) The OCID of the cloud service subscription to which you want to link the protected database. For example, specify the Microsoft Azure subscription ID if you want to provision the protected database in Azure.

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

system_tags Mapping[str, str]
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}. For more information, see Resource Tags
time_created str
An RFC3339 formatted datetime string that indicates the created time for a protected database. For example: '2020-05-22T21:10:29.600Z'
time_updated str
An RFC3339 formatted datetime string that indicates the last updated time for a protected database. For example: '2020-05-22T21:10:29.600Z'
vpc_user_name str
The virtual private catalog (VPC) user credentials that authenticates the protected database to access Recovery Service.
compartmentId String
(Updatable) The OCID of the compartment that contains the protected database.
databaseId Changes to this property will trigger replacement. String
The OCID of the protected database.
databaseSize String
(Updatable) The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB.
dbUniqueName Changes to this property will trigger replacement. String
The dbUniqueName of the protected database in Recovery Service. You cannot change the unique name.
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}. For more information, see Resource Tags
deletionSchedule String
(Updatable) Defines a preferred schedule to delete a protected database after you terminate the source database.

  • The default schedule is DELETE_AFTER_72_HOURS, so that the delete operation can occur 72 hours (3 days) after the source database is terminated.
  • The alternate schedule is DELETE_AFTER_RETENTION_PERIOD. Specify this option if you want to delete a protected database only after the policy-defined backup retention period expires.
displayName String
(Updatable) The protected database name. You can change the displayName. Avoid entering confidential information.
freeformTags Map<String>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
health String
Indicates the protection status of the database.
healthDetails String
A message describing the current health of the protected database.
isReadOnlyResource Boolean
Indicates whether the protected database is created by Recovery Service or created manually. Set to TRUE for a service-defined protected database. When you enable the OCI-managed automatic backups option for a database and set Recovery Service as the backup destination, then Recovery Service creates the associated protected database resource. Set to FALSE for a user-defined protected database.
isRedoLogsShipped Boolean
(Updatable) The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups.
lifecycleDetails String
Detailed description about the current lifecycle state of the protected database. For example, it can be used to provide actionable information for a resource in a Failed state.
metrics List<Property Map>
Backup performance and storage utilization metrics for the protected database.
password String
(Updatable) Password credential which can be used to connect to Protected Database. It must contain at least 2 uppercase, 2 lowercase, 2 numeric and 2 special characters. The special characters must be underscore (_), number sign (https://docs.cloud.oracle.com/iaas/api/#) or hyphen (-). The password must not contain the username "admin", regardless of casing.
policyLockedDateTime String
An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy.
protectionPolicyId String
(Updatable) The OCID of the protection policy associated with the protected database.
recoveryServiceSubnets List<Property Map>
(Updatable) List of recovery service subnet resources associated with the protected database.
state String
The current state of the Protected Database.
subscriptionId String

(Updatable) The OCID of the cloud service subscription to which you want to link the protected database. For example, specify the Microsoft Azure subscription ID if you want to provision the protected database in Azure.

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

systemTags Map<String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}. For more information, see Resource Tags
timeCreated String
An RFC3339 formatted datetime string that indicates the created time for a protected database. For example: '2020-05-22T21:10:29.600Z'
timeUpdated String
An RFC3339 formatted datetime string that indicates the last updated time for a protected database. For example: '2020-05-22T21:10:29.600Z'
vpcUserName String
The virtual private catalog (VPC) user credentials that authenticates the protected database to access Recovery Service.

Supporting Types

ProtectedDatabaseMetric
, ProtectedDatabaseMetricArgs

BackupSpaceEstimateInGbs double
The estimated backup storage space, in gigabytes, required to meet the recovery window goal, including foot print and backups for the protected database.
BackupSpaceUsedInGbs double
Backup storage space, in gigabytes, utilized by the protected database. Oracle charges for the total storage used.
CurrentRetentionPeriodInSeconds double
Number of seconds backups are currently retained for this database.
DbSizeInGbs double
The estimated space, in gigabytes, consumed by the protected database. The database size is based on the size of the data files in the catalog, and does not include archive logs.
IsRedoLogsEnabled bool
The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups.
MinimumRecoveryNeededInDays double
Number of days of redo/archive to be applied to recover database.
RetentionPeriodInDays double
The maximum number of days to retain backups for a protected database.
UnprotectedWindowInSeconds double
This is the time window when there is data loss exposure. The point after which recovery is impossible unless additional redo is available. This is the time we received the last backup or last redo-log shipped.
BackupSpaceEstimateInGbs float64
The estimated backup storage space, in gigabytes, required to meet the recovery window goal, including foot print and backups for the protected database.
BackupSpaceUsedInGbs float64
Backup storage space, in gigabytes, utilized by the protected database. Oracle charges for the total storage used.
CurrentRetentionPeriodInSeconds float64
Number of seconds backups are currently retained for this database.
DbSizeInGbs float64
The estimated space, in gigabytes, consumed by the protected database. The database size is based on the size of the data files in the catalog, and does not include archive logs.
IsRedoLogsEnabled bool
The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups.
MinimumRecoveryNeededInDays float64
Number of days of redo/archive to be applied to recover database.
RetentionPeriodInDays float64
The maximum number of days to retain backups for a protected database.
UnprotectedWindowInSeconds float64
This is the time window when there is data loss exposure. The point after which recovery is impossible unless additional redo is available. This is the time we received the last backup or last redo-log shipped.
backupSpaceEstimateInGbs Double
The estimated backup storage space, in gigabytes, required to meet the recovery window goal, including foot print and backups for the protected database.
backupSpaceUsedInGbs Double
Backup storage space, in gigabytes, utilized by the protected database. Oracle charges for the total storage used.
currentRetentionPeriodInSeconds Double
Number of seconds backups are currently retained for this database.
dbSizeInGbs Double
The estimated space, in gigabytes, consumed by the protected database. The database size is based on the size of the data files in the catalog, and does not include archive logs.
isRedoLogsEnabled Boolean
The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups.
minimumRecoveryNeededInDays Double
Number of days of redo/archive to be applied to recover database.
retentionPeriodInDays Double
The maximum number of days to retain backups for a protected database.
unprotectedWindowInSeconds Double
This is the time window when there is data loss exposure. The point after which recovery is impossible unless additional redo is available. This is the time we received the last backup or last redo-log shipped.
backupSpaceEstimateInGbs number
The estimated backup storage space, in gigabytes, required to meet the recovery window goal, including foot print and backups for the protected database.
backupSpaceUsedInGbs number
Backup storage space, in gigabytes, utilized by the protected database. Oracle charges for the total storage used.
currentRetentionPeriodInSeconds number
Number of seconds backups are currently retained for this database.
dbSizeInGbs number
The estimated space, in gigabytes, consumed by the protected database. The database size is based on the size of the data files in the catalog, and does not include archive logs.
isRedoLogsEnabled boolean
The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups.
minimumRecoveryNeededInDays number
Number of days of redo/archive to be applied to recover database.
retentionPeriodInDays number
The maximum number of days to retain backups for a protected database.
unprotectedWindowInSeconds number
This is the time window when there is data loss exposure. The point after which recovery is impossible unless additional redo is available. This is the time we received the last backup or last redo-log shipped.
backup_space_estimate_in_gbs float
The estimated backup storage space, in gigabytes, required to meet the recovery window goal, including foot print and backups for the protected database.
backup_space_used_in_gbs float
Backup storage space, in gigabytes, utilized by the protected database. Oracle charges for the total storage used.
current_retention_period_in_seconds float
Number of seconds backups are currently retained for this database.
db_size_in_gbs float
The estimated space, in gigabytes, consumed by the protected database. The database size is based on the size of the data files in the catalog, and does not include archive logs.
is_redo_logs_enabled bool
The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups.
minimum_recovery_needed_in_days float
Number of days of redo/archive to be applied to recover database.
retention_period_in_days float
The maximum number of days to retain backups for a protected database.
unprotected_window_in_seconds float
This is the time window when there is data loss exposure. The point after which recovery is impossible unless additional redo is available. This is the time we received the last backup or last redo-log shipped.
backupSpaceEstimateInGbs Number
The estimated backup storage space, in gigabytes, required to meet the recovery window goal, including foot print and backups for the protected database.
backupSpaceUsedInGbs Number
Backup storage space, in gigabytes, utilized by the protected database. Oracle charges for the total storage used.
currentRetentionPeriodInSeconds Number
Number of seconds backups are currently retained for this database.
dbSizeInGbs Number
The estimated space, in gigabytes, consumed by the protected database. The database size is based on the size of the data files in the catalog, and does not include archive logs.
isRedoLogsEnabled Boolean
The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups.
minimumRecoveryNeededInDays Number
Number of days of redo/archive to be applied to recover database.
retentionPeriodInDays Number
The maximum number of days to retain backups for a protected database.
unprotectedWindowInSeconds Number
This is the time window when there is data loss exposure. The point after which recovery is impossible unless additional redo is available. This is the time we received the last backup or last redo-log shipped.

ProtectedDatabaseRecoveryServiceSubnet
, ProtectedDatabaseRecoveryServiceSubnetArgs

RecoveryServiceSubnetId This property is required. string
(Updatable) The recovery service subnet OCID.
State string
The current state of the Protected Database.
RecoveryServiceSubnetId This property is required. string
(Updatable) The recovery service subnet OCID.
State string
The current state of the Protected Database.
recoveryServiceSubnetId This property is required. String
(Updatable) The recovery service subnet OCID.
state String
The current state of the Protected Database.
recoveryServiceSubnetId This property is required. string
(Updatable) The recovery service subnet OCID.
state string
The current state of the Protected Database.
recovery_service_subnet_id This property is required. str
(Updatable) The recovery service subnet OCID.
state str
The current state of the Protected Database.
recoveryServiceSubnetId This property is required. String
(Updatable) The recovery service subnet OCID.
state String
The current state of the Protected Database.

Import

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

$ pulumi import oci:RecoveryMod/protectedDatabase:ProtectedDatabase test_protected_database "id"
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci