Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

DbHome

This resource provides the Db Home resource in Oracle Cloud Infrastructure Database service.

Creates a new Database Home in the specified database system based on the request parameters you provide. Applies only to bare metal and Exadata systems.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testDbHome = new Oci.Database.DbHome("testDbHome", new Oci.Database.DbHomeArgs
        {
            Database = new Oci.Database.Inputs.DbHomeDatabaseArgs
            {
                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 = new Oci.Database.Inputs.DbHomeDatabaseDbBackupConfigArgs
                {
                    AutoBackupEnabled = @var.Db_home_database_db_backup_config_auto_backup_enabled,
                    AutoBackupWindow = @var.Db_home_database_db_backup_config_auto_backup_window,
                    BackupDestinationDetails = 
                    {
                        new Oci.Database.Inputs.DbHomeDatabaseDbBackupConfigBackupDestinationDetailArgs
                        {
                            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,
                },
                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,
            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,
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/Database"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Database.NewDbHome(ctx, "testDbHome", &Database.DbHomeArgs{
			Database: &database.DbHomeDatabaseArgs{
				AdminPassword:           pulumi.Any(_var.Db_home_database_admin_password),
				BackupId:                pulumi.Any(oci_database_backup.Test_backup.Id),
				BackupTdePassword:       pulumi.Any(_var.Db_home_database_backup_tde_password),
				CharacterSet:            pulumi.Any(_var.Db_home_database_character_set),
				DatabaseId:              pulumi.Any(oci_database_database.Test_database.Id),
				DatabaseSoftwareImageId: pulumi.Any(oci_database_database_software_image.Test_database_software_image.Id),
				DbBackupConfig: &database.DbHomeDatabaseDbBackupConfigArgs{
					AutoBackupEnabled: pulumi.Any(_var.Db_home_database_db_backup_config_auto_backup_enabled),
					AutoBackupWindow:  pulumi.Any(_var.Db_home_database_db_backup_config_auto_backup_window),
					BackupDestinationDetails: database.DbHomeDatabaseDbBackupConfigBackupDestinationDetailArray{
						&database.DbHomeDatabaseDbBackupConfigBackupDestinationDetailArgs{
							Id:   pulumi.Any(_var.Db_home_database_db_backup_config_backup_destination_details_id),
							Type: pulumi.Any(_var.Db_home_database_db_backup_config_backup_destination_details_type),
						},
					},
					RecoveryWindowInDays: pulumi.Any(_var.Db_home_database_db_backup_config_recovery_window_in_days),
				},
				DbName:                          pulumi.Any(_var.Db_home_database_db_name),
				DbWorkload:                      pulumi.Any(_var.Db_home_database_db_workload),
				DefinedTags:                     pulumi.Any(_var.Db_home_database_defined_tags),
				FreeformTags:                    pulumi.Any(_var.Db_home_database_freeform_tags),
				KmsKeyId:                        pulumi.Any(oci_kms_key.Test_key.Id),
				KmsKeyVersionId:                 pulumi.Any(oci_kms_key_version.Test_key_version.Id),
				NcharacterSet:                   pulumi.Any(_var.Db_home_database_ncharacter_set),
				PdbName:                         pulumi.Any(_var.Db_home_database_pdb_name),
				SidPrefix:                       pulumi.Any(_var.Db_home_database_sid_prefix),
				TdeWalletPassword:               pulumi.Any(_var.Db_home_database_tde_wallet_password),
				TimeStampForPointInTimeRecovery: pulumi.Any(_var.Db_home_database_time_stamp_for_point_in_time_recovery),
				VaultId:                         pulumi.Any(oci_kms_vault.Test_vault.Id),
			},
			DatabaseSoftwareImageId: pulumi.Any(oci_database_database_software_image.Test_database_software_image.Id),
			DbSystemId:              pulumi.Any(oci_database_db_system.Test_db_system.Id),
			DbVersion: pulumi.String{
				nil,
			},
			DefinedTags: pulumi.Any(_var.Db_home_defined_tags),
			DisplayName: pulumi.Any(_var.Db_home_display_name),
			FreeformTags: pulumi.AnyMap{
				"Department": pulumi.Any("Finance"),
			},
			IsDesupportedVersion: pulumi.Any(_var.Db_home_is_desupported_version),
			KmsKeyId:             pulumi.Any(oci_kms_key.Test_key.Id),
			KmsKeyVersionId:      pulumi.Any(oci_kms_key_version.Test_key_version.Id),
			Source:               pulumi.Any(_var.Db_home_source),
			VmClusterId:          pulumi.Any(oci_database_vm_cluster.Test_vm_cluster.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_db_home = oci.database.DbHome("testDbHome",
    database=oci.database.DbHomeDatabaseArgs(
        admin_password=var["db_home_database_admin_password"],
        backup_id=oci_database_backup["test_backup"]["id"],
        backup_tde_password=var["db_home_database_backup_tde_password"],
        character_set=var["db_home_database_character_set"],
        database_id=oci_database_database["test_database"]["id"],
        database_software_image_id=oci_database_database_software_image["test_database_software_image"]["id"],
        db_backup_config=oci.database.DbHomeDatabaseDbBackupConfigArgs(
            auto_backup_enabled=var["db_home_database_db_backup_config_auto_backup_enabled"],
            auto_backup_window=var["db_home_database_db_backup_config_auto_backup_window"],
            backup_destination_details=[oci.database.DbHomeDatabaseDbBackupConfigBackupDestinationDetailArgs(
                id=var["db_home_database_db_backup_config_backup_destination_details_id"],
                type=var["db_home_database_db_backup_config_backup_destination_details_type"],
            )],
            recovery_window_in_days=var["db_home_database_db_backup_config_recovery_window_in_days"],
        ),
        db_name=var["db_home_database_db_name"],
        db_workload=var["db_home_database_db_workload"],
        defined_tags=var["db_home_database_defined_tags"],
        freeform_tags=var["db_home_database_freeform_tags"],
        kms_key_id=oci_kms_key["test_key"]["id"],
        kms_key_version_id=oci_kms_key_version["test_key_version"]["id"],
        ncharacter_set=var["db_home_database_ncharacter_set"],
        pdb_name=var["db_home_database_pdb_name"],
        sid_prefix=var["db_home_database_sid_prefix"],
        tde_wallet_password=var["db_home_database_tde_wallet_password"],
        time_stamp_for_point_in_time_recovery=var["db_home_database_time_stamp_for_point_in_time_recovery"],
        vault_id=oci_kms_vault["test_vault"]["id"],
    ),
    database_software_image_id=oci_database_database_software_image["test_database_software_image"]["id"],
    db_system_id=oci_database_db_system["test_db_system"]["id"],
    db_version=[{}],
    defined_tags=var["db_home_defined_tags"],
    display_name=var["db_home_display_name"],
    freeform_tags={
        "Department": "Finance",
    },
    is_desupported_version=var["db_home_is_desupported_version"],
    kms_key_id=oci_kms_key["test_key"]["id"],
    kms_key_version_id=oci_kms_key_version["test_key_version"]["id"],
    source=var["db_home_source"],
    vm_cluster_id=oci_database_vm_cluster["test_vm_cluster"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testDbHome = new oci.database.DbHome("testDbHome", {
    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,
            backupDestinationDetails: [{
                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,
        },
        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,
    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,
});

Coming soon!

Create a 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,
           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: DbHomeArgs,
           opts: Optional[ResourceOptions] = None)
func NewDbHome(ctx *Context, name string, args DbHomeArgs, opts ...ResourceOption) (*DbHome, error)
public DbHome(string name, DbHomeArgs args, 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 DbHomeDatabaseArgs

(Updatable) Details for creating a database.

DatabaseSoftwareImageId string

The database software image OCID

DbSystemId string

The OCID of the DB system.

DbVersion string

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

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.

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.

Database DbHomeDatabaseArgs

(Updatable) Details for creating a database.

DatabaseSoftwareImageId string

The database software image OCID

DbSystemId string

The OCID of the DB system.

DbVersion string

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

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.

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.

database DbHomeArgs

(Updatable) Details for creating a database.

databaseSoftwareImageId String

The database software image OCID

dbSystemId String

The OCID of the DB system.

dbVersion String

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

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.

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.

database DbHomeDatabaseArgs

(Updatable) Details for creating a database.

databaseSoftwareImageId string

The database software image OCID

dbSystemId string

The OCID of the DB system.

dbVersion string

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

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.

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.

database DbHomeDatabaseArgs

(Updatable) Details for creating a database.

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. To get a list of supported versions, use the ListDbVersions operation.

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.

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.

database Property Map

(Updatable) Details for creating a database.

databaseSoftwareImageId String

The database software image OCID

dbSystemId String

The OCID of the DB system.

dbVersion String

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

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.

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.

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 an 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,
        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 DbHomeDatabaseArgs

(Updatable) Details for creating a database.

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. To get a list of supported versions, use the ListDbVersions operation.

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.

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.

CompartmentId string

The OCID of the compartment.

Database DbHomeDatabaseArgs

(Updatable) Details for creating a database.

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. To get a list of supported versions, use the ListDbVersions operation.

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.

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.

compartmentId String

The OCID of the compartment.

database DbHomeArgs

(Updatable) Details for creating a database.

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. To get a list of supported versions, use the ListDbVersions operation.

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.

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.

compartmentId string

The OCID of the compartment.

database DbHomeDatabaseArgs

(Updatable) Details for creating a database.

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. To get a list of supported versions, use the ListDbVersions operation.

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.

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.

compartment_id str

The OCID of the compartment.

database DbHomeDatabaseArgs

(Updatable) Details for creating a database.

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. To get a list of supported versions, use the ListDbVersions operation.

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.

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.

compartmentId String

The OCID of the compartment.

database Property Map

(Updatable) Details for creating a database.

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. To get a list of supported versions, use the ListDbVersions operation.

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.

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.

Supporting Types

DbHomeDatabase

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:

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

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:

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

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:

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

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:

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

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:

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

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:

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

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

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

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

DbHomeDatabaseDbBackupConfigBackupDestinationDetail

Id string

The OCID of the backup destination.

Type string

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

Id string

The OCID of the backup destination.

Type string

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

id String

The OCID of the backup destination.

type String

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

id string

The OCID of the backup destination.

type string

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

id str

The OCID of the backup destination.

type str

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

id String

The OCID of the backup destination.

type String

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

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

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.