Docs Packages
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Database
  5. DbHome
Oracle Cloud Infrastructure v1.10.0 published on Thursday, Sep 7, 2023 by Pulumi
pulumi/pulumi-oci

oci.Database.DbHome

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.10.0 published on Thursday, Sep 7, 2023 by Pulumi
pulumi/pulumi-oci

    Import

    DbHomes can be imported using the id, e.g.

     $ pulumi import oci:Database/dbHome:DbHome test_db_home "id"

    Import is only supported for source=NONE database.0.admin_password is not returned by the service for security reasons. Add the following to the resource:

    lifecycle {

    ignore_changes = [“database.0.admin_password”]

    } The creation of an oci_database_db_system requires that it be created with exactly one oci_database_db_home. Therefore the first db home will have to be a property of the db system resource and any further db homes to be added to the db system will have to be added as first class resources using “oci_database_db_home”.

    Example Usage

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Database.DbHome;
import com.pulumi.oci.Database.DbHomeArgs;
import com.pulumi.oci.Database.inputs.DbHomeDatabaseArgs;
import com.pulumi.oci.Database.inputs.DbHomeDatabaseDbBackupConfigArgs;
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) {
        var testDbHome = new DbHome("testDbHome", DbHomeArgs.builder()        
            .database(DbHomeDatabaseArgs.builder()
                .adminPassword(var_.db_home_database_admin_password())
                .backupId(oci_database_backup.test_backup().id())
                .backupTdePassword(var_.db_home_database_backup_tde_password())
                .characterSet(var_.db_home_database_character_set())
                .databaseId(oci_database_database.test_database().id())
                .databaseSoftwareImageId(oci_database_database_software_image.test_database_software_image().id())
                .dbBackupConfig(DbHomeDatabaseDbBackupConfigArgs.builder()
                    .autoBackupEnabled(var_.db_home_database_db_backup_config_auto_backup_enabled())
                    .autoBackupWindow(var_.db_home_database_db_backup_config_auto_backup_window())
                    .autoFullBackupDay(var_.db_home_database_db_backup_config_auto_full_backup_day())
                    .autoFullBackupWindow(var_.db_home_database_db_backup_config_auto_full_backup_window())
                    .backupDeletionPolicy(var_.db_home_database_db_backup_config_backup_deletion_policy())
                    .backupDestinationDetails(DbHomeDatabaseDbBackupConfigBackupDestinationDetailArgs.builder()
                        .dbrsPolicyId(oci_identity_policy.test_policy().id())
                        .id(var_.db_home_database_db_backup_config_backup_destination_details_id())
                        .type(var_.db_home_database_db_backup_config_backup_destination_details_type())
                        .build())
                    .recoveryWindowInDays(var_.db_home_database_db_backup_config_recovery_window_in_days())
                    .runImmediateFullBackup(var_.db_home_database_db_backup_config_run_immediate_full_backup())
                    .build())
                .dbName(var_.db_home_database_db_name())
                .dbWorkload(var_.db_home_database_db_workload())
                .definedTags(var_.db_home_database_defined_tags())
                .freeformTags(var_.db_home_database_freeform_tags())
                .kmsKeyId(oci_kms_key.test_key().id())
                .kmsKeyVersionId(oci_kms_key_version.test_key_version().id())
                .ncharacterSet(var_.db_home_database_ncharacter_set())
                .pdbName(var_.db_home_database_pdb_name())
                .sidPrefix(var_.db_home_database_sid_prefix())
                .tdeWalletPassword(var_.db_home_database_tde_wallet_password())
                .timeStampForPointInTimeRecovery(var_.db_home_database_time_stamp_for_point_in_time_recovery())
                .vaultId(oci_kms_vault.test_vault().id())
                .build())
            .databaseSoftwareImageId(oci_database_database_software_image.test_database_software_image().id())
            .dbSystemId(oci_database_db_system.test_db_system().id())
            .dbVersion()
            .definedTags(var_.db_home_defined_tags())
            .displayName(var_.db_home_display_name())
            .enableDatabaseDelete(false)
            .freeformTags(Map.of("Department", "Finance"))
            .isDesupportedVersion(var_.db_home_is_desupported_version())
            .kmsKeyId(oci_kms_key.test_key().id())
            .kmsKeyVersionId(oci_kms_key_version.test_key_version().id())
            .source(var_.db_home_source())
            .vmClusterId(oci_database_vm_cluster.test_vm_cluster().id())
            .build());

    }
}

    Coming soon!

    Coming soon!

    resources:
  testDbHome:
    type: oci:Database:DbHome
    properties:
      database:
        adminPassword: ${var.db_home_database_admin_password}
        backupId: ${oci_database_backup.test_backup.id}
        backupTdePassword: ${var.db_home_database_backup_tde_password}
        characterSet: ${var.db_home_database_character_set}
        databaseId: ${oci_database_database.test_database.id}
        databaseSoftwareImageId: ${oci_database_database_software_image.test_database_software_image.id}
        dbBackupConfig:
          autoBackupEnabled: ${var.db_home_database_db_backup_config_auto_backup_enabled}
          autoBackupWindow: ${var.db_home_database_db_backup_config_auto_backup_window}
          autoFullBackupDay: ${var.db_home_database_db_backup_config_auto_full_backup_day}
          autoFullBackupWindow: ${var.db_home_database_db_backup_config_auto_full_backup_window}
          backupDeletionPolicy: ${var.db_home_database_db_backup_config_backup_deletion_policy}
          backupDestinationDetails:
            - dbrsPolicyId: ${oci_identity_policy.test_policy.id}
              id: ${var.db_home_database_db_backup_config_backup_destination_details_id}
              type: ${var.db_home_database_db_backup_config_backup_destination_details_type}
          recoveryWindowInDays: ${var.db_home_database_db_backup_config_recovery_window_in_days}
          runImmediateFullBackup: ${var.db_home_database_db_backup_config_run_immediate_full_backup}
        dbName: ${var.db_home_database_db_name}
        dbWorkload: ${var.db_home_database_db_workload}
        definedTags: ${var.db_home_database_defined_tags}
        freeformTags: ${var.db_home_database_freeform_tags}
        kmsKeyId: ${oci_kms_key.test_key.id}
        kmsKeyVersionId: ${oci_kms_key_version.test_key_version.id}
        ncharacterSet: ${var.db_home_database_ncharacter_set}
        pdbName: ${var.db_home_database_pdb_name}
        sidPrefix: ${var.db_home_database_sid_prefix}
        tdeWalletPassword: ${var.db_home_database_tde_wallet_password}
        timeStampForPointInTimeRecovery: ${var.db_home_database_time_stamp_for_point_in_time_recovery}
        vaultId: ${oci_kms_vault.test_vault.id}
      databaseSoftwareImageId: ${oci_database_database_software_image.test_database_software_image.id}
      dbSystemId: ${oci_database_db_system.test_db_system.id}
      dbVersion:
        - {}
      definedTags: ${var.db_home_defined_tags}
      displayName: ${var.db_home_display_name}
      enableDatabaseDelete: false
      freeformTags:
        Department: Finance
      isDesupportedVersion: ${var.db_home_is_desupported_version}
      kmsKeyId: ${oci_kms_key.test_key.id}
      kmsKeyVersionId: ${oci_kms_key_version.test_key_version.id}
      source: ${var.db_home_source}
      vmClusterId: ${oci_database_vm_cluster.test_vm_cluster.id}

    Create DbHome Resource

    new DbHome(name: string, args?: DbHomeArgs, opts?: CustomResourceOptions);
    @overload
def DbHome(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           database: Optional[_database.DbHomeDatabaseArgs] = None,
           database_software_image_id: Optional[str] = None,
           db_system_id: Optional[str] = None,
           db_version: Optional[str] = None,
           defined_tags: Optional[Mapping[str, Any]] = None,
           display_name: Optional[str] = None,
           enable_database_delete: Optional[bool] = None,
           freeform_tags: Optional[Mapping[str, Any]] = None,
           is_desupported_version: Optional[bool] = None,
           kms_key_id: Optional[str] = None,
           kms_key_version_id: Optional[str] = None,
           source: Optional[str] = None,
           vm_cluster_id: Optional[str] = None)
@overload
def DbHome(resource_name: str,
           args: Optional[DbHomeArgs] = None,
           opts: Optional[ResourceOptions] = None)
    func NewDbHome(ctx *Context, name string, args *DbHomeArgs, opts ...ResourceOption) (*DbHome, error)
    public DbHome(string name, DbHomeArgs? args = null, CustomResourceOptions? opts = null)
    public DbHome(String name, DbHomeArgs args)
public DbHome(String name, DbHomeArgs args, CustomResourceOptions options)

    type: oci:Database:DbHome
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DbHomeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DbHomeArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DbHomeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DbHomeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DbHomeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    DbHome Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The DbHome resource accepts the following input properties:

    Database DbHomeDatabase

    (Updatable) Details for creating a database.

    Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

    DatabaseSoftwareImageId string

    The database software image OCID

    DbSystemId string

    The OCID of the DB system.

    DbVersion string

    A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.

    This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

    DefinedTags Dictionary<string, object>

    (Updatable) 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 of the Database Home.

    EnableDatabaseDelete bool

    Defaults to false. If omitted or set to false the provider will not delete databases removed from the Db Home configuration.

    FreeformTags Dictionary<string, object>

    (Updatable) 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"}

    IsDesupportedVersion bool

    If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI.

    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.

    Source string

    The source of database: NONE for creating a new database. DB_BACKUP for creating a new database by restoring from a database backup. VM_CLUSTER_NEW for creating a database for VM Cluster.

    VmClusterId string

    The OCID of the VM cluster.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Database DbHomeDatabaseArgs

    (Updatable) Details for creating a database.

    Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

    DatabaseSoftwareImageId string

    The database software image OCID

    DbSystemId string

    The OCID of the DB system.

    DbVersion string

    A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.

    This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

    DefinedTags map[string]interface{}

    (Updatable) 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 of the Database Home.

    EnableDatabaseDelete bool

    Defaults to false. If omitted or set to false the provider will not delete databases removed from the Db Home configuration.

    FreeformTags map[string]interface{}

    (Updatable) 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"}

    IsDesupportedVersion bool

    If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI.

    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.

    Source string

    The source of database: NONE for creating a new database. DB_BACKUP for creating a new database by restoring from a database backup. VM_CLUSTER_NEW for creating a database for VM Cluster.

    VmClusterId string

    The OCID of the VM cluster.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    database DbHome

    (Updatable) Details for creating a database.

    Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

    databaseSoftwareImageId String

    The database software image OCID

    dbSystemId String

    The OCID of the DB system.

    dbVersion String

    A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.

    This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

    definedTags Map<String,Object>

    (Updatable) 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 of the Database Home.

    enableDatabaseDelete Boolean

    Defaults to false. If omitted or set to false the provider will not delete databases removed from the Db Home configuration.

    freeformTags Map<String,Object>

    (Updatable) 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"}

    isDesupportedVersion Boolean

    If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI.

    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.

    source String

    The source of database: NONE for creating a new database. DB_BACKUP for creating a new database by restoring from a database backup. VM_CLUSTER_NEW for creating a database for VM Cluster.

    vmClusterId String

    The OCID of the VM cluster.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    database DbHomeDatabase

    (Updatable) Details for creating a database.

    Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

    databaseSoftwareImageId string

    The database software image OCID

    dbSystemId string

    The OCID of the DB system.

    dbVersion string

    A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.

    This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

    definedTags {[key: string]: any}

    (Updatable) 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 of the Database Home.

    enableDatabaseDelete boolean

    Defaults to false. If omitted or set to false the provider will not delete databases removed from the Db Home configuration.

    freeformTags {[key: string]: any}

    (Updatable) 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"}

    isDesupportedVersion boolean

    If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI.

    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.

    source string

    The source of database: NONE for creating a new database. DB_BACKUP for creating a new database by restoring from a database backup. VM_CLUSTER_NEW for creating a database for VM Cluster.

    vmClusterId string

    The OCID of the VM cluster.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    database DbHomeDatabaseArgs

    (Updatable) Details for creating a database.

    Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

    database_software_image_id str

    The database software image OCID

    db_system_id str

    The OCID of the DB system.

    db_version str

    A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.

    This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

    defined_tags Mapping[str, Any]

    (Updatable) 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 of the Database Home.

    enable_database_delete bool

    Defaults to false. If omitted or set to false the provider will not delete databases removed from the Db Home configuration.

    freeform_tags Mapping[str, Any]

    (Updatable) 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"}

    is_desupported_version bool

    If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI.

    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.

    source str

    The source of database: NONE for creating a new database. DB_BACKUP for creating a new database by restoring from a database backup. VM_CLUSTER_NEW for creating a database for VM Cluster.

    vm_cluster_id str

    The OCID of the VM cluster.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    database Property Map

    (Updatable) Details for creating a database.

    Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

    databaseSoftwareImageId String

    The database software image OCID

    dbSystemId String

    The OCID of the DB system.

    dbVersion String

    A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.

    This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

    definedTags Map<Any>

    (Updatable) 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 of the Database Home.

    enableDatabaseDelete Boolean

    Defaults to false. If omitted or set to false the provider will not delete databases removed from the Db Home configuration.

    freeformTags Map<Any>

    (Updatable) 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"}

    isDesupportedVersion Boolean

    If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI.

    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.

    source String

    The source of database: NONE for creating a new database. DB_BACKUP for creating a new database by restoring from a database backup. VM_CLUSTER_NEW for creating a database for VM Cluster.

    vmClusterId String

    The OCID of the VM cluster.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DbHome resource produces the following output properties:

    CompartmentId string

    The OCID of the compartment.

    DbHomeLocation string

    The location of the Oracle Database Home.

    Id string

    The provider-assigned unique ID for this managed resource.

    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.

    State string

    The current state of the Database Home.

    TimeCreated string

    The date and time the Database Home was created.

    CompartmentId string

    The OCID of the compartment.

    DbHomeLocation string

    The location of the Oracle Database Home.

    Id string

    The provider-assigned unique ID for this managed resource.

    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.

    State string

    The current state of the Database Home.

    TimeCreated string

    The date and time the Database Home was created.

    compartmentId String

    The OCID of the compartment.

    dbHomeLocation String

    The location of the Oracle Database Home.

    id String

    The provider-assigned unique ID for this managed resource.

    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.

    state String

    The current state of the Database Home.

    timeCreated String

    The date and time the Database Home was created.

    compartmentId string

    The OCID of the compartment.

    dbHomeLocation string

    The location of the Oracle Database Home.

    id string

    The provider-assigned unique ID for this managed resource.

    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.

    state string

    The current state of the Database Home.

    timeCreated string

    The date and time the Database Home was created.

    compartment_id str

    The OCID of the compartment.

    db_home_location str

    The location of the Oracle Database Home.

    id str

    The provider-assigned unique ID for this managed resource.

    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.

    state str

    The current state of the Database Home.

    time_created str

    The date and time the Database Home was created.

    compartmentId String

    The OCID of the compartment.

    dbHomeLocation String

    The location of the Oracle Database Home.

    id String

    The provider-assigned unique ID for this managed resource.

    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.

    state String

    The current state of the Database Home.

    timeCreated String

    The date and time the Database Home was created.

    Look up Existing DbHome Resource

    Get an existing DbHome resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DbHomeState, opts?: CustomResourceOptions): DbHome
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        database: Optional[_database.DbHomeDatabaseArgs] = None,
        database_software_image_id: Optional[str] = None,
        db_home_location: Optional[str] = None,
        db_system_id: Optional[str] = None,
        db_version: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        display_name: Optional[str] = None,
        enable_database_delete: Optional[bool] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        is_desupported_version: Optional[bool] = None,
        kms_key_id: Optional[str] = None,
        kms_key_version_id: Optional[str] = None,
        last_patch_history_entry_id: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        source: Optional[str] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        vm_cluster_id: Optional[str] = None) -> DbHome
    func GetDbHome(ctx *Context, name string, id IDInput, state *DbHomeState, opts ...ResourceOption) (*DbHome, error)
    public static DbHome Get(string name, Input<string> id, DbHomeState? state, CustomResourceOptions? opts = null)
    public static DbHome get(String name, Output<String> id, DbHomeState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CompartmentId string

    The OCID of the compartment.

    Database DbHomeDatabase

    (Updatable) Details for creating a database.

    Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

    DatabaseSoftwareImageId string

    The database software image OCID

    DbHomeLocation string

    The location of the Oracle Database Home.

    DbSystemId string

    The OCID of the DB system.

    DbVersion string

    A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.

    This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

    DefinedTags Dictionary<string, object>

    (Updatable) 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 of the Database Home.

    EnableDatabaseDelete bool

    Defaults to false. If omitted or set to false the provider will not delete databases removed from the Db Home configuration.

    FreeformTags Dictionary<string, object>

    (Updatable) 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"}

    IsDesupportedVersion bool

    If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI.

    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.

    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

    The source of database: NONE for creating a new database. DB_BACKUP for creating a new database by restoring from a database backup. VM_CLUSTER_NEW for creating a database for VM Cluster.

    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.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    CompartmentId string

    The OCID of the compartment.

    Database DbHomeDatabaseArgs

    (Updatable) Details for creating a database.

    Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

    DatabaseSoftwareImageId string

    The database software image OCID

    DbHomeLocation string

    The location of the Oracle Database Home.

    DbSystemId string

    The OCID of the DB system.

    DbVersion string

    A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.

    This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

    DefinedTags map[string]interface{}

    (Updatable) 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 of the Database Home.

    EnableDatabaseDelete bool

    Defaults to false. If omitted or set to false the provider will not delete databases removed from the Db Home configuration.

    FreeformTags map[string]interface{}

    (Updatable) 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"}

    IsDesupportedVersion bool

    If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI.

    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.

    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

    The source of database: NONE for creating a new database. DB_BACKUP for creating a new database by restoring from a database backup. VM_CLUSTER_NEW for creating a database for VM Cluster.

    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.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String

    The OCID of the compartment.

    database DbHome

    (Updatable) Details for creating a database.

    Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

    databaseSoftwareImageId String

    The database software image OCID

    dbHomeLocation String

    The location of the Oracle Database Home.

    dbSystemId String

    The OCID of the DB system.

    dbVersion String

    A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.

    This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

    definedTags Map<String,Object>

    (Updatable) 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 of the Database Home.

    enableDatabaseDelete Boolean

    Defaults to false. If omitted or set to false the provider will not delete databases removed from the Db Home configuration.

    freeformTags Map<String,Object>

    (Updatable) 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"}

    isDesupportedVersion Boolean

    If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI.

    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.

    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

    The source of database: NONE for creating a new database. DB_BACKUP for creating a new database by restoring from a database backup. VM_CLUSTER_NEW for creating a database for VM Cluster.

    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.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId string

    The OCID of the compartment.

    database DbHomeDatabase

    (Updatable) Details for creating a database.

    Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

    databaseSoftwareImageId string

    The database software image OCID

    dbHomeLocation string

    The location of the Oracle Database Home.

    dbSystemId string

    The OCID of the DB system.

    dbVersion string

    A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.

    This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

    definedTags {[key: string]: any}

    (Updatable) 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 of the Database Home.

    enableDatabaseDelete boolean

    Defaults to false. If omitted or set to false the provider will not delete databases removed from the Db Home configuration.

    freeformTags {[key: string]: any}

    (Updatable) 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"}

    isDesupportedVersion boolean

    If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI.

    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.

    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

    The source of database: NONE for creating a new database. DB_BACKUP for creating a new database by restoring from a database backup. VM_CLUSTER_NEW for creating a database for VM Cluster.

    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.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartment_id str

    The OCID of the compartment.

    database DbHomeDatabaseArgs

    (Updatable) Details for creating a database.

    Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

    database_software_image_id str

    The database software image OCID

    db_home_location str

    The location of the Oracle Database Home.

    db_system_id str

    The OCID of the DB system.

    db_version str

    A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.

    This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

    defined_tags Mapping[str, Any]

    (Updatable) 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 of the Database Home.

    enable_database_delete bool

    Defaults to false. If omitted or set to false the provider will not delete databases removed from the Db Home configuration.

    freeform_tags Mapping[str, Any]

    (Updatable) 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"}

    is_desupported_version bool

    If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI.

    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.

    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

    The source of database: NONE for creating a new database. DB_BACKUP for creating a new database by restoring from a database backup. VM_CLUSTER_NEW for creating a database for VM Cluster.

    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.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String

    The OCID of the compartment.

    database Property Map

    (Updatable) Details for creating a database.

    Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

    databaseSoftwareImageId String

    The database software image OCID

    dbHomeLocation String

    The location of the Oracle Database Home.

    dbSystemId String

    The OCID of the DB system.

    dbVersion String

    A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.

    This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

    definedTags Map<Any>

    (Updatable) 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 of the Database Home.

    enableDatabaseDelete Boolean

    Defaults to false. If omitted or set to false the provider will not delete databases removed from the Db Home configuration.

    freeformTags Map<Any>

    (Updatable) 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"}

    isDesupportedVersion Boolean

    If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI.

    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.

    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

    The source of database: NONE for creating a new database. DB_BACKUP for creating a new database by restoring from a database backup. VM_CLUSTER_NEW for creating a database for VM Cluster.

    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.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Supporting Types

    DbHomeDatabase, DbHomeDatabaseArgs

    AdminPassword string

    A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.

    BackupId string

    The backup OCID.

    BackupTdePassword string

    The password to open the TDE wallet.

    CharacterSet string

    The character set for the database. The default is AL32UTF8. Allowed values are:

    AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS

    ConnectionStrings List<DbHomeDatabaseConnectionString>
    DatabaseId string

    The database OCID.

    DatabaseSoftwareImageId string

    The database software image OCID

    DbBackupConfig DbHomeDatabaseDbBackupConfig

    (Updatable) 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

    The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

    DbUniqueName 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.

    The database workload type.

    DefinedTags Dictionary<string, object>

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

    FreeformTags Dictionary<string, object>

    (Updatable) 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 backup destination.

    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.

    LifecycleDetails string

    Additional information about the current lifecycle state.

    NcharacterSet string

    The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

    OneOffPatches List<string>

    List of one-off patches for Database Homes.

    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.

    State string

    The current state of the Database Home.

    TdeWalletPassword string

    The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, #, or -.

    TimeCreated string

    The date and time the Database Home was created.

    TimeStampForPointInTimeRecovery string

    The point in time of the original database from which the new database is created. If not specifed, the latest backup is used to create the database.

    VaultId string

    The OCID of the Oracle Cloud Infrastructure vault.

    AdminPassword string

    A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.

    BackupId string

    The backup OCID.

    BackupTdePassword string

    The password to open the TDE wallet.

    CharacterSet string

    The character set for the database. The default is AL32UTF8. Allowed values are:

    AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS

    ConnectionStrings []DbHomeDatabaseConnectionString
    DatabaseId string

    The database OCID.

    DatabaseSoftwareImageId string

    The database software image OCID

    DbBackupConfig DbHomeDatabaseDbBackupConfig

    (Updatable) 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

    The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

    DbUniqueName 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.

    The database workload type.

    DefinedTags map[string]interface{}

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

    FreeformTags map[string]interface{}

    (Updatable) 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 backup destination.

    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.

    LifecycleDetails string

    Additional information about the current lifecycle state.

    NcharacterSet string

    The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

    OneOffPatches []string

    List of one-off patches for Database Homes.

    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.

    State string

    The current state of the Database Home.

    TdeWalletPassword string

    The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, #, or -.

    TimeCreated string

    The date and time the Database Home was created.

    TimeStampForPointInTimeRecovery string

    The point in time of the original database from which the new database is created. If not specifed, the latest backup is used to create the database.

    VaultId string

    The OCID of the Oracle Cloud Infrastructure vault.

    adminPassword String

    A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.

    backupId String

    The backup OCID.

    backupTdePassword String

    The password to open the TDE wallet.

    characterSet String

    The character set for the database. The default is AL32UTF8. Allowed values are:

    AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS

    connectionStrings List<DbHomeConnectionString>
    databaseId String

    The database OCID.

    databaseSoftwareImageId String

    The database software image OCID

    dbBackupConfig DbHomeDbBackupConfig

    (Updatable) 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

    The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

    dbUniqueName 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.

    The database workload type.

    definedTags Map<String,Object>

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

    freeformTags Map<String,Object>

    (Updatable) 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 backup destination.

    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.

    lifecycleDetails String

    Additional information about the current lifecycle state.

    ncharacterSet String

    The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

    oneOffPatches List<String>

    List of one-off patches for Database Homes.

    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.

    state String

    The current state of the Database Home.

    tdeWalletPassword String

    The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, #, or -.

    timeCreated String

    The date and time the Database Home was created.

    timeStampForPointInTimeRecovery String

    The point in time of the original database from which the new database is created. If not specifed, the latest backup is used to create the database.

    vaultId String

    The OCID of the Oracle Cloud Infrastructure vault.

    adminPassword string

    A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.

    backupId string

    The backup OCID.

    backupTdePassword string

    The password to open the TDE wallet.

    characterSet string

    The character set for the database. The default is AL32UTF8. Allowed values are:

    AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS

    connectionStrings DbHomeDatabaseConnectionString[]
    databaseId string

    The database OCID.

    databaseSoftwareImageId string

    The database software image OCID

    dbBackupConfig DbHomeDatabaseDbBackupConfig

    (Updatable) 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

    The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

    dbUniqueName 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.

    The database workload type.

    definedTags {[key: string]: any}

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

    freeformTags {[key: string]: any}

    (Updatable) 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 backup destination.

    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.

    lifecycleDetails string

    Additional information about the current lifecycle state.

    ncharacterSet string

    The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

    oneOffPatches string[]

    List of one-off patches for Database Homes.

    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.

    state string

    The current state of the Database Home.

    tdeWalletPassword string

    The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, #, or -.

    timeCreated string

    The date and time the Database Home was created.

    timeStampForPointInTimeRecovery string

    The point in time of the original database from which the new database is created. If not specifed, the latest backup is used to create the database.

    vaultId string

    The OCID of the Oracle Cloud Infrastructure vault.

    admin_password str

    A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.

    backup_id str

    The backup OCID.

    backup_tde_password str

    The password to open the TDE wallet.

    character_set str

    The character set for the database. The default is AL32UTF8. Allowed values are:

    AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS

    connection_strings DbHomeDatabaseConnectionString]
    database_id str

    The database OCID.

    database_software_image_id str

    The database software image OCID

    db_backup_config DbHomeDatabaseDbBackupConfig

    (Updatable) 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

    The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

    db_unique_name 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.

    The database workload type.

    defined_tags Mapping[str, Any]

    (Updatable) 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]

    (Updatable) 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 backup destination.

    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.

    lifecycle_details str

    Additional information about the current lifecycle state.

    ncharacter_set str

    The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

    one_off_patches Sequence[str]

    List of one-off patches for Database Homes.

    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.

    state str

    The current state of the Database Home.

    tde_wallet_password str

    The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, #, or -.

    time_created str

    The date and time the Database Home was created.

    time_stamp_for_point_in_time_recovery str

    The point in time of the original database from which the new database is created. If not specifed, the latest backup is used to create the database.

    vault_id str

    The OCID of the Oracle Cloud Infrastructure vault.

    adminPassword String

    A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.

    backupId String

    The backup OCID.

    backupTdePassword String

    The password to open the TDE wallet.

    characterSet String

    The character set for the database. The default is AL32UTF8. Allowed values are:

    AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS

    connectionStrings List<Property Map>
    databaseId String

    The database OCID.

    databaseSoftwareImageId String

    The database software image OCID

    dbBackupConfig Property Map

    (Updatable) 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

    The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

    dbUniqueName 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.

    The database workload type.

    definedTags Map<Any>

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

    freeformTags Map<Any>

    (Updatable) 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 backup destination.

    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.

    lifecycleDetails String

    Additional information about the current lifecycle state.

    ncharacterSet String

    The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

    oneOffPatches List<String>

    List of one-off patches for Database Homes.

    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.

    state String

    The current state of the Database Home.

    tdeWalletPassword String

    The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, #, or -.

    timeCreated String

    The date and time the Database Home was created.

    timeStampForPointInTimeRecovery String

    The point in time of the original database from which the new database is created. If not specifed, the latest backup is used to create the database.

    vaultId String

    The OCID of the Oracle Cloud Infrastructure vault.

    DbHomeDatabaseConnectionString, DbHomeDatabaseConnectionStringArgs

    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

    DbHomeDatabaseDbBackupConfig, DbHomeDatabaseDbBackupConfigArgs

    AutoBackupEnabled bool

    (Updatable) 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

    (Updatable) 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<DbHomeDatabaseDbBackupConfigBackupDestinationDetail>

    Backup destination details.

    RecoveryWindowInDays int

    (Updatable) 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

    (Updatable) 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

    (Updatable) 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 []DbHomeDatabaseDbBackupConfigBackupDestinationDetail

    Backup destination details.

    RecoveryWindowInDays int

    (Updatable) 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

    (Updatable) 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

    (Updatable) 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<DbHomeDbBackupConfigBackupDestinationDetail>

    Backup destination details.

    recoveryWindowInDays Integer

    (Updatable) 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

    (Updatable) 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

    (Updatable) 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 DbHomeDatabaseDbBackupConfigBackupDestinationDetail[]

    Backup destination details.

    recoveryWindowInDays number

    (Updatable) 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

    (Updatable) 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

    (Updatable) 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 DbHomeDatabaseDbBackupConfigBackupDestinationDetail]

    Backup destination details.

    recovery_window_in_days int

    (Updatable) 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

    (Updatable) 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

    (Updatable) 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

    (Updatable) 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.

    DbHomeDatabaseDbBackupConfigBackupDestinationDetail, DbHomeDatabaseDbBackupConfigBackupDestinationDetailArgs

    DbrsPolicyId string

    The OCID of the DBRS policy used for backup.

    Id string

    The OCID of the backup destination.

    Type string

    Type of the database backup destination. Supported values: NFS.

    DbrsPolicyId string

    The OCID of the DBRS policy used for backup.

    Id string

    The OCID of the backup destination.

    Type string

    Type of the database backup destination. Supported values: NFS.

    dbrsPolicyId String

    The OCID of the DBRS policy used for backup.

    id String

    The OCID of the backup destination.

    type String

    Type of the database backup destination. Supported values: NFS.

    dbrsPolicyId string

    The OCID of the DBRS policy used for backup.

    id string

    The OCID of the backup destination.

    type string

    Type of the database backup destination. Supported values: NFS.

    dbrs_policy_id str

    The OCID of the DBRS policy used for backup.

    id str

    The OCID of the backup destination.

    type str

    Type of the database backup destination. Supported values: NFS.

    dbrsPolicyId String

    The OCID of the DBRS policy used for backup.

    id String

    The OCID of the backup destination.

    type String

    Type of the database backup destination. Supported values: NFS.

    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 v1.10.0 published on Thursday, Sep 7, 2023 by Pulumi
    pulumi/pulumi-oci