Oracle Cloud Infrastructure v2.30.0, Apr 14 25

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

oci.RecoveryMod.getProtectedDatabases

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const testProtectedDatabases = oci.RecoveryMod.getProtectedDatabases({
    compartmentId: compartmentId,
    displayName: protectedDatabaseDisplayName,
    id: protectedDatabaseId,
    protectionPolicyId: testProtectionPolicy.id,
    recoveryServiceSubnetId: testRecoveryServiceSubnet.id,
    state: protectedDatabaseState,
});

import pulumi
import pulumi_oci as oci

test_protected_databases = oci.RecoveryMod.get_protected_databases(compartment_id=compartment_id,
    display_name=protected_database_display_name,
    id=protected_database_id,
    protection_policy_id=test_protection_policy["id"],
    recovery_service_subnet_id=test_recovery_service_subnet["id"],
    state=protected_database_state)

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.GetProtectedDatabases(ctx, &recoverymod.GetProtectedDatabasesArgs{
			CompartmentId:           compartmentId,
			DisplayName:             pulumi.StringRef(protectedDatabaseDisplayName),
			Id:                      pulumi.StringRef(protectedDatabaseId),
			ProtectionPolicyId:      pulumi.StringRef(testProtectionPolicy.Id),
			RecoveryServiceSubnetId: pulumi.StringRef(testRecoveryServiceSubnet.Id),
			State:                   pulumi.StringRef(protectedDatabaseState),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testProtectedDatabases = Oci.RecoveryMod.GetProtectedDatabases.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = protectedDatabaseDisplayName,
        Id = protectedDatabaseId,
        ProtectionPolicyId = testProtectionPolicy.Id,
        RecoveryServiceSubnetId = testRecoveryServiceSubnet.Id,
        State = protectedDatabaseState,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.RecoveryMod.RecoveryModFunctions;
import com.pulumi.oci.RecoveryMod.inputs.GetProtectedDatabasesArgs;
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) {
        final var testProtectedDatabases = RecoveryModFunctions.getProtectedDatabases(GetProtectedDatabasesArgs.builder()
            .compartmentId(compartmentId)
            .displayName(protectedDatabaseDisplayName)
            .id(protectedDatabaseId)
            .protectionPolicyId(testProtectionPolicy.id())
            .recoveryServiceSubnetId(testRecoveryServiceSubnet.id())
            .state(protectedDatabaseState)
            .build());

    }
}

variables:
  testProtectedDatabases:
    fn::invoke:
      function: oci:RecoveryMod:getProtectedDatabases
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${protectedDatabaseDisplayName}
        id: ${protectedDatabaseId}
        protectionPolicyId: ${testProtectionPolicy.id}
        recoveryServiceSubnetId: ${testRecoveryServiceSubnet.id}
        state: ${protectedDatabaseState}

Using getProtectedDatabases

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getProtectedDatabases(args: GetProtectedDatabasesArgs, opts?: InvokeOptions): Promise<GetProtectedDatabasesResult>
function getProtectedDatabasesOutput(args: GetProtectedDatabasesOutputArgs, opts?: InvokeOptions): Output<GetProtectedDatabasesResult>

def get_protected_databases(compartment_id: Optional[str] = None,
                            display_name: Optional[str] = None,
                            filters: Optional[Sequence[_recoverymod.GetProtectedDatabasesFilter]] = None,
                            id: Optional[str] = None,
                            protection_policy_id: Optional[str] = None,
                            recovery_service_subnet_id: Optional[str] = None,
                            state: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetProtectedDatabasesResult
def get_protected_databases_output(compartment_id: Optional[pulumi.Input[str]] = None,
                            display_name: Optional[pulumi.Input[str]] = None,
                            filters: Optional[pulumi.Input[Sequence[pulumi.Input[_recoverymod.GetProtectedDatabasesFilterArgs]]]] = None,
                            id: Optional[pulumi.Input[str]] = None,
                            protection_policy_id: Optional[pulumi.Input[str]] = None,
                            recovery_service_subnet_id: Optional[pulumi.Input[str]] = None,
                            state: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetProtectedDatabasesResult]

func GetProtectedDatabases(ctx *Context, args *GetProtectedDatabasesArgs, opts ...InvokeOption) (*GetProtectedDatabasesResult, error)
func GetProtectedDatabasesOutput(ctx *Context, args *GetProtectedDatabasesOutputArgs, opts ...InvokeOption) GetProtectedDatabasesResultOutput

> Note: This function is named GetProtectedDatabases in the Go SDK.

public static class GetProtectedDatabases 
{
    public static Task<GetProtectedDatabasesResult> InvokeAsync(GetProtectedDatabasesArgs args, InvokeOptions? opts = null)
    public static Output<GetProtectedDatabasesResult> Invoke(GetProtectedDatabasesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetProtectedDatabasesResult> getProtectedDatabases(GetProtectedDatabasesArgs args, InvokeOptions options)
public static Output<GetProtectedDatabasesResult> getProtectedDatabases(GetProtectedDatabasesArgs args, InvokeOptions options)

fn::invoke:
  function: oci:RecoveryMod/getProtectedDatabases:getProtectedDatabases
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The compartment OCID.
DisplayName string: A filter to return only resources that match the entire 'displayname' given.
Filters List<GetProtectedDatabasesFilter>
Id string: The protected database OCID.
ProtectionPolicyId string: The protection policy OCID.
RecoveryServiceSubnetId string: The recovery service subnet OCID.
State string: A filter to return only the resources that match the specified lifecycle state.

CompartmentId string: The compartment OCID.
DisplayName string: A filter to return only resources that match the entire 'displayname' given.
Filters []GetProtectedDatabasesFilter
Id string: The protected database OCID.
ProtectionPolicyId string: The protection policy OCID.
RecoveryServiceSubnetId string: The recovery service subnet OCID.
State string: A filter to return only the resources that match the specified lifecycle state.

compartmentId String: The compartment OCID.
displayName String: A filter to return only resources that match the entire 'displayname' given.
filters List<GetProtectedDatabasesFilter>
id String: The protected database OCID.
protectionPolicyId String: The protection policy OCID.
recoveryServiceSubnetId String: The recovery service subnet OCID.
state String: A filter to return only the resources that match the specified lifecycle state.

compartmentId string: The compartment OCID.
displayName string: A filter to return only resources that match the entire 'displayname' given.
filters GetProtectedDatabasesFilter[]
id string: The protected database OCID.
protectionPolicyId string: The protection policy OCID.
recoveryServiceSubnetId string: The recovery service subnet OCID.
state string: A filter to return only the resources that match the specified lifecycle state.

compartment_id str: The compartment OCID.
display_name str: A filter to return only resources that match the entire 'displayname' given.
filters Sequence[recoverymod.GetProtectedDatabasesFilter]
id str: The protected database OCID.
protection_policy_id str: The protection policy OCID.
recovery_service_subnet_id str: The recovery service subnet OCID.
state str: A filter to return only the resources that match the specified lifecycle state.

compartmentId String: The compartment OCID.
displayName String: A filter to return only resources that match the entire 'displayname' given.
filters List<Property Map>
id String: The protected database OCID.
protectionPolicyId String: The protection policy OCID.
recoveryServiceSubnetId String: The recovery service subnet OCID.
state String: A filter to return only the resources that match the specified lifecycle state.

getProtectedDatabases Result

The following output properties are available:

CompartmentId string: The OCID of the compartment that contains the protected database.
ProtectedDatabaseCollections List<GetProtectedDatabasesProtectedDatabaseCollection>: The list of protected_database_collection.
DisplayName string: The protected database name. You can change the displayName. Avoid entering confidential information.
Filters List<GetProtectedDatabasesFilter>
Id string: The OCID of the protected database.
ProtectionPolicyId string: The OCID of the protection policy associated with the protected database.
RecoveryServiceSubnetId string: Recovery Service Subnet Identifier.
State string: The current state of the Protected Database.

CompartmentId string: The OCID of the compartment that contains the protected database.
ProtectedDatabaseCollections []GetProtectedDatabasesProtectedDatabaseCollection: The list of protected_database_collection.
DisplayName string: The protected database name. You can change the displayName. Avoid entering confidential information.
Filters []GetProtectedDatabasesFilter
Id string: The OCID of the protected database.
ProtectionPolicyId string: The OCID of the protection policy associated with the protected database.
RecoveryServiceSubnetId string: Recovery Service Subnet Identifier.
State string: The current state of the Protected Database.

compartmentId String: The OCID of the compartment that contains the protected database.
protectedDatabaseCollections List<GetProtectedDatabasesProtectedDatabaseCollection>: The list of protected_database_collection.
displayName String: The protected database name. You can change the displayName. Avoid entering confidential information.
filters List<GetProtectedDatabasesFilter>
id String: The OCID of the protected database.
protectionPolicyId String: The OCID of the protection policy associated with the protected database.
recoveryServiceSubnetId String: Recovery Service Subnet Identifier.
state String: The current state of the Protected Database.

compartmentId string: The OCID of the compartment that contains the protected database.
protectedDatabaseCollections GetProtectedDatabasesProtectedDatabaseCollection[]: The list of protected_database_collection.
displayName string: The protected database name. You can change the displayName. Avoid entering confidential information.
filters GetProtectedDatabasesFilter[]
id string: The OCID of the protected database.
protectionPolicyId string: The OCID of the protection policy associated with the protected database.
recoveryServiceSubnetId string: Recovery Service Subnet Identifier.
state string: The current state of the Protected Database.

compartment_id str: The OCID of the compartment that contains the protected database.
protected_database_collections Sequence[recoverymod.GetProtectedDatabasesProtectedDatabaseCollection]: The list of protected_database_collection.
display_name str: The protected database name. You can change the displayName. Avoid entering confidential information.
filters Sequence[recoverymod.GetProtectedDatabasesFilter]
id str: The OCID of the protected database.
protection_policy_id str: The OCID of the protection policy associated with the protected database.
recovery_service_subnet_id str: Recovery Service Subnet Identifier.
state str: The current state of the Protected Database.

compartmentId String: The OCID of the compartment that contains the protected database.
protectedDatabaseCollections List<Property Map>: The list of protected_database_collection.
displayName String: The protected database name. You can change the displayName. Avoid entering confidential information.
filters List<Property Map>
id String: The OCID of the protected database.
protectionPolicyId String: The OCID of the protection policy associated with the protected database.
recoveryServiceSubnetId String: Recovery Service Subnet Identifier.
state String: The current state of the Protected Database.

Supporting Types

GetProtectedDatabasesFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values List<String>
regex Boolean

GetProtectedDatabasesProtectedDatabaseCollection

Items List<GetProtectedDatabasesProtectedDatabaseCollectionItem>

Items []GetProtectedDatabasesProtectedDatabaseCollectionItem

items List<GetProtectedDatabasesProtectedDatabaseCollectionItem>

items GetProtectedDatabasesProtectedDatabaseCollectionItem[]

items Sequence[recoverymod.GetProtectedDatabasesProtectedDatabaseCollectionItem]

items List<Property Map>

GetProtectedDatabasesProtectedDatabaseCollectionItem

CompartmentId string: The compartment OCID.
DatabaseId string: The OCID of the protected database.
DatabaseSize string: 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 string: The dbUniqueName for the protected database in Recovery Service. You cannot change the unique name.
DefinedTags Dictionary<string, string>: 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
DisplayName string: A filter to return only resources that match the entire 'displayname' given.
FreeformTags Dictionary<string, string>: 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.
Id string: The protected database OCID.
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: 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. For this to be effective, additional configuration is needed on client side.
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<GetProtectedDatabasesProtectedDatabaseCollectionItemMetric>: Backup performance and storage utilization metrics for the protected database.
Password string
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: The protection policy OCID.
RecoveryServiceSubnets List<GetProtectedDatabasesProtectedDatabaseCollectionItemRecoveryServiceSubnet>: List of recovery service subnet resources associated with the protected database.
State string: A filter to return only the resources that match the specified lifecycle state.
SubscriptionId string: The OCID of the cloud service subscription to which the protected database is linked.
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: The compartment OCID.
DatabaseId string: The OCID of the protected database.
DatabaseSize string: 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 string: The dbUniqueName for the protected database in Recovery Service. You cannot change the unique name.
DefinedTags map[string]string: 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
DisplayName string: A filter to return only resources that match the entire 'displayname' given.
FreeformTags map[string]string: 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.
Id string: The protected database OCID.
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: 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. For this to be effective, additional configuration is needed on client side.
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 []GetProtectedDatabasesProtectedDatabaseCollectionItemMetric: Backup performance and storage utilization metrics for the protected database.
Password string
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: The protection policy OCID.
RecoveryServiceSubnets []GetProtectedDatabasesProtectedDatabaseCollectionItemRecoveryServiceSubnet: List of recovery service subnet resources associated with the protected database.
State string: A filter to return only the resources that match the specified lifecycle state.
SubscriptionId string: The OCID of the cloud service subscription to which the protected database is linked.
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: The compartment OCID.
databaseId String: The OCID of the protected database.
databaseSize String: 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 String: The dbUniqueName for the protected database in Recovery Service. You cannot change the unique name.
definedTags Map<String,String>: 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
displayName String: A filter to return only resources that match the entire 'displayname' given.
freeformTags Map<String,String>: 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.
id String: The protected database OCID.
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: 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. For this to be effective, additional configuration is needed on client side.
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<GetProtectedDatabasesProtectedDatabaseCollectionItemMetric>: Backup performance and storage utilization metrics for the protected database.
password String
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: The protection policy OCID.
recoveryServiceSubnets List<GetProtectedDatabasesProtectedDatabaseCollectionItemRecoveryServiceSubnet>: List of recovery service subnet resources associated with the protected database.
state String: A filter to return only the resources that match the specified lifecycle state.
subscriptionId String: The OCID of the cloud service subscription to which the protected database is linked.
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: The compartment OCID.
databaseId string: The OCID of the protected database.
databaseSize string: 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 string: The dbUniqueName for the protected database in Recovery Service. You cannot change the unique name.
definedTags {[key: string]: string}: 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
displayName string: A filter to return only resources that match the entire 'displayname' given.
freeformTags {[key: string]: string}: 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.
id string: The protected database OCID.
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: 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. For this to be effective, additional configuration is needed on client side.
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 GetProtectedDatabasesProtectedDatabaseCollectionItemMetric[]: Backup performance and storage utilization metrics for the protected database.
password string
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: The protection policy OCID.
recoveryServiceSubnets GetProtectedDatabasesProtectedDatabaseCollectionItemRecoveryServiceSubnet[]: List of recovery service subnet resources associated with the protected database.
state string: A filter to return only the resources that match the specified lifecycle state.
subscriptionId string: The OCID of the cloud service subscription to which the protected database is linked.
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: The compartment OCID.
database_id str: The OCID of the protected database.
database_size str: 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 str: The dbUniqueName for the protected database in Recovery Service. You cannot change the unique name.
defined_tags Mapping[str, str]: 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
display_name str: A filter to return only resources that match the entire 'displayname' given.
freeform_tags Mapping[str, str]: 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.
id str: The protected database OCID.
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: 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. For this to be effective, additional configuration is needed on client side.
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.GetProtectedDatabasesProtectedDatabaseCollectionItemMetric]: Backup performance and storage utilization metrics for the protected database.
password str
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: The protection policy OCID.
recovery_service_subnets Sequence[recoverymod.GetProtectedDatabasesProtectedDatabaseCollectionItemRecoveryServiceSubnet]: List of recovery service subnet resources associated with the protected database.
state str: A filter to return only the resources that match the specified lifecycle state.
subscription_id str: The OCID of the cloud service subscription to which the protected database is linked.
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: The compartment OCID.
databaseId String: The OCID of the protected database.
databaseSize String: 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 String: The dbUniqueName for the protected database in Recovery Service. You cannot change the unique name.
definedTags Map<String>: 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
displayName String: A filter to return only resources that match the entire 'displayname' given.
freeformTags Map<String>: 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.
id String: The protected database OCID.
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: 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. For this to be effective, additional configuration is needed on client side.
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
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: The protection policy OCID.
recoveryServiceSubnets List<Property Map>: List of recovery service subnet resources associated with the protected database.
state String: A filter to return only the resources that match the specified lifecycle state.
subscriptionId String: The OCID of the cloud service subscription to which the protected database is linked.
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.

GetProtectedDatabasesProtectedDatabaseCollectionItemMetric

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.

GetProtectedDatabasesProtectedDatabaseCollectionItemRecoveryServiceSubnet

RecoveryServiceSubnetId string: The recovery service subnet OCID.
State string: A filter to return only the resources that match the specified lifecycle state.

RecoveryServiceSubnetId string: The recovery service subnet OCID.
State string: A filter to return only the resources that match the specified lifecycle state.

recoveryServiceSubnetId String: The recovery service subnet OCID.
state String: A filter to return only the resources that match the specified lifecycle state.

recoveryServiceSubnetId string: The recovery service subnet OCID.
state string: A filter to return only the resources that match the specified lifecycle state.

recovery_service_subnet_id str: The recovery service subnet OCID.
state str: A filter to return only the resources that match the specified lifecycle state.

recoveryServiceSubnetId String: The recovery service subnet OCID.
state String: A filter to return only the resources that match the specified lifecycle state.

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.30.0 published on Monday, Apr 14, 2025 by Pulumi

pulumi/pulumi-oci

oci.RecoveryMod.getProtectedDatabases

On this page

On this page

Example Usage

Using getProtectedDatabases

getProtectedDatabases Result

Supporting Types

GetProtectedDatabasesFilter

GetProtectedDatabasesProtectedDatabaseCollection

GetProtectedDatabasesProtectedDatabaseCollectionItem

GetProtectedDatabasesProtectedDatabaseCollectionItemMetric

GetProtectedDatabasesProtectedDatabaseCollectionItemRecoveryServiceSubnet

Package Details

On this page

On this page