1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Database
  5. getDatabases
Oracle Cloud Infrastructure v2.3.0 published on Wednesday, Jul 17, 2024 by Pulumi

oci.Database.getDatabases

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.3.0 published on Wednesday, Jul 17, 2024 by Pulumi

    This data source provides the list of Databases in Oracle Cloud Infrastructure Database service.

    Gets a list of the databases in the specified Database Home.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testDatabases = oci.Database.getDatabases({
        compartmentId: compartmentId,
        dbHomeId: testDbHome.id,
        dbName: databaseDbName,
        state: databaseState,
        systemId: testSystem.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_databases = oci.Database.get_databases(compartment_id=compartment_id,
        db_home_id=test_db_home["id"],
        db_name=database_db_name,
        state=database_state,
        system_id=test_system["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Database"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Database.GetDatabases(ctx, &database.GetDatabasesArgs{
    			CompartmentId: compartmentId,
    			DbHomeId:      pulumi.StringRef(testDbHome.Id),
    			DbName:        pulumi.StringRef(databaseDbName),
    			State:         pulumi.StringRef(databaseState),
    			SystemId:      pulumi.StringRef(testSystem.Id),
    		}, 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 testDatabases = Oci.Database.GetDatabases.Invoke(new()
        {
            CompartmentId = compartmentId,
            DbHomeId = testDbHome.Id,
            DbName = databaseDbName,
            State = databaseState,
            SystemId = testSystem.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Database.DatabaseFunctions;
    import com.pulumi.oci.Database.inputs.GetDatabasesArgs;
    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 testDatabases = DatabaseFunctions.getDatabases(GetDatabasesArgs.builder()
                .compartmentId(compartmentId)
                .dbHomeId(testDbHome.id())
                .dbName(databaseDbName)
                .state(databaseState)
                .systemId(testSystem.id())
                .build());
    
        }
    }
    
    variables:
      testDatabases:
        fn::invoke:
          Function: oci:Database:getDatabases
          Arguments:
            compartmentId: ${compartmentId}
            dbHomeId: ${testDbHome.id}
            dbName: ${databaseDbName}
            state: ${databaseState}
            systemId: ${testSystem.id}
    

    Using getDatabases

    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.

    function getDatabases(args: GetDatabasesArgs, opts?: InvokeOptions): Promise<GetDatabasesResult>
    function getDatabasesOutput(args: GetDatabasesOutputArgs, opts?: InvokeOptions): Output<GetDatabasesResult>
    def get_databases(compartment_id: Optional[str] = None,
                      db_home_id: Optional[str] = None,
                      db_name: Optional[str] = None,
                      filters: Optional[Sequence[_database.GetDatabasesFilter]] = None,
                      state: Optional[str] = None,
                      system_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetDatabasesResult
    def get_databases_output(compartment_id: Optional[pulumi.Input[str]] = None,
                      db_home_id: Optional[pulumi.Input[str]] = None,
                      db_name: Optional[pulumi.Input[str]] = None,
                      filters: Optional[pulumi.Input[Sequence[pulumi.Input[_database.GetDatabasesFilterArgs]]]] = None,
                      state: Optional[pulumi.Input[str]] = None,
                      system_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetDatabasesResult]
    func GetDatabases(ctx *Context, args *GetDatabasesArgs, opts ...InvokeOption) (*GetDatabasesResult, error)
    func GetDatabasesOutput(ctx *Context, args *GetDatabasesOutputArgs, opts ...InvokeOption) GetDatabasesResultOutput

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

    public static class GetDatabases 
    {
        public static Task<GetDatabasesResult> InvokeAsync(GetDatabasesArgs args, InvokeOptions? opts = null)
        public static Output<GetDatabasesResult> Invoke(GetDatabasesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDatabasesResult> getDatabases(GetDatabasesArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Database/getDatabases:getDatabases
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The compartment OCID.
    DbHomeId string
    A Database Home OCID. *Note: Either db_home_id or system_id is required to make the LIST API call.
    DbName string
    A filter to return only resources that match the entire database name given. The match is not case sensitive.
    Filters List<GetDatabasesFilter>
    State string
    A filter to return only resources that match the given lifecycle state exactly.
    SystemId string
    The OCID of the Exadata DB system that you want to filter the database results by. Applies only to Exadata DB systems.
    CompartmentId string
    The compartment OCID.
    DbHomeId string
    A Database Home OCID. *Note: Either db_home_id or system_id is required to make the LIST API call.
    DbName string
    A filter to return only resources that match the entire database name given. The match is not case sensitive.
    Filters []GetDatabasesFilter
    State string
    A filter to return only resources that match the given lifecycle state exactly.
    SystemId string
    The OCID of the Exadata DB system that you want to filter the database results by. Applies only to Exadata DB systems.
    compartmentId String
    The compartment OCID.
    dbHomeId String
    A Database Home OCID. *Note: Either db_home_id or system_id is required to make the LIST API call.
    dbName String
    A filter to return only resources that match the entire database name given. The match is not case sensitive.
    filters List<GetsFilter>
    state String
    A filter to return only resources that match the given lifecycle state exactly.
    systemId String
    The OCID of the Exadata DB system that you want to filter the database results by. Applies only to Exadata DB systems.
    compartmentId string
    The compartment OCID.
    dbHomeId string
    A Database Home OCID. *Note: Either db_home_id or system_id is required to make the LIST API call.
    dbName string
    A filter to return only resources that match the entire database name given. The match is not case sensitive.
    filters GetDatabasesFilter[]
    state string
    A filter to return only resources that match the given lifecycle state exactly.
    systemId string
    The OCID of the Exadata DB system that you want to filter the database results by. Applies only to Exadata DB systems.
    compartment_id str
    The compartment OCID.
    db_home_id str
    A Database Home OCID. *Note: Either db_home_id or system_id is required to make the LIST API call.
    db_name str
    A filter to return only resources that match the entire database name given. The match is not case sensitive.
    filters Sequence[database.GetDatabasesFilter]
    state str
    A filter to return only resources that match the given lifecycle state exactly.
    system_id str
    The OCID of the Exadata DB system that you want to filter the database results by. Applies only to Exadata DB systems.
    compartmentId String
    The compartment OCID.
    dbHomeId String
    A Database Home OCID. *Note: Either db_home_id or system_id is required to make the LIST API call.
    dbName String
    A filter to return only resources that match the entire database name given. The match is not case sensitive.
    filters List<Property Map>
    state String
    A filter to return only resources that match the given lifecycle state exactly.
    systemId String
    The OCID of the Exadata DB system that you want to filter the database results by. Applies only to Exadata DB systems.

    getDatabases Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment.
    Databases List<GetDatabasesDatabase>
    The list of databases.
    Id string
    The provider-assigned unique ID for this managed resource.
    DbHomeId string
    The OCID of the Database Home.
    DbName string
    The database name.
    Filters List<GetDatabasesFilter>
    State string
    The current state of the database.
    SystemId string
    CompartmentId string
    The OCID of the compartment.
    Databases []GetDatabasesDatabase
    The list of databases.
    Id string
    The provider-assigned unique ID for this managed resource.
    DbHomeId string
    The OCID of the Database Home.
    DbName string
    The database name.
    Filters []GetDatabasesFilter
    State string
    The current state of the database.
    SystemId string
    compartmentId String
    The OCID of the compartment.
    databases List<Gets>
    The list of databases.
    id String
    The provider-assigned unique ID for this managed resource.
    dbHomeId String
    The OCID of the Database Home.
    dbName String
    The database name.
    filters List<GetsFilter>
    state String
    The current state of the database.
    systemId String
    compartmentId string
    The OCID of the compartment.
    databases GetDatabasesDatabase[]
    The list of databases.
    id string
    The provider-assigned unique ID for this managed resource.
    dbHomeId string
    The OCID of the Database Home.
    dbName string
    The database name.
    filters GetDatabasesFilter[]
    state string
    The current state of the database.
    systemId string
    compartment_id str
    The OCID of the compartment.
    databases Sequence[database.GetDatabasesDatabase]
    The list of databases.
    id str
    The provider-assigned unique ID for this managed resource.
    db_home_id str
    The OCID of the Database Home.
    db_name str
    The database name.
    filters Sequence[database.GetDatabasesFilter]
    state str
    The current state of the database.
    system_id str
    compartmentId String
    The OCID of the compartment.
    databases List<Property Map>
    The list of databases.
    id String
    The provider-assigned unique ID for this managed resource.
    dbHomeId String
    The OCID of the Database Home.
    dbName String
    The database name.
    filters List<Property Map>
    state String
    The current state of the database.
    systemId String

    Supporting Types

    GetDatabasesDatabase

    CharacterSet string
    The character set for the database.
    CompartmentId string
    The compartment OCID.
    ConnectionStrings List<GetDatabasesDatabaseConnectionString>
    The Connection strings used to connect to the Oracle Database.
    DatabaseManagementConfigs List<GetDatabasesDatabaseDatabaseManagementConfig>
    The configuration of the Database Management service.
    DatabaseSoftwareImageId string
    The database software image OCID
    Databases List<GetDatabasesDatabaseDatabase>
    DbBackupConfigs List<GetDatabasesDatabaseDbBackupConfig>
    Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
    DbHomeId string
    A Database Home OCID. *Note: Either db_home_id or system_id is required to make the LIST API call.
    DbName string
    A filter to return only resources that match the entire database name given. The match is not case sensitive.
    DbSystemId string
    The OCID of the DB system.
    DbUniqueName string
    A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
    DbVersion string
    DbWorkload string
    Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
    DefinedTags Dictionary<string, object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    FreeformTags Dictionary<string, object>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of the database.
    IsCdb bool
    True if the database is a container database.
    KeyStoreId string
    The OCID of the key store.
    KeyStoreWalletName string
    The wallet name for Oracle Key Vault.
    KmsKeyId string
    The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
    KmsKeyMigration bool
    KmsKeyRotation int
    KmsKeyVersionId string
    The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.
    LastBackupDurationInSeconds int
    The duration when the latest database backup created.
    LastBackupTimestamp string
    The date and time when the latest database backup was created.
    LastFailedBackupTimestamp string
    The date and time when the latest database backup failed.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    NcharacterSet string
    The national character set for the database.
    PdbName string
    The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
    SidPrefix string
    Specifies a prefix for the Oracle SID of the database to be created.
    Source string
    SourceDatabasePointInTimeRecoveryTimestamp string
    Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
    State string
    A filter to return only resources that match the given lifecycle state exactly.
    TimeCreated string
    The date and time the database was created.
    VaultId string
    The OCID of the Oracle Cloud Infrastructure vault.
    VmClusterId string
    The OCID of the VM cluster.
    CharacterSet string
    The character set for the database.
    CompartmentId string
    The compartment OCID.
    ConnectionStrings []GetDatabasesDatabaseConnectionString
    The Connection strings used to connect to the Oracle Database.
    DatabaseManagementConfigs []GetDatabasesDatabaseDatabaseManagementConfig
    The configuration of the Database Management service.
    DatabaseSoftwareImageId string
    The database software image OCID
    Databases []GetDatabasesDatabaseDatabase
    DbBackupConfigs []GetDatabasesDatabaseDbBackupConfig
    Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
    DbHomeId string
    A Database Home OCID. *Note: Either db_home_id or system_id is required to make the LIST API call.
    DbName string
    A filter to return only resources that match the entire database name given. The match is not case sensitive.
    DbSystemId string
    The OCID of the DB system.
    DbUniqueName string
    A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
    DbVersion string
    DbWorkload string
    Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
    DefinedTags map[string]interface{}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    FreeformTags map[string]interface{}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of the database.
    IsCdb bool
    True if the database is a container database.
    KeyStoreId string
    The OCID of the key store.
    KeyStoreWalletName string
    The wallet name for Oracle Key Vault.
    KmsKeyId string
    The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
    KmsKeyMigration bool
    KmsKeyRotation int
    KmsKeyVersionId string
    The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.
    LastBackupDurationInSeconds int
    The duration when the latest database backup created.
    LastBackupTimestamp string
    The date and time when the latest database backup was created.
    LastFailedBackupTimestamp string
    The date and time when the latest database backup failed.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    NcharacterSet string
    The national character set for the database.
    PdbName string
    The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
    SidPrefix string
    Specifies a prefix for the Oracle SID of the database to be created.
    Source string
    SourceDatabasePointInTimeRecoveryTimestamp string
    Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
    State string
    A filter to return only resources that match the given lifecycle state exactly.
    TimeCreated string
    The date and time the database was created.
    VaultId string
    The OCID of the Oracle Cloud Infrastructure vault.
    VmClusterId string
    The OCID of the VM cluster.
    characterSet String
    The character set for the database.
    compartmentId String
    The compartment OCID.
    connectionStrings List<GetsConnectionString>
    The Connection strings used to connect to the Oracle Database.
    databaseManagementConfigs List<GetsManagementConfig>
    The configuration of the Database Management service.
    databaseSoftwareImageId String
    The database software image OCID
    databases List<Gets>
    dbBackupConfigs List<GetsDbBackupConfig>
    Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
    dbHomeId String
    A Database Home OCID. *Note: Either db_home_id or system_id is required to make the LIST API call.
    dbName String
    A filter to return only resources that match the entire database name given. The match is not case sensitive.
    dbSystemId String
    The OCID of the DB system.
    dbUniqueName String
    A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
    dbVersion String
    dbWorkload String
    Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
    definedTags Map<String,Object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    freeformTags Map<String,Object>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of the database.
    isCdb Boolean
    True if the database is a container database.
    keyStoreId String
    The OCID of the key store.
    keyStoreWalletName String
    The wallet name for Oracle Key Vault.
    kmsKeyId String
    The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
    kmsKeyMigration Boolean
    kmsKeyRotation Integer
    kmsKeyVersionId String
    The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.
    lastBackupDurationInSeconds Integer
    The duration when the latest database backup created.
    lastBackupTimestamp String
    The date and time when the latest database backup was created.
    lastFailedBackupTimestamp String
    The date and time when the latest database backup failed.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    ncharacterSet String
    The national character set for the database.
    pdbName String
    The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
    sidPrefix String
    Specifies a prefix for the Oracle SID of the database to be created.
    source String
    sourceDatabasePointInTimeRecoveryTimestamp String
    Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
    state String
    A filter to return only resources that match the given lifecycle state exactly.
    timeCreated String
    The date and time the database was created.
    vaultId String
    The OCID of the Oracle Cloud Infrastructure vault.
    vmClusterId String
    The OCID of the VM cluster.
    characterSet string
    The character set for the database.
    compartmentId string
    The compartment OCID.
    connectionStrings GetDatabasesDatabaseConnectionString[]
    The Connection strings used to connect to the Oracle Database.
    databaseManagementConfigs GetDatabasesDatabaseDatabaseManagementConfig[]
    The configuration of the Database Management service.
    databaseSoftwareImageId string
    The database software image OCID
    databases GetDatabasesDatabaseDatabase[]
    dbBackupConfigs GetDatabasesDatabaseDbBackupConfig[]
    Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
    dbHomeId string
    A Database Home OCID. *Note: Either db_home_id or system_id is required to make the LIST API call.
    dbName string
    A filter to return only resources that match the entire database name given. The match is not case sensitive.
    dbSystemId string
    The OCID of the DB system.
    dbUniqueName string
    A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
    dbVersion string
    dbWorkload string
    Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
    definedTags {[key: string]: any}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    freeformTags {[key: string]: any}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id string
    The OCID of the database.
    isCdb boolean
    True if the database is a container database.
    keyStoreId string
    The OCID of the key store.
    keyStoreWalletName string
    The wallet name for Oracle Key Vault.
    kmsKeyId string
    The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
    kmsKeyMigration boolean
    kmsKeyRotation number
    kmsKeyVersionId string
    The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.
    lastBackupDurationInSeconds number
    The duration when the latest database backup created.
    lastBackupTimestamp string
    The date and time when the latest database backup was created.
    lastFailedBackupTimestamp string
    The date and time when the latest database backup failed.
    lifecycleDetails string
    Additional information about the current lifecycle state.
    ncharacterSet string
    The national character set for the database.
    pdbName string
    The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
    sidPrefix string
    Specifies a prefix for the Oracle SID of the database to be created.
    source string
    sourceDatabasePointInTimeRecoveryTimestamp string
    Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
    state string
    A filter to return only resources that match the given lifecycle state exactly.
    timeCreated string
    The date and time the database was created.
    vaultId string
    The OCID of the Oracle Cloud Infrastructure vault.
    vmClusterId string
    The OCID of the VM cluster.
    character_set str
    The character set for the database.
    compartment_id str
    The compartment OCID.
    connection_strings Sequence[database.GetDatabasesDatabaseConnectionString]
    The Connection strings used to connect to the Oracle Database.
    database_management_configs Sequence[database.GetDatabasesDatabaseDatabaseManagementConfig]
    The configuration of the Database Management service.
    database_software_image_id str
    The database software image OCID
    databases Sequence[database.GetDatabasesDatabaseDatabase]
    db_backup_configs Sequence[database.GetDatabasesDatabaseDbBackupConfig]
    Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
    db_home_id str
    A Database Home OCID. *Note: Either db_home_id or system_id is required to make the LIST API call.
    db_name str
    A filter to return only resources that match the entire database name given. The match is not case sensitive.
    db_system_id str
    The OCID of the DB system.
    db_unique_name str
    A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
    db_version str
    db_workload str
    Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
    defined_tags Mapping[str, Any]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    freeform_tags Mapping[str, Any]
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id str
    The OCID of the database.
    is_cdb bool
    True if the database is a container database.
    key_store_id str
    The OCID of the key store.
    key_store_wallet_name str
    The wallet name for Oracle Key Vault.
    kms_key_id str
    The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
    kms_key_migration bool
    kms_key_rotation int
    kms_key_version_id str
    The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.
    last_backup_duration_in_seconds int
    The duration when the latest database backup created.
    last_backup_timestamp str
    The date and time when the latest database backup was created.
    last_failed_backup_timestamp str
    The date and time when the latest database backup failed.
    lifecycle_details str
    Additional information about the current lifecycle state.
    ncharacter_set str
    The national character set for the database.
    pdb_name str
    The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
    sid_prefix str
    Specifies a prefix for the Oracle SID of the database to be created.
    source str
    source_database_point_in_time_recovery_timestamp str
    Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
    state str
    A filter to return only resources that match the given lifecycle state exactly.
    time_created str
    The date and time the database was created.
    vault_id str
    The OCID of the Oracle Cloud Infrastructure vault.
    vm_cluster_id str
    The OCID of the VM cluster.
    characterSet String
    The character set for the database.
    compartmentId String
    The compartment OCID.
    connectionStrings List<Property Map>
    The Connection strings used to connect to the Oracle Database.
    databaseManagementConfigs List<Property Map>
    The configuration of the Database Management service.
    databaseSoftwareImageId String
    The database software image OCID
    databases List<Property Map>
    dbBackupConfigs List<Property Map>
    Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
    dbHomeId String
    A Database Home OCID. *Note: Either db_home_id or system_id is required to make the LIST API call.
    dbName String
    A filter to return only resources that match the entire database name given. The match is not case sensitive.
    dbSystemId String
    The OCID of the DB system.
    dbUniqueName String
    A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
    dbVersion String
    dbWorkload String
    Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
    definedTags Map<Any>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    freeformTags Map<Any>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of the database.
    isCdb Boolean
    True if the database is a container database.
    keyStoreId String
    The OCID of the key store.
    keyStoreWalletName String
    The wallet name for Oracle Key Vault.
    kmsKeyId String
    The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
    kmsKeyMigration Boolean
    kmsKeyRotation Number
    kmsKeyVersionId String
    The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.
    lastBackupDurationInSeconds Number
    The duration when the latest database backup created.
    lastBackupTimestamp String
    The date and time when the latest database backup was created.
    lastFailedBackupTimestamp String
    The date and time when the latest database backup failed.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    ncharacterSet String
    The national character set for the database.
    pdbName String
    The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
    sidPrefix String
    Specifies a prefix for the Oracle SID of the database to be created.
    source String
    sourceDatabasePointInTimeRecoveryTimestamp String
    Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
    state String
    A filter to return only resources that match the given lifecycle state exactly.
    timeCreated String
    The date and time the database was created.
    vaultId String
    The OCID of the Oracle Cloud Infrastructure vault.
    vmClusterId String
    The OCID of the VM cluster.

    GetDatabasesDatabaseConnectionString

    AllConnectionStrings Dictionary<string, object>
    All connection strings to use to connect to the Database.
    CdbDefault string
    Host name based CDB Connection String.
    CdbIpDefault string
    IP based CDB Connection String.
    AllConnectionStrings map[string]interface{}
    All connection strings to use to connect to the Database.
    CdbDefault string
    Host name based CDB Connection String.
    CdbIpDefault string
    IP based CDB Connection String.
    allConnectionStrings Map<String,Object>
    All connection strings to use to connect to the Database.
    cdbDefault String
    Host name based CDB Connection String.
    cdbIpDefault String
    IP based CDB Connection String.
    allConnectionStrings {[key: string]: any}
    All connection strings to use to connect to the Database.
    cdbDefault string
    Host name based CDB Connection String.
    cdbIpDefault string
    IP based CDB Connection String.
    all_connection_strings Mapping[str, Any]
    All connection strings to use to connect to the Database.
    cdb_default str
    Host name based CDB Connection String.
    cdb_ip_default str
    IP based CDB Connection String.
    allConnectionStrings Map<Any>
    All connection strings to use to connect to the Database.
    cdbDefault String
    Host name based CDB Connection String.
    cdbIpDefault String
    IP based CDB Connection String.

    GetDatabasesDatabaseDatabase

    AdminPassword string
    BackupId string
    BackupTdePassword string
    CharacterSet string
    The character set for the database.
    DatabaseSoftwareImageId string
    The database software image OCID
    DbBackupConfigs List<GetDatabasesDatabaseDatabaseDbBackupConfig>
    Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
    DbName string
    A filter to return only resources that match the entire database name given. The match is not case sensitive.
    DbUniqueName string
    A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
    DbWorkload string
    Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
    DefinedTags Dictionary<string, object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    FreeformTags Dictionary<string, object>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    KmsKeyId string
    The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
    KmsKeyVersionId string
    The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.
    NcharacterSet string
    The national character set for the database.
    PdbName string
    The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
    PluggableDatabases List<string>
    SidPrefix string
    Specifies a prefix for the Oracle SID of the database to be created.
    TdeWalletPassword string
    VaultId string
    The OCID of the Oracle Cloud Infrastructure vault.
    AdminPassword string
    BackupId string
    BackupTdePassword string
    CharacterSet string
    The character set for the database.
    DatabaseSoftwareImageId string
    The database software image OCID
    DbBackupConfigs []GetDatabasesDatabaseDatabaseDbBackupConfig
    Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
    DbName string
    A filter to return only resources that match the entire database name given. The match is not case sensitive.
    DbUniqueName string
    A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
    DbWorkload string
    Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
    DefinedTags map[string]interface{}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    FreeformTags map[string]interface{}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    KmsKeyId string
    The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
    KmsKeyVersionId string
    The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.
    NcharacterSet string
    The national character set for the database.
    PdbName string
    The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
    PluggableDatabases []string
    SidPrefix string
    Specifies a prefix for the Oracle SID of the database to be created.
    TdeWalletPassword string
    VaultId string
    The OCID of the Oracle Cloud Infrastructure vault.
    adminPassword String
    backupId String
    backupTdePassword String
    characterSet String
    The character set for the database.
    databaseSoftwareImageId String
    The database software image OCID
    dbBackupConfigs List<GetsDbBackupConfig>
    Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
    dbName String
    A filter to return only resources that match the entire database name given. The match is not case sensitive.
    dbUniqueName String
    A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
    dbWorkload String
    Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
    definedTags Map<String,Object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    freeformTags Map<String,Object>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    kmsKeyId String
    The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
    kmsKeyVersionId String
    The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.
    ncharacterSet String
    The national character set for the database.
    pdbName String
    The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
    pluggableDatabases List<String>
    sidPrefix String
    Specifies a prefix for the Oracle SID of the database to be created.
    tdeWalletPassword String
    vaultId String
    The OCID of the Oracle Cloud Infrastructure vault.
    adminPassword string
    backupId string
    backupTdePassword string
    characterSet string
    The character set for the database.
    databaseSoftwareImageId string
    The database software image OCID
    dbBackupConfigs GetDatabasesDatabaseDatabaseDbBackupConfig[]
    Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
    dbName string
    A filter to return only resources that match the entire database name given. The match is not case sensitive.
    dbUniqueName string
    A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
    dbWorkload string
    Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
    definedTags {[key: string]: any}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    freeformTags {[key: string]: any}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    kmsKeyId string
    The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
    kmsKeyVersionId string
    The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.
    ncharacterSet string
    The national character set for the database.
    pdbName string
    The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
    pluggableDatabases string[]
    sidPrefix string
    Specifies a prefix for the Oracle SID of the database to be created.
    tdeWalletPassword string
    vaultId string
    The OCID of the Oracle Cloud Infrastructure vault.
    admin_password str
    backup_id str
    backup_tde_password str
    character_set str
    The character set for the database.
    database_software_image_id str
    The database software image OCID
    db_backup_configs Sequence[database.GetDatabasesDatabaseDatabaseDbBackupConfig]
    Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
    db_name str
    A filter to return only resources that match the entire database name given. The match is not case sensitive.
    db_unique_name str
    A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
    db_workload str
    Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
    defined_tags Mapping[str, Any]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    freeform_tags Mapping[str, Any]
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    kms_key_id str
    The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
    kms_key_version_id str
    The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.
    ncharacter_set str
    The national character set for the database.
    pdb_name str
    The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
    pluggable_databases Sequence[str]
    sid_prefix str
    Specifies a prefix for the Oracle SID of the database to be created.
    tde_wallet_password str
    vault_id str
    The OCID of the Oracle Cloud Infrastructure vault.
    adminPassword String
    backupId String
    backupTdePassword String
    characterSet String
    The character set for the database.
    databaseSoftwareImageId String
    The database software image OCID
    dbBackupConfigs List<Property Map>
    Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
    dbName String
    A filter to return only resources that match the entire database name given. The match is not case sensitive.
    dbUniqueName String
    A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
    dbWorkload String
    Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
    definedTags Map<Any>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    freeformTags Map<Any>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    kmsKeyId String
    The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
    kmsKeyVersionId String
    The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.
    ncharacterSet String
    The national character set for the database.
    pdbName String
    The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
    pluggableDatabases List<String>
    sidPrefix String
    Specifies a prefix for the Oracle SID of the database to be created.
    tdeWalletPassword String
    vaultId String
    The OCID of the Oracle Cloud Infrastructure vault.

    GetDatabasesDatabaseDatabaseDbBackupConfig

    AutoBackupEnabled bool
    If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
    AutoBackupWindow string
    Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
    AutoFullBackupDay string
    Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
    AutoFullBackupWindow string
    Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
    BackupDeletionPolicy string
    This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
    BackupDestinationDetails List<GetDatabasesDatabaseDatabaseDbBackupConfigBackupDestinationDetail>
    Backup destination details.
    RecoveryWindowInDays int
    Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
    RunImmediateFullBackup bool
    If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
    AutoBackupEnabled bool
    If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
    AutoBackupWindow string
    Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
    AutoFullBackupDay string
    Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
    AutoFullBackupWindow string
    Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
    BackupDeletionPolicy string
    This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
    BackupDestinationDetails []GetDatabasesDatabaseDatabaseDbBackupConfigBackupDestinationDetail
    Backup destination details.
    RecoveryWindowInDays int
    Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
    RunImmediateFullBackup bool
    If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
    autoBackupEnabled Boolean
    If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
    autoBackupWindow String
    Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
    autoFullBackupDay String
    Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
    autoFullBackupWindow String
    Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
    backupDeletionPolicy String
    This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
    backupDestinationDetails List<GetsDbBackupConfigBackupDestinationDetail>
    Backup destination details.
    recoveryWindowInDays Integer
    Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
    runImmediateFullBackup Boolean
    If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
    autoBackupEnabled boolean
    If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
    autoBackupWindow string
    Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
    autoFullBackupDay string
    Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
    autoFullBackupWindow string
    Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
    backupDeletionPolicy string
    This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
    backupDestinationDetails GetDatabasesDatabaseDatabaseDbBackupConfigBackupDestinationDetail[]
    Backup destination details.
    recoveryWindowInDays number
    Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
    runImmediateFullBackup boolean
    If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
    auto_backup_enabled bool
    If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
    auto_backup_window str
    Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
    auto_full_backup_day str
    Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
    auto_full_backup_window str
    Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
    backup_deletion_policy str
    This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
    backup_destination_details Sequence[database.GetDatabasesDatabaseDatabaseDbBackupConfigBackupDestinationDetail]
    Backup destination details.
    recovery_window_in_days int
    Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
    run_immediate_full_backup bool
    If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
    autoBackupEnabled Boolean
    If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
    autoBackupWindow String
    Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
    autoFullBackupDay String
    Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
    autoFullBackupWindow String
    Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
    backupDeletionPolicy String
    This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
    backupDestinationDetails List<Property Map>
    Backup destination details.
    recoveryWindowInDays Number
    Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
    runImmediateFullBackup Boolean
    If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

    GetDatabasesDatabaseDatabaseDbBackupConfigBackupDestinationDetail

    DbrsPolicyId string
    The OCID of the DBRS policy used for backup.
    Id string
    The OCID of the database.
    Type string
    Type of the database backup destination.
    VpcUser string
    DbrsPolicyId string
    The OCID of the DBRS policy used for backup.
    Id string
    The OCID of the database.
    Type string
    Type of the database backup destination.
    VpcUser string
    dbrsPolicyId String
    The OCID of the DBRS policy used for backup.
    id String
    The OCID of the database.
    type String
    Type of the database backup destination.
    vpcUser String
    dbrsPolicyId string
    The OCID of the DBRS policy used for backup.
    id string
    The OCID of the database.
    type string
    Type of the database backup destination.
    vpcUser string
    dbrs_policy_id str
    The OCID of the DBRS policy used for backup.
    id str
    The OCID of the database.
    type str
    Type of the database backup destination.
    vpc_user str
    dbrsPolicyId String
    The OCID of the DBRS policy used for backup.
    id String
    The OCID of the database.
    type String
    Type of the database backup destination.
    vpcUser String

    GetDatabasesDatabaseDatabaseManagementConfig

    ManagementStatus string
    The status of the Database Management service.
    ManagementType string
    The Database Management type.
    ManagementStatus string
    The status of the Database Management service.
    ManagementType string
    The Database Management type.
    managementStatus String
    The status of the Database Management service.
    managementType String
    The Database Management type.
    managementStatus string
    The status of the Database Management service.
    managementType string
    The Database Management type.
    management_status str
    The status of the Database Management service.
    management_type str
    The Database Management type.
    managementStatus String
    The status of the Database Management service.
    managementType String
    The Database Management type.

    GetDatabasesDatabaseDbBackupConfig

    AutoBackupEnabled bool
    If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
    AutoBackupWindow string
    Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
    AutoFullBackupDay string
    Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
    AutoFullBackupWindow string
    Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
    BackupDeletionPolicy string
    This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
    BackupDestinationDetails List<GetDatabasesDatabaseDbBackupConfigBackupDestinationDetail>
    Backup destination details.
    RecoveryWindowInDays int
    Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
    RunImmediateFullBackup bool
    If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
    AutoBackupEnabled bool
    If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
    AutoBackupWindow string
    Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
    AutoFullBackupDay string
    Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
    AutoFullBackupWindow string
    Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
    BackupDeletionPolicy string
    This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
    BackupDestinationDetails []GetDatabasesDatabaseDbBackupConfigBackupDestinationDetail
    Backup destination details.
    RecoveryWindowInDays int
    Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
    RunImmediateFullBackup bool
    If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
    autoBackupEnabled Boolean
    If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
    autoBackupWindow String
    Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
    autoFullBackupDay String
    Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
    autoFullBackupWindow String
    Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
    backupDeletionPolicy String
    This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
    backupDestinationDetails List<GetsDbBackupConfigBackupDestinationDetail>
    Backup destination details.
    recoveryWindowInDays Integer
    Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
    runImmediateFullBackup Boolean
    If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
    autoBackupEnabled boolean
    If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
    autoBackupWindow string
    Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
    autoFullBackupDay string
    Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
    autoFullBackupWindow string
    Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
    backupDeletionPolicy string
    This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
    backupDestinationDetails GetDatabasesDatabaseDbBackupConfigBackupDestinationDetail[]
    Backup destination details.
    recoveryWindowInDays number
    Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
    runImmediateFullBackup boolean
    If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
    auto_backup_enabled bool
    If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
    auto_backup_window str
    Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
    auto_full_backup_day str
    Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
    auto_full_backup_window str
    Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
    backup_deletion_policy str
    This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
    backup_destination_details Sequence[database.GetDatabasesDatabaseDbBackupConfigBackupDestinationDetail]
    Backup destination details.
    recovery_window_in_days int
    Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
    run_immediate_full_backup bool
    If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
    autoBackupEnabled Boolean
    If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
    autoBackupWindow String
    Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
    autoFullBackupDay String
    Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
    autoFullBackupWindow String
    Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
    backupDeletionPolicy String
    This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
    backupDestinationDetails List<Property Map>
    Backup destination details.
    recoveryWindowInDays Number
    Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
    runImmediateFullBackup Boolean
    If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

    GetDatabasesDatabaseDbBackupConfigBackupDestinationDetail

    DbrsPolicyId string
    The OCID of the DBRS policy used for backup.
    Id string
    The OCID of the database.
    Type string
    Type of the database backup destination.
    VpcUser string
    DbrsPolicyId string
    The OCID of the DBRS policy used for backup.
    Id string
    The OCID of the database.
    Type string
    Type of the database backup destination.
    VpcUser string
    dbrsPolicyId String
    The OCID of the DBRS policy used for backup.
    id String
    The OCID of the database.
    type String
    Type of the database backup destination.
    vpcUser String
    dbrsPolicyId string
    The OCID of the DBRS policy used for backup.
    id string
    The OCID of the database.
    type string
    Type of the database backup destination.
    vpcUser string
    dbrs_policy_id str
    The OCID of the DBRS policy used for backup.
    id str
    The OCID of the database.
    type str
    Type of the database backup destination.
    vpc_user str
    dbrsPolicyId String
    The OCID of the DBRS policy used for backup.
    id String
    The OCID of the database.
    type String
    Type of the database backup destination.
    vpcUser String

    GetDatabasesFilter

    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

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.3.0 published on Wednesday, Jul 17, 2024 by Pulumi