/** * 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. */ import * as model from "../model"; export interface Database { /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database. */ "id": string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ "compartmentId": string; /** * The character set for the database. */ "characterSet"?: string; /** * The national character set for the database. */ "ncharacterSet"?: string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Home. */ "dbHomeId"?: string; /** * 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 database name. */ "dbName": 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. */ "pdbName"?: 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. *
The database workload type. * */ "dbWorkload"?: 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. * */ "dbUniqueName": string; /** * Additional information about the current lifecycle state. */ "lifecycleDetails"?: string; /** * The current state of the database. */ "lifecycleState": Database.LifecycleState; /** * The date and time the database was created. */ "timeCreated"?: Date; /** * The date and time when the latest database backup was created. */ "lastBackupTimestamp"?: Date; /** * The duration when the latest database backup created. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues. */ "lastBackupDurationInSeconds"?: number; /** * The date and time when the latest database backup failed. */ "lastFailedBackupTimestamp"?: Date; "dbBackupConfig"?: model.DbBackupConfig; /** * 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](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). *
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 Connection strings used to connect to the Oracle Database. */ "connectionStrings"?: model.DatabaseConnectionStrings; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ "kmsKeyId"?: 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. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. * */ "kmsKeyVersionId"?: string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and {@code secretId} are required for Customer Managed Keys. */ "vaultId"?: 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](https://tools.ietf.org/rfc/rfc3339) */ "sourceDatabasePointInTimeRecoveryTimestamp"?: Date; /** * The database software image [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) */ "databaseSoftwareImageId"?: string; /** * True if the database is a container database. */ "isCdb"?: boolean; "databaseManagementConfig"?: model.CloudDatabaseManagementConfig; /** * Specifies a prefix for the {@code Oracle SID} of the database to be created. * */ "sidPrefix"?: string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the key store of Oracle Vault. */ "keyStoreId"?: string; /** * The wallet name for Oracle Key Vault. */ "keyStoreWalletName"?: string; "dataGuardGroup"?: model.DataGuardGroup; "encryptionKeyLocationDetails"?: model.ExternalHsmEncryptionDetails | model.GoogleCloudProviderEncryptionKeyDetails | model.AzureEncryptionKeyDetails | model.AwsEncryptionKeyDetails; "storageSizeDetails"?: model.DatabaseStorageSizeResponseDetails; "managedSoftwareUpdateDetails"?: model.ManagedSoftwareUpdateDetails; /** * Represents database will be under oracle managed home or customer managed home * */ "homeType"?: Database.HomeType; /** * The patch version of the database. */ "patchVersion"?: string; } export declare namespace Database { enum LifecycleState { Provisioning = "PROVISIONING", Available = "AVAILABLE", Updating = "UPDATING", BackupInProgress = "BACKUP_IN_PROGRESS", Upgrading = "UPGRADING", Converting = "CONVERTING", Terminating = "TERMINATING", Terminated = "TERMINATED", RestoreFailed = "RESTORE_FAILED", 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: Database): object; function getDeserializedJsonObj(obj: Database): object; }