1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Database
  5. getDbHomes
Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi

oci.Database.getDbHomes

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi

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

Lists the Database Homes in the specified DB system and compartment. A Database Home is a directory where Oracle Database software is installed.

Using getDbHomes

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 getDbHomes(args: GetDbHomesArgs, opts?: InvokeOptions): Promise<GetDbHomesResult>
function getDbHomesOutput(args: GetDbHomesOutputArgs, opts?: InvokeOptions): Output<GetDbHomesResult>
Copy
def get_db_homes(backup_id: Optional[str] = None,
                 compartment_id: Optional[str] = None,
                 db_system_id: Optional[str] = None,
                 db_version: Optional[str] = None,
                 display_name: Optional[str] = None,
                 filters: Optional[Sequence[_database.GetDbHomesFilter]] = None,
                 state: Optional[str] = None,
                 vm_cluster_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetDbHomesResult
def get_db_homes_output(backup_id: Optional[pulumi.Input[str]] = None,
                 compartment_id: Optional[pulumi.Input[str]] = None,
                 db_system_id: Optional[pulumi.Input[str]] = None,
                 db_version: Optional[pulumi.Input[str]] = None,
                 display_name: Optional[pulumi.Input[str]] = None,
                 filters: Optional[pulumi.Input[Sequence[pulumi.Input[_database.GetDbHomesFilterArgs]]]] = None,
                 state: Optional[pulumi.Input[str]] = None,
                 vm_cluster_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetDbHomesResult]
Copy
func GetDbHomes(ctx *Context, args *GetDbHomesArgs, opts ...InvokeOption) (*GetDbHomesResult, error)
func GetDbHomesOutput(ctx *Context, args *GetDbHomesOutputArgs, opts ...InvokeOption) GetDbHomesResultOutput
Copy

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

public static class GetDbHomes 
{
    public static Task<GetDbHomesResult> InvokeAsync(GetDbHomesArgs args, InvokeOptions? opts = null)
    public static Output<GetDbHomesResult> Invoke(GetDbHomesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDbHomesResult> getDbHomes(GetDbHomesArgs args, InvokeOptions options)
public static Output<GetDbHomesResult> getDbHomes(GetDbHomesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:Database/getDbHomes:getDbHomes
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CompartmentId This property is required. string
The compartment OCID.
BackupId string
The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.
DbSystemId string
The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.
DbVersion string
A filter to return only DB Homes that match the specified dbVersion.
DisplayName string
A filter to return only resources that match the entire display name given. The match is not case sensitive.
Filters Changes to this property will trigger replacement. List<GetDbHomesFilter>
State string
A filter to return only resources that match the given lifecycle state exactly.
VmClusterId string
The OCID of the VM cluster.
CompartmentId This property is required. string
The compartment OCID.
BackupId string
The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.
DbSystemId string
The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.
DbVersion string
A filter to return only DB Homes that match the specified dbVersion.
DisplayName string
A filter to return only resources that match the entire display name given. The match is not case sensitive.
Filters Changes to this property will trigger replacement. []GetDbHomesFilter
State string
A filter to return only resources that match the given lifecycle state exactly.
VmClusterId string
The OCID of the VM cluster.
compartmentId This property is required. String
The compartment OCID.
backupId String
The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.
dbSystemId String
The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.
dbVersion String
A filter to return only DB Homes that match the specified dbVersion.
displayName String
A filter to return only resources that match the entire display name given. The match is not case sensitive.
filters Changes to this property will trigger replacement. List<GetDbHomesFilter>
state String
A filter to return only resources that match the given lifecycle state exactly.
vmClusterId String
The OCID of the VM cluster.
compartmentId This property is required. string
The compartment OCID.
backupId string
The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.
dbSystemId string
The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.
dbVersion string
A filter to return only DB Homes that match the specified dbVersion.
displayName string
A filter to return only resources that match the entire display name given. The match is not case sensitive.
filters Changes to this property will trigger replacement. GetDbHomesFilter[]
state string
A filter to return only resources that match the given lifecycle state exactly.
vmClusterId string
The OCID of the VM cluster.
compartment_id This property is required. str
The compartment OCID.
backup_id str
The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.
db_system_id str
The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.
db_version str
A filter to return only DB Homes that match the specified dbVersion.
display_name str
A filter to return only resources that match the entire display name given. The match is not case sensitive.
filters Changes to this property will trigger replacement. Sequence[database.GetDbHomesFilter]
state str
A filter to return only resources that match the given lifecycle state exactly.
vm_cluster_id str
The OCID of the VM cluster.
compartmentId This property is required. String
The compartment OCID.
backupId String
The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.
dbSystemId String
The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.
dbVersion String
A filter to return only DB Homes that match the specified dbVersion.
displayName String
A filter to return only resources that match the entire display name given. The match is not case sensitive.
filters Changes to this property will trigger replacement. List<Property Map>
state String
A filter to return only resources that match the given lifecycle state exactly.
vmClusterId String
The OCID of the VM cluster.

getDbHomes Result

The following output properties are available:

CompartmentId string
The OCID of the compartment.
DbHomes List<GetDbHomesDbHome>
The list of db_homes.
Id string
The provider-assigned unique ID for this managed resource.
BackupId string
DbSystemId string
The OCID of the DB system.
DbVersion string
The Oracle Database version.
DisplayName string
The user-provided name for the Database Home. The name does not need to be unique.
Filters List<GetDbHomesFilter>
State string
The current state of the Database Home.
VmClusterId string
The OCID of the VM cluster.
CompartmentId string
The OCID of the compartment.
DbHomes []GetDbHomesDbHome
The list of db_homes.
Id string
The provider-assigned unique ID for this managed resource.
BackupId string
DbSystemId string
The OCID of the DB system.
DbVersion string
The Oracle Database version.
DisplayName string
The user-provided name for the Database Home. The name does not need to be unique.
Filters []GetDbHomesFilter
State string
The current state of the Database Home.
VmClusterId string
The OCID of the VM cluster.
compartmentId String
The OCID of the compartment.
dbHomes List<GetDbHomesDbHome>
The list of db_homes.
id String
The provider-assigned unique ID for this managed resource.
backupId String
dbSystemId String
The OCID of the DB system.
dbVersion String
The Oracle Database version.
displayName String
The user-provided name for the Database Home. The name does not need to be unique.
filters List<GetDbHomesFilter>
state String
The current state of the Database Home.
vmClusterId String
The OCID of the VM cluster.
compartmentId string
The OCID of the compartment.
dbHomes GetDbHomesDbHome[]
The list of db_homes.
id string
The provider-assigned unique ID for this managed resource.
backupId string
dbSystemId string
The OCID of the DB system.
dbVersion string
The Oracle Database version.
displayName string
The user-provided name for the Database Home. The name does not need to be unique.
filters GetDbHomesFilter[]
state string
The current state of the Database Home.
vmClusterId string
The OCID of the VM cluster.
compartment_id str
The OCID of the compartment.
db_homes Sequence[database.GetDbHomesDbHome]
The list of db_homes.
id str
The provider-assigned unique ID for this managed resource.
backup_id str
db_system_id str
The OCID of the DB system.
db_version str
The Oracle Database version.
display_name str
The user-provided name for the Database Home. The name does not need to be unique.
filters Sequence[database.GetDbHomesFilter]
state str
The current state of the Database Home.
vm_cluster_id str
The OCID of the VM cluster.
compartmentId String
The OCID of the compartment.
dbHomes List<Property Map>
The list of db_homes.
id String
The provider-assigned unique ID for this managed resource.
backupId String
dbSystemId String
The OCID of the DB system.
dbVersion String
The Oracle Database version.
displayName String
The user-provided name for the Database Home. The name does not need to be unique.
filters List<Property Map>
state String
The current state of the Database Home.
vmClusterId String
The OCID of the VM cluster.

Supporting Types

GetDbHomesDbHome

CompartmentId This property is required. string
The compartment OCID.
DatabaseSoftwareImageId This property is required. string
The database software image OCID
Databases This property is required. List<GetDbHomesDbHomeDatabase>
DbHomeId This property is required. string
DbHomeLocation This property is required. string
The location of the Oracle Database Home.
DbSystemId This property is required. string
The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.
DbVersion This property is required. string
A filter to return only DB Homes that match the specified dbVersion.
DefinedTags This property is required. Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
DisplayName This property is required. string
A filter to return only resources that match the entire display name given. The match is not case sensitive.
EnableDatabaseDelete This property is required. bool
FreeformTags This property is required. Dictionary<string, string>
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 This property is required. string
The OCID of the Database Home.
IsDesupportedVersion This property is required. bool
IsUnifiedAuditingEnabled This property is required. bool
Indicates whether unified autiding is enabled or not.
KmsKeyId This property is required. string
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
KmsKeyVersionId This property is required. string
LastPatchHistoryEntryId This property is required. string
The OCID of the last patch history. This value is updated as soon as a patch operation is started.
LifecycleDetails This property is required. string
Additional information about the current lifecycle state.
Source This property is required. string
State This property is required. string
A filter to return only resources that match the given lifecycle state exactly.
TimeCreated This property is required. string
The date and time the Database Home was created.
VmClusterId This property is required. string
The OCID of the VM cluster.
CompartmentId This property is required. string
The compartment OCID.
DatabaseSoftwareImageId This property is required. string
The database software image OCID
Databases This property is required. []GetDbHomesDbHomeDatabase
DbHomeId This property is required. string
DbHomeLocation This property is required. string
The location of the Oracle Database Home.
DbSystemId This property is required. string
The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.
DbVersion This property is required. string
A filter to return only DB Homes that match the specified dbVersion.
DefinedTags This property is required. map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
DisplayName This property is required. string
A filter to return only resources that match the entire display name given. The match is not case sensitive.
EnableDatabaseDelete This property is required. bool
FreeformTags This property is required. map[string]string
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 This property is required. string
The OCID of the Database Home.
IsDesupportedVersion This property is required. bool
IsUnifiedAuditingEnabled This property is required. bool
Indicates whether unified autiding is enabled or not.
KmsKeyId This property is required. string
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
KmsKeyVersionId This property is required. string
LastPatchHistoryEntryId This property is required. string
The OCID of the last patch history. This value is updated as soon as a patch operation is started.
LifecycleDetails This property is required. string
Additional information about the current lifecycle state.
Source This property is required. string
State This property is required. string
A filter to return only resources that match the given lifecycle state exactly.
TimeCreated This property is required. string
The date and time the Database Home was created.
VmClusterId This property is required. string
The OCID of the VM cluster.
compartmentId This property is required. String
The compartment OCID.
databaseSoftwareImageId This property is required. String
The database software image OCID
databases This property is required. List<GetDbHomesDbHome>
dbHomeId This property is required. String
dbHomeLocation This property is required. String
The location of the Oracle Database Home.
dbSystemId This property is required. String
The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.
dbVersion This property is required. String
A filter to return only DB Homes that match the specified dbVersion.
definedTags This property is required. Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
displayName This property is required. String
A filter to return only resources that match the entire display name given. The match is not case sensitive.
enableDatabaseDelete This property is required. Boolean
freeformTags This property is required. Map<String,String>
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 This property is required. String
The OCID of the Database Home.
isDesupportedVersion This property is required. Boolean
isUnifiedAuditingEnabled This property is required. Boolean
Indicates whether unified autiding is enabled or not.
kmsKeyId This property is required. String
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId This property is required. String
lastPatchHistoryEntryId This property is required. String
The OCID of the last patch history. This value is updated as soon as a patch operation is started.
lifecycleDetails This property is required. String
Additional information about the current lifecycle state.
source This property is required. String
state This property is required. String
A filter to return only resources that match the given lifecycle state exactly.
timeCreated This property is required. String
The date and time the Database Home was created.
vmClusterId This property is required. String
The OCID of the VM cluster.
compartmentId This property is required. string
The compartment OCID.
databaseSoftwareImageId This property is required. string
The database software image OCID
databases This property is required. GetDbHomesDbHomeDatabase[]
dbHomeId This property is required. string
dbHomeLocation This property is required. string
The location of the Oracle Database Home.
dbSystemId This property is required. string
The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.
dbVersion This property is required. string
A filter to return only DB Homes that match the specified dbVersion.
definedTags This property is required. {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
displayName This property is required. string
A filter to return only resources that match the entire display name given. The match is not case sensitive.
enableDatabaseDelete This property is required. boolean
freeformTags This property is required. {[key: string]: string}
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 This property is required. string
The OCID of the Database Home.
isDesupportedVersion This property is required. boolean
isUnifiedAuditingEnabled This property is required. boolean
Indicates whether unified autiding is enabled or not.
kmsKeyId This property is required. string
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId This property is required. string
lastPatchHistoryEntryId This property is required. string
The OCID of the last patch history. This value is updated as soon as a patch operation is started.
lifecycleDetails This property is required. string
Additional information about the current lifecycle state.
source This property is required. string
state This property is required. string
A filter to return only resources that match the given lifecycle state exactly.
timeCreated This property is required. string
The date and time the Database Home was created.
vmClusterId This property is required. string
The OCID of the VM cluster.
compartment_id This property is required. str
The compartment OCID.
database_software_image_id This property is required. str
The database software image OCID
databases This property is required. Sequence[database.GetDbHomesDbHomeDatabase]
db_home_id This property is required. str
db_home_location This property is required. str
The location of the Oracle Database Home.
db_system_id This property is required. str
The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.
db_version This property is required. str
A filter to return only DB Homes that match the specified dbVersion.
defined_tags This property is required. Mapping[str, str]
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
display_name This property is required. str
A filter to return only resources that match the entire display name given. The match is not case sensitive.
enable_database_delete This property is required. bool
freeform_tags This property is required. Mapping[str, str]
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 This property is required. str
The OCID of the Database Home.
is_desupported_version This property is required. bool
is_unified_auditing_enabled This property is required. bool
Indicates whether unified autiding is enabled or not.
kms_key_id This property is required. 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 This property is required. str
last_patch_history_entry_id This property is required. str
The OCID of the last patch history. This value is updated as soon as a patch operation is started.
lifecycle_details This property is required. str
Additional information about the current lifecycle state.
source This property is required. str
state This property is required. str
A filter to return only resources that match the given lifecycle state exactly.
time_created This property is required. str
The date and time the Database Home was created.
vm_cluster_id This property is required. str
The OCID of the VM cluster.
compartmentId This property is required. String
The compartment OCID.
databaseSoftwareImageId This property is required. String
The database software image OCID
databases This property is required. List<Property Map>
dbHomeId This property is required. String
dbHomeLocation This property is required. String
The location of the Oracle Database Home.
dbSystemId This property is required. String
The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.
dbVersion This property is required. String
A filter to return only DB Homes that match the specified dbVersion.
definedTags This property is required. Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
displayName This property is required. String
A filter to return only resources that match the entire display name given. The match is not case sensitive.
enableDatabaseDelete This property is required. Boolean
freeformTags This property is required. Map<String>
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 This property is required. String
The OCID of the Database Home.
isDesupportedVersion This property is required. Boolean
isUnifiedAuditingEnabled This property is required. Boolean
Indicates whether unified autiding is enabled or not.
kmsKeyId This property is required. String
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId This property is required. String
lastPatchHistoryEntryId This property is required. String
The OCID of the last patch history. This value is updated as soon as a patch operation is started.
lifecycleDetails This property is required. String
Additional information about the current lifecycle state.
source This property is required. String
state This property is required. String
A filter to return only resources that match the given lifecycle state exactly.
timeCreated This property is required. String
The date and time the Database Home was created.
vmClusterId This property is required. String
The OCID of the VM cluster.

GetDbHomesDbHomeDatabase

AdminPassword This property is required. string
BackupId This property is required. string
The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.
BackupTdePassword This property is required. string
CharacterSet This property is required. string
ConnectionStrings This property is required. List<GetDbHomesDbHomeDatabaseConnectionString>
DatabaseId This property is required. string
DatabaseSoftwareImageId This property is required. string
The database software image OCID
DbBackupConfigs This property is required. List<GetDbHomesDbHomeDatabaseDbBackupConfig>
DbName This property is required. string
DbUniqueName This property is required. string
DbWorkload This property is required. string
DefinedTags This property is required. Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
EncryptionKeyLocationDetails This property is required. List<GetDbHomesDbHomeDatabaseEncryptionKeyLocationDetail>
FreeformTags This property is required. Dictionary<string, string>
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 This property is required. string
The OCID of the Database Home.
KeyStoreId This property is required. string
KmsKeyId This property is required. string
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
KmsKeyVersionId This property is required. string
LifecycleDetails This property is required. string
Additional information about the current lifecycle state.
NcharacterSet This property is required. string
OneOffPatches This property is required. List<string>
List of one-off patches for Database Homes.
PdbName This property is required. string
PluggableDatabases This property is required. List<string>
SidPrefix This property is required. string
State This property is required. string
A filter to return only resources that match the given lifecycle state exactly.
TdeWalletPassword This property is required. string
TimeCreated This property is required. string
The date and time the Database Home was created.
TimeStampForPointInTimeRecovery This property is required. string
VaultId This property is required. string
AdminPassword This property is required. string
BackupId This property is required. string
The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.
BackupTdePassword This property is required. string
CharacterSet This property is required. string
ConnectionStrings This property is required. []GetDbHomesDbHomeDatabaseConnectionString
DatabaseId This property is required. string
DatabaseSoftwareImageId This property is required. string
The database software image OCID
DbBackupConfigs This property is required. []GetDbHomesDbHomeDatabaseDbBackupConfig
DbName This property is required. string
DbUniqueName This property is required. string
DbWorkload This property is required. string
DefinedTags This property is required. map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
EncryptionKeyLocationDetails This property is required. []GetDbHomesDbHomeDatabaseEncryptionKeyLocationDetail
FreeformTags This property is required. map[string]string
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 This property is required. string
The OCID of the Database Home.
KeyStoreId This property is required. string
KmsKeyId This property is required. string
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
KmsKeyVersionId This property is required. string
LifecycleDetails This property is required. string
Additional information about the current lifecycle state.
NcharacterSet This property is required. string
OneOffPatches This property is required. []string
List of one-off patches for Database Homes.
PdbName This property is required. string
PluggableDatabases This property is required. []string
SidPrefix This property is required. string
State This property is required. string
A filter to return only resources that match the given lifecycle state exactly.
TdeWalletPassword This property is required. string
TimeCreated This property is required. string
The date and time the Database Home was created.
TimeStampForPointInTimeRecovery This property is required. string
VaultId This property is required. string
adminPassword This property is required. String
backupId This property is required. String
The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.
backupTdePassword This property is required. String
characterSet This property is required. String
connectionStrings This property is required. List<GetDbHomesDbHomeConnectionString>
databaseId This property is required. String
databaseSoftwareImageId This property is required. String
The database software image OCID
dbBackupConfigs This property is required. List<GetDbHomesDbHomeDbBackupConfig>
dbName This property is required. String
dbUniqueName This property is required. String
dbWorkload This property is required. String
definedTags This property is required. Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
encryptionKeyLocationDetails This property is required. List<GetDbHomesDbHomeEncryptionKeyLocationDetail>
freeformTags This property is required. Map<String,String>
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 This property is required. String
The OCID of the Database Home.
keyStoreId This property is required. String
kmsKeyId This property is required. String
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId This property is required. String
lifecycleDetails This property is required. String
Additional information about the current lifecycle state.
ncharacterSet This property is required. String
oneOffPatches This property is required. List<String>
List of one-off patches for Database Homes.
pdbName This property is required. String
pluggableDatabases This property is required. List<String>
sidPrefix This property is required. String
state This property is required. String
A filter to return only resources that match the given lifecycle state exactly.
tdeWalletPassword This property is required. String
timeCreated This property is required. String
The date and time the Database Home was created.
timeStampForPointInTimeRecovery This property is required. String
vaultId This property is required. String
adminPassword This property is required. string
backupId This property is required. string
The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.
backupTdePassword This property is required. string
characterSet This property is required. string
connectionStrings This property is required. GetDbHomesDbHomeDatabaseConnectionString[]
databaseId This property is required. string
databaseSoftwareImageId This property is required. string
The database software image OCID
dbBackupConfigs This property is required. GetDbHomesDbHomeDatabaseDbBackupConfig[]
dbName This property is required. string
dbUniqueName This property is required. string
dbWorkload This property is required. string
definedTags This property is required. {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
encryptionKeyLocationDetails This property is required. GetDbHomesDbHomeDatabaseEncryptionKeyLocationDetail[]
freeformTags This property is required. {[key: string]: string}
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 This property is required. string
The OCID of the Database Home.
keyStoreId This property is required. string
kmsKeyId This property is required. string
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId This property is required. string
lifecycleDetails This property is required. string
Additional information about the current lifecycle state.
ncharacterSet This property is required. string
oneOffPatches This property is required. string[]
List of one-off patches for Database Homes.
pdbName This property is required. string
pluggableDatabases This property is required. string[]
sidPrefix This property is required. string
state This property is required. string
A filter to return only resources that match the given lifecycle state exactly.
tdeWalletPassword This property is required. string
timeCreated This property is required. string
The date and time the Database Home was created.
timeStampForPointInTimeRecovery This property is required. string
vaultId This property is required. string
admin_password This property is required. str
backup_id This property is required. str
The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.
backup_tde_password This property is required. str
character_set This property is required. str
connection_strings This property is required. Sequence[database.GetDbHomesDbHomeDatabaseConnectionString]
database_id This property is required. str
database_software_image_id This property is required. str
The database software image OCID
db_backup_configs This property is required. Sequence[database.GetDbHomesDbHomeDatabaseDbBackupConfig]
db_name This property is required. str
db_unique_name This property is required. str
db_workload This property is required. str
defined_tags This property is required. Mapping[str, str]
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
encryption_key_location_details This property is required. Sequence[database.GetDbHomesDbHomeDatabaseEncryptionKeyLocationDetail]
freeform_tags This property is required. Mapping[str, str]
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 This property is required. str
The OCID of the Database Home.
key_store_id This property is required. str
kms_key_id This property is required. 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 This property is required. str
lifecycle_details This property is required. str
Additional information about the current lifecycle state.
ncharacter_set This property is required. str
one_off_patches This property is required. Sequence[str]
List of one-off patches for Database Homes.
pdb_name This property is required. str
pluggable_databases This property is required. Sequence[str]
sid_prefix This property is required. str
state This property is required. str
A filter to return only resources that match the given lifecycle state exactly.
tde_wallet_password This property is required. str
time_created This property is required. str
The date and time the Database Home was created.
time_stamp_for_point_in_time_recovery This property is required. str
vault_id This property is required. str
adminPassword This property is required. String
backupId This property is required. String
The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.
backupTdePassword This property is required. String
characterSet This property is required. String
connectionStrings This property is required. List<Property Map>
databaseId This property is required. String
databaseSoftwareImageId This property is required. String
The database software image OCID
dbBackupConfigs This property is required. List<Property Map>
dbName This property is required. String
dbUniqueName This property is required. String
dbWorkload This property is required. String
definedTags This property is required. Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
encryptionKeyLocationDetails This property is required. List<Property Map>
freeformTags This property is required. Map<String>
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 This property is required. String
The OCID of the Database Home.
keyStoreId This property is required. String
kmsKeyId This property is required. String
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId This property is required. String
lifecycleDetails This property is required. String
Additional information about the current lifecycle state.
ncharacterSet This property is required. String
oneOffPatches This property is required. List<String>
List of one-off patches for Database Homes.
pdbName This property is required. String
pluggableDatabases This property is required. List<String>
sidPrefix This property is required. String
state This property is required. String
A filter to return only resources that match the given lifecycle state exactly.
tdeWalletPassword This property is required. String
timeCreated This property is required. String
The date and time the Database Home was created.
timeStampForPointInTimeRecovery This property is required. String
vaultId This property is required. String

GetDbHomesDbHomeDatabaseConnectionString

AllConnectionStrings This property is required. Dictionary<string, string>
CdbDefault This property is required. string
CdbIpDefault This property is required. string
AllConnectionStrings This property is required. map[string]string
CdbDefault This property is required. string
CdbIpDefault This property is required. string
allConnectionStrings This property is required. Map<String,String>
cdbDefault This property is required. String
cdbIpDefault This property is required. String
allConnectionStrings This property is required. {[key: string]: string}
cdbDefault This property is required. string
cdbIpDefault This property is required. string
all_connection_strings This property is required. Mapping[str, str]
cdb_default This property is required. str
cdb_ip_default This property is required. str
allConnectionStrings This property is required. Map<String>
cdbDefault This property is required. String
cdbIpDefault This property is required. String

GetDbHomesDbHomeDatabaseDbBackupConfig

AutoBackupEnabled This property is required. bool
AutoBackupWindow This property is required. string
AutoFullBackupDay This property is required. string
AutoFullBackupWindow This property is required. string
BackupDeletionPolicy This property is required. string
BackupDestinationDetails This property is required. List<GetDbHomesDbHomeDatabaseDbBackupConfigBackupDestinationDetail>
RecoveryWindowInDays This property is required. int
RunImmediateFullBackup This property is required. bool
AutoBackupEnabled This property is required. bool
AutoBackupWindow This property is required. string
AutoFullBackupDay This property is required. string
AutoFullBackupWindow This property is required. string
BackupDeletionPolicy This property is required. string
BackupDestinationDetails This property is required. []GetDbHomesDbHomeDatabaseDbBackupConfigBackupDestinationDetail
RecoveryWindowInDays This property is required. int
RunImmediateFullBackup This property is required. bool
autoBackupEnabled This property is required. Boolean
autoBackupWindow This property is required. String
autoFullBackupDay This property is required. String
autoFullBackupWindow This property is required. String
backupDeletionPolicy This property is required. String
backupDestinationDetails This property is required. List<GetDbHomesDbHomeDbBackupConfigBackupDestinationDetail>
recoveryWindowInDays This property is required. Integer
runImmediateFullBackup This property is required. Boolean
autoBackupEnabled This property is required. boolean
autoBackupWindow This property is required. string
autoFullBackupDay This property is required. string
autoFullBackupWindow This property is required. string
backupDeletionPolicy This property is required. string
backupDestinationDetails This property is required. GetDbHomesDbHomeDatabaseDbBackupConfigBackupDestinationDetail[]
recoveryWindowInDays This property is required. number
runImmediateFullBackup This property is required. boolean
auto_backup_enabled This property is required. bool
auto_backup_window This property is required. str
auto_full_backup_day This property is required. str
auto_full_backup_window This property is required. str
backup_deletion_policy This property is required. str
backup_destination_details This property is required. Sequence[database.GetDbHomesDbHomeDatabaseDbBackupConfigBackupDestinationDetail]
recovery_window_in_days This property is required. int
run_immediate_full_backup This property is required. bool
autoBackupEnabled This property is required. Boolean
autoBackupWindow This property is required. String
autoFullBackupDay This property is required. String
autoFullBackupWindow This property is required. String
backupDeletionPolicy This property is required. String
backupDestinationDetails This property is required. List<Property Map>
recoveryWindowInDays This property is required. Number
runImmediateFullBackup This property is required. Boolean

GetDbHomesDbHomeDatabaseDbBackupConfigBackupDestinationDetail

DbrsPolicyId This property is required. string
Id This property is required. string
The OCID of the Database Home.
Type This property is required. string
DbrsPolicyId This property is required. string
Id This property is required. string
The OCID of the Database Home.
Type This property is required. string
dbrsPolicyId This property is required. String
id This property is required. String
The OCID of the Database Home.
type This property is required. String
dbrsPolicyId This property is required. string
id This property is required. string
The OCID of the Database Home.
type This property is required. string
dbrs_policy_id This property is required. str
id This property is required. str
The OCID of the Database Home.
type This property is required. str
dbrsPolicyId This property is required. String
id This property is required. String
The OCID of the Database Home.
type This property is required. String

GetDbHomesDbHomeDatabaseEncryptionKeyLocationDetail

HsmPassword This property is required. string
ProviderType This property is required. string
HsmPassword This property is required. string
ProviderType This property is required. string
hsmPassword This property is required. String
providerType This property is required. String
hsmPassword This property is required. string
providerType This property is required. string
hsm_password This property is required. str
provider_type This property is required. str
hsmPassword This property is required. String
providerType This property is required. String

GetDbHomesFilter

Name This property is required. string
Values This property is required. List<string>
Regex bool
Name This property is required. string
Values This property is required. []string
Regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean
name This property is required. string
values This property is required. string[]
regex boolean
name This property is required. str
values This property is required. Sequence[str]
regex bool
name This property is required. String
values This property is required. 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.
Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi