1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Database
  5. getDbHome
Oracle Cloud Infrastructure v0.20.1 published on Tuesday, Jun 6, 2023 by Pulumi

oci.Database.getDbHome

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v0.20.1 published on Tuesday, Jun 6, 2023 by Pulumi

    This data source provides details about a specific Db Home resource in Oracle Cloud Infrastructure Database service.

    Gets information about the specified Database Home.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testDbHome = Oci.Database.GetDbHome.Invoke(new()
        {
            DbHomeId = @var.Db_home_id,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/Database"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Database.GetDbHome(ctx, &database.GetDbHomeArgs{
    			DbHomeId: _var.Db_home_id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Database.DatabaseFunctions;
    import com.pulumi.oci.Database.inputs.GetDbHomeArgs;
    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 testDbHome = DatabaseFunctions.getDbHome(GetDbHomeArgs.builder()
                .dbHomeId(var_.db_home_id())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_oci as oci
    
    test_db_home = oci.Database.get_db_home(db_home_id=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    
    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testDbHome = oci.Database.getDbHome({
        dbHomeId: _var.db_home_id,
    });
    
    variables:
      testDbHome:
        fn::invoke:
          Function: oci:Database:getDbHome
          Arguments:
            dbHomeId: ${var.db_home_id}
    

    Using getDbHome

    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 getDbHome(args: GetDbHomeArgs, opts?: InvokeOptions): Promise<GetDbHomeResult>
    function getDbHomeOutput(args: GetDbHomeOutputArgs, opts?: InvokeOptions): Output<GetDbHomeResult>
    def get_db_home(db_home_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetDbHomeResult
    def get_db_home_output(db_home_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetDbHomeResult]
    func GetDbHome(ctx *Context, args *GetDbHomeArgs, opts ...InvokeOption) (*GetDbHomeResult, error)
    func GetDbHomeOutput(ctx *Context, args *GetDbHomeOutputArgs, opts ...InvokeOption) GetDbHomeResultOutput

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

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

    The following arguments are supported:

    DbHomeId string

    The Database Home OCID.

    DbHomeId string

    The Database Home OCID.

    dbHomeId String

    The Database Home OCID.

    dbHomeId string

    The Database Home OCID.

    db_home_id str

    The Database Home OCID.

    dbHomeId String

    The Database Home OCID.

    getDbHome Result

    The following output properties are available:

    CompartmentId string

    The OCID of the compartment.

    DatabaseSoftwareImageId string

    The database software image OCID

    Databases List<GetDbHomeDatabase>
    DbHomeId string
    DbHomeLocation string

    The location of the Oracle Database Home.

    DbSystemId string

    The OCID of the DB system.

    DbVersion string

    The Oracle Database version.

    DefinedTags Dictionary<string, object>

    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

    DisplayName string

    The user-provided name for the Database Home. The name does not need to be unique.

    EnableDatabaseDelete bool
    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 Home.

    IsDesupportedVersion bool
    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
    LastPatchHistoryEntryId string

    The OCID of the last patch history. This value is updated as soon as a patch operation is started.

    LifecycleDetails string

    Additional information about the current lifecycle state.

    Source string
    State string

    The current state of the Database Home.

    TimeCreated string

    The date and time the Database Home was created.

    VmClusterId string

    The OCID of the VM cluster.

    CompartmentId string

    The OCID of the compartment.

    DatabaseSoftwareImageId string

    The database software image OCID

    Databases []GetDbHomeDatabase
    DbHomeId string
    DbHomeLocation string

    The location of the Oracle Database Home.

    DbSystemId string

    The OCID of the DB system.

    DbVersion string

    The Oracle Database version.

    DefinedTags map[string]interface{}

    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

    DisplayName string

    The user-provided name for the Database Home. The name does not need to be unique.

    EnableDatabaseDelete bool
    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 Home.

    IsDesupportedVersion bool
    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
    LastPatchHistoryEntryId string

    The OCID of the last patch history. This value is updated as soon as a patch operation is started.

    LifecycleDetails string

    Additional information about the current lifecycle state.

    Source string
    State string

    The current state of the Database Home.

    TimeCreated string

    The date and time the Database Home was created.

    VmClusterId string

    The OCID of the VM cluster.

    compartmentId String

    The OCID of the compartment.

    databaseSoftwareImageId String

    The database software image OCID

    databases List<GetDbHome>
    dbHomeId String
    dbHomeLocation String

    The location of the Oracle Database Home.

    dbSystemId String

    The OCID of the DB system.

    dbVersion String

    The Oracle Database version.

    definedTags Map<String,Object>

    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

    displayName String

    The user-provided name for the Database Home. The name does not need to be unique.

    enableDatabaseDelete Boolean
    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 Home.

    isDesupportedVersion Boolean
    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
    lastPatchHistoryEntryId String

    The OCID of the last patch history. This value is updated as soon as a patch operation is started.

    lifecycleDetails String

    Additional information about the current lifecycle state.

    source String
    state String

    The current state of the Database Home.

    timeCreated String

    The date and time the Database Home was created.

    vmClusterId String

    The OCID of the VM cluster.

    compartmentId string

    The OCID of the compartment.

    databaseSoftwareImageId string

    The database software image OCID

    databases GetDbHomeDatabase[]
    dbHomeId string
    dbHomeLocation string

    The location of the Oracle Database Home.

    dbSystemId string

    The OCID of the DB system.

    dbVersion string

    The Oracle Database version.

    definedTags {[key: string]: any}

    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

    displayName string

    The user-provided name for the Database Home. The name does not need to be unique.

    enableDatabaseDelete boolean
    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 Home.

    isDesupportedVersion boolean
    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
    lastPatchHistoryEntryId string

    The OCID of the last patch history. This value is updated as soon as a patch operation is started.

    lifecycleDetails string

    Additional information about the current lifecycle state.

    source string
    state string

    The current state of the Database Home.

    timeCreated string

    The date and time the Database Home was created.

    vmClusterId string

    The OCID of the VM cluster.

    compartment_id str

    The OCID of the compartment.

    database_software_image_id str

    The database software image OCID

    databases GetDbHomeDatabase]
    db_home_id str
    db_home_location str

    The location of the Oracle Database Home.

    db_system_id str

    The OCID of the DB system.

    db_version str

    The Oracle Database version.

    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.

    display_name str

    The user-provided name for the Database Home. The name does not need to be unique.

    enable_database_delete bool
    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 Home.

    is_desupported_version bool
    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
    last_patch_history_entry_id str

    The OCID of the last patch history. This value is updated as soon as a patch operation is started.

    lifecycle_details str

    Additional information about the current lifecycle state.

    source str
    state str

    The current state of the Database Home.

    time_created str

    The date and time the Database Home was created.

    vm_cluster_id str

    The OCID of the VM cluster.

    compartmentId String

    The OCID of the compartment.

    databaseSoftwareImageId String

    The database software image OCID

    databases List<Property Map>
    dbHomeId String
    dbHomeLocation String

    The location of the Oracle Database Home.

    dbSystemId String

    The OCID of the DB system.

    dbVersion String

    The Oracle Database version.

    definedTags Map<Any>

    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

    displayName String

    The user-provided name for the Database Home. The name does not need to be unique.

    enableDatabaseDelete Boolean
    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 Home.

    isDesupportedVersion Boolean
    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
    lastPatchHistoryEntryId String

    The OCID of the last patch history. This value is updated as soon as a patch operation is started.

    lifecycleDetails String

    Additional information about the current lifecycle state.

    source String
    state String

    The current state of the Database Home.

    timeCreated String

    The date and time the Database Home was created.

    vmClusterId String

    The OCID of the VM cluster.

    Supporting Types

    GetDbHomeDatabase

    AdminPassword string
    BackupId string
    BackupTdePassword string
    CharacterSet string
    ConnectionStrings List<GetDbHomeDatabaseConnectionString>
    DatabaseId string
    DatabaseSoftwareImageId string

    The database software image OCID

    DbBackupConfigs List<GetDbHomeDatabaseDbBackupConfig>
    DbName string
    DbUniqueName string
    DbWorkload string
    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 Home.

    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
    LifecycleDetails string

    Additional information about the current lifecycle state.

    NcharacterSet string
    OneOffPatches List<string>

    List of one-off patches for Database Homes.

    PdbName string
    SidPrefix string
    State string

    The current state of the Database Home.

    TdeWalletPassword string
    TimeCreated string

    The date and time the Database Home was created.

    TimeStampForPointInTimeRecovery string
    VaultId string
    AdminPassword string
    BackupId string
    BackupTdePassword string
    CharacterSet string
    ConnectionStrings []GetDbHomeDatabaseConnectionString
    DatabaseId string
    DatabaseSoftwareImageId string

    The database software image OCID

    DbBackupConfigs []GetDbHomeDatabaseDbBackupConfig
    DbName string
    DbUniqueName string
    DbWorkload string
    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 Home.

    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
    LifecycleDetails string

    Additional information about the current lifecycle state.

    NcharacterSet string
    OneOffPatches []string

    List of one-off patches for Database Homes.

    PdbName string
    SidPrefix string
    State string

    The current state of the Database Home.

    TdeWalletPassword string
    TimeCreated string

    The date and time the Database Home was created.

    TimeStampForPointInTimeRecovery string
    VaultId string
    adminPassword String
    backupId String
    backupTdePassword String
    characterSet String
    connectionStrings List<GetDbHomeConnectionString>
    databaseId String
    databaseSoftwareImageId String

    The database software image OCID

    dbBackupConfigs List<GetDbHomeDbBackupConfig>
    dbName String
    dbUniqueName String
    dbWorkload String
    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 Home.

    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
    lifecycleDetails String

    Additional information about the current lifecycle state.

    ncharacterSet String
    oneOffPatches List<String>

    List of one-off patches for Database Homes.

    pdbName String
    sidPrefix String
    state String

    The current state of the Database Home.

    tdeWalletPassword String
    timeCreated String

    The date and time the Database Home was created.

    timeStampForPointInTimeRecovery String
    vaultId String
    adminPassword string
    backupId string
    backupTdePassword string
    characterSet string
    connectionStrings GetDbHomeDatabaseConnectionString[]
    databaseId string
    databaseSoftwareImageId string

    The database software image OCID

    dbBackupConfigs GetDbHomeDatabaseDbBackupConfig[]
    dbName string
    dbUniqueName string
    dbWorkload string
    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 Home.

    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
    lifecycleDetails string

    Additional information about the current lifecycle state.

    ncharacterSet string
    oneOffPatches string[]

    List of one-off patches for Database Homes.

    pdbName string
    sidPrefix string
    state string

    The current state of the Database Home.

    tdeWalletPassword string
    timeCreated string

    The date and time the Database Home was created.

    timeStampForPointInTimeRecovery string
    vaultId string
    admin_password str
    backup_id str
    backup_tde_password str
    character_set str
    connection_strings GetDbHomeDatabaseConnectionString]
    database_id str
    database_software_image_id str

    The database software image OCID

    db_backup_configs GetDbHomeDatabaseDbBackupConfig]
    db_name str
    db_unique_name str
    db_workload str
    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 Home.

    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
    lifecycle_details str

    Additional information about the current lifecycle state.

    ncharacter_set str
    one_off_patches Sequence[str]

    List of one-off patches for Database Homes.

    pdb_name str
    sid_prefix str
    state str

    The current state of the Database Home.

    tde_wallet_password str
    time_created str

    The date and time the Database Home was created.

    time_stamp_for_point_in_time_recovery str
    vault_id str
    adminPassword String
    backupId String
    backupTdePassword String
    characterSet String
    connectionStrings List<Property Map>
    databaseId String
    databaseSoftwareImageId String

    The database software image OCID

    dbBackupConfigs List<Property Map>
    dbName String
    dbUniqueName String
    dbWorkload String
    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 Home.

    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
    lifecycleDetails String

    Additional information about the current lifecycle state.

    ncharacterSet String
    oneOffPatches List<String>

    List of one-off patches for Database Homes.

    pdbName String
    sidPrefix String
    state String

    The current state of the Database Home.

    tdeWalletPassword String
    timeCreated String

    The date and time the Database Home was created.

    timeStampForPointInTimeRecovery String
    vaultId String

    GetDbHomeDatabaseConnectionString

    AllConnectionStrings Dictionary<string, object>
    CdbDefault string
    CdbIpDefault string
    AllConnectionStrings map[string]interface{}
    CdbDefault string
    CdbIpDefault string
    allConnectionStrings Map<String,Object>
    cdbDefault String
    cdbIpDefault String
    allConnectionStrings {[key: string]: any}
    cdbDefault string
    cdbIpDefault string

    GetDbHomeDatabaseDbBackupConfig

    GetDbHomeDatabaseDbBackupConfigBackupDestinationDetail

    DbrsPolicyId string
    Id string

    The OCID of the Database Home.

    Type string
    DbrsPolicyId string
    Id string

    The OCID of the Database Home.

    Type string
    dbrsPolicyId String
    id String

    The OCID of the Database Home.

    type String
    dbrsPolicyId string
    id string

    The OCID of the Database Home.

    type string
    dbrs_policy_id str
    id str

    The OCID of the Database Home.

    type str
    dbrsPolicyId String
    id String

    The OCID of the Database Home.

    type String

    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 v0.20.1 published on Tuesday, Jun 6, 2023 by Pulumi