/** * Database Service API * The API for the Database Service. Use this API to manage resources such as databases and DB Systems. For more information, see [Overview of the Database Service](https://docs.oracle.com/iaas/Content/Database/Concepts/databaseoverview.htm). * OpenAPI spec version: 20160918 * Contact: sic_dbaas_cp_us_grp@oracle.com * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ /** * A directory where Oracle Database software is installed. A bare metal or Exadata DB system can have multiple Database Homes * and each Database Home can run a different supported version of Oracle Database. A virtual machine DB system can have only one Database Home. * For more information, see [Bare Metal and Virtual Machine DB Systems](https://docs.oracle.com/iaas/Content/Database/Concepts/overview.htm) and [Exadata DB Systems](https://docs.oracle.com/iaas/Content/Database/Concepts/exaoverview.htm). *
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](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm). *
**Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
*
*/
export interface DbHomeSummary {
/**
* The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Home.
*/
"id": string;
/**
* The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
*/
"compartmentId": string;
/**
* The user-provided name for the Database Home. The name does not need to be unique.
*/
"displayName": string;
/**
* The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the last patch history. This value is updated as soon as a patch operation is started.
*/
"lastPatchHistoryEntryId"?: string;
/**
* The current state of the Database Home.
*/
"lifecycleState": DbHomeSummary.LifecycleState;
/**
* The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DB system.
*/
"dbSystemId"?: string;
/**
* The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VM cluster.
*/
"vmClusterId"?: string;
/**
* The Oracle Database version.
*/
"dbVersion": string;
/**
* The location of the Oracle Database Home.
*/
"dbHomeLocation": string;
/**
* Additional information about the current lifecycle state.
*/
"lifecycleDetails"?: string;
/**
* The date and time the Database Home was created.
*/
"timeCreated"?: Date;
/**
* The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
*/
"kmsKeyId"?: string;
/**
* List of one-off patches for Database Homes.
*/
"oneOffPatches"?: Array
Example: {@code {\"Department\": \"Finance\"}}
*
*/
"freeformTags"?: {
[key: string]: string;
};
/**
* Defined tags for this resource. Each key is predefined and scoped to a namespace.
* For more information, see [Resource Tags](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
*
*/
"definedTags"?: {
[key: string]: {
[key: string]: any;
};
};
/**
* System tags for this resource. Each key is predefined and scoped to a namespace.
* For more information, see [Resource Tags](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
*
*/
"systemTags"?: {
[key: string]: {
[key: string]: any;
};
};
/**
* The database software image [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
*/
"databaseSoftwareImageId"?: string;
/**
* Indicates whether unified autiding is enabled or not.
*/
"isUnifiedAuditingEnabled"?: boolean;
/**
* Represents database home will be managed by oracle or customer
*
*/
"homeType"?: DbHomeSummary.HomeType;
}
export declare namespace DbHomeSummary {
enum LifecycleState {
Provisioning = "PROVISIONING",
Available = "AVAILABLE",
Updating = "UPDATING",
Terminating = "TERMINATING",
Terminated = "TERMINATED",
Failed = "FAILED",
/**
* This value is used if a service returns a value for this enum that is not recognized by this
* version of the SDK.
*/
UnknownValue = "UNKNOWN_VALUE"
}
enum HomeType {
OracleManaged = "ORACLE_MANAGED",
CustomerManaged = "CUSTOMER_MANAGED",
/**
* This value is used if a service returns a value for this enum that is not recognized by this
* version of the SDK.
*/
UnknownValue = "UNKNOWN_VALUE"
}
function getJsonObj(obj: DbHomeSummary): object;
function getDeserializedJsonObj(obj: DbHomeSummary): object;
}