oci.Database.DbHome
Explore with Pulumi AI
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
resources:
  testDbHome:
    type: oci:Database:DbHome
    name: test_db_home
    properties:
      dbVersion:
        - {}
      database:
        adminPassword: ${dbHomeDatabaseAdminPassword}
        backupId: ${testBackup.id}
        backupTdePassword: ${dbHomeDatabaseBackupTdePassword}
        characterSet: ${dbHomeDatabaseCharacterSet}
        databaseId: ${testDatabase.id}
        databaseSoftwareImageId: ${testDatabaseSoftwareImage.id}
        dbBackupConfig:
          autoBackupEnabled: ${dbHomeDatabaseDbBackupConfigAutoBackupEnabled}
          autoBackupWindow: ${dbHomeDatabaseDbBackupConfigAutoBackupWindow}
          autoFullBackupDay: ${dbHomeDatabaseDbBackupConfigAutoFullBackupDay}
          autoFullBackupWindow: ${dbHomeDatabaseDbBackupConfigAutoFullBackupWindow}
          backupDeletionPolicy: ${dbHomeDatabaseDbBackupConfigBackupDeletionPolicy}
          backupDestinationDetails:
            - dbrsPolicyId: ${testPolicy.id}
              id: ${dbHomeDatabaseDbBackupConfigBackupDestinationDetailsId}
              type: ${dbHomeDatabaseDbBackupConfigBackupDestinationDetailsType}
          recoveryWindowInDays: ${dbHomeDatabaseDbBackupConfigRecoveryWindowInDays}
          runImmediateFullBackup: ${dbHomeDatabaseDbBackupConfigRunImmediateFullBackup}
        dbName: ${dbHomeDatabaseDbName}
        dbWorkload: ${dbHomeDatabaseDbWorkload}
        definedTags: ${dbHomeDatabaseDefinedTags}
        encryptionKeyLocationDetails:
          hsmPassword: ${dbHomeDatabaseEncryptionKeyLocationDetailsHsmPassword}
          providerType: ${dbHomeDatabaseEncryptionKeyLocationDetailsProviderType}
        freeformTags: ${dbHomeDatabaseFreeformTags}
        keyStoreId: ${testKeyStore.id}
        kmsKeyId: ${testKey.id}
        kmsKeyVersionId: ${testKeyVersion.id}
        ncharacterSet: ${dbHomeDatabaseNcharacterSet}
        pdbName: ${dbHomeDatabasePdbName}
        pluggableDatabases: ${dbHomeDatabasePluggableDatabases}
        sidPrefix: ${dbHomeDatabaseSidPrefix}
        sourceEncryptionKeyLocationDetails:
          - hsmPassword: ${dbHomeDatabaseSourceEncryptionKeyLocationDetailsHsmPassword}
            providerType: ${dbHomeDatabaseSourceEncryptionKeyLocationDetailsProviderType}
        tdeWalletPassword: ${dbHomeDatabaseTdeWalletPassword}
        timeStampForPointInTimeRecovery: ${dbHomeDatabaseTimeStampForPointInTimeRecovery}
        vaultId: ${testVault.id}
      databaseSoftwareImageId: ${testDatabaseSoftwareImage.id}
      dbSystemId: ${testDbSystem.id}
      definedTags: ${dbHomeDefinedTags}
      displayName: ${dbHomeDisplayName}
      enableDatabaseDelete: false
      freeformTags:
        Department: Finance
      isDesupportedVersion: ${dbHomeIsDesupportedVersion}
      isUnifiedAuditingEnabled: ${dbHomeIsUnifiedAuditingEnabled}
      kmsKeyId: ${testKey.id}
      kmsKeyVersionId: ${testKeyVersion.id}
      source: ${dbHomeSource}
      vmClusterId: ${testVmCluster.id}
Create DbHome Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DbHome(name: string, args?: DbHomeArgs, opts?: CustomResourceOptions);@overload
def DbHome(resource_name: str,
           args: Optional[DbHomeArgs] = None,
           opts: Optional[ResourceOptions] = None)
@overload
def DbHome(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           database: Optional[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, str]] = None,
           display_name: Optional[str] = None,
           enable_database_delete: Optional[bool] = None,
           freeform_tags: Optional[Mapping[str, str]] = None,
           is_desupported_version: Optional[bool] = None,
           is_unified_auditing_enabled: 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)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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var dbHomeResource = new Oci.Database.DbHome("dbHomeResource", new()
{
    Database = new Oci.Database.Inputs.DbHomeDatabaseArgs
    {
        AdminPassword = "string",
        BackupId = "string",
        BackupTdePassword = "string",
        CharacterSet = "string",
        ConnectionStrings = new[]
        {
            new Oci.Database.Inputs.DbHomeDatabaseConnectionStringArgs
            {
                AllConnectionStrings = 
                {
                    { "string", "string" },
                },
                CdbDefault = "string",
                CdbIpDefault = "string",
            },
        },
        DatabaseId = "string",
        DatabaseSoftwareImageId = "string",
        DbBackupConfig = new Oci.Database.Inputs.DbHomeDatabaseDbBackupConfigArgs
        {
            AutoBackupEnabled = false,
            AutoBackupWindow = "string",
            AutoFullBackupDay = "string",
            AutoFullBackupWindow = "string",
            BackupDeletionPolicy = "string",
            BackupDestinationDetails = new[]
            {
                new Oci.Database.Inputs.DbHomeDatabaseDbBackupConfigBackupDestinationDetailArgs
                {
                    DbrsPolicyId = "string",
                    Id = "string",
                    Type = "string",
                },
            },
            RecoveryWindowInDays = 0,
            RunImmediateFullBackup = false,
        },
        DbName = "string",
        DbUniqueName = "string",
        DbWorkload = "string",
        DefinedTags = 
        {
            { "string", "string" },
        },
        EncryptionKeyLocationDetails = new Oci.Database.Inputs.DbHomeDatabaseEncryptionKeyLocationDetailsArgs
        {
            HsmPassword = "string",
            ProviderType = "string",
        },
        FreeformTags = 
        {
            { "string", "string" },
        },
        Id = "string",
        KeyStoreId = "string",
        KmsKeyId = "string",
        KmsKeyVersionId = "string",
        LifecycleDetails = "string",
        NcharacterSet = "string",
        OneOffPatches = new[]
        {
            "string",
        },
        PdbName = "string",
        PluggableDatabases = new[]
        {
            "string",
        },
        SidPrefix = "string",
        State = "string",
        TdeWalletPassword = "string",
        TimeCreated = "string",
        TimeStampForPointInTimeRecovery = "string",
        VaultId = "string",
    },
    DatabaseSoftwareImageId = "string",
    DbSystemId = "string",
    DbVersion = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    DisplayName = "string",
    EnableDatabaseDelete = false,
    FreeformTags = 
    {
        { "string", "string" },
    },
    IsDesupportedVersion = false,
    IsUnifiedAuditingEnabled = false,
    KmsKeyId = "string",
    KmsKeyVersionId = "string",
    Source = "string",
    VmClusterId = "string",
});
example, err := database.NewDbHome(ctx, "dbHomeResource", &database.DbHomeArgs{
	Database: &database.DbHomeDatabaseArgs{
		AdminPassword:     pulumi.String("string"),
		BackupId:          pulumi.String("string"),
		BackupTdePassword: pulumi.String("string"),
		CharacterSet:      pulumi.String("string"),
		ConnectionStrings: database.DbHomeDatabaseConnectionStringArray{
			&database.DbHomeDatabaseConnectionStringArgs{
				AllConnectionStrings: pulumi.StringMap{
					"string": pulumi.String("string"),
				},
				CdbDefault:   pulumi.String("string"),
				CdbIpDefault: pulumi.String("string"),
			},
		},
		DatabaseId:              pulumi.String("string"),
		DatabaseSoftwareImageId: pulumi.String("string"),
		DbBackupConfig: &database.DbHomeDatabaseDbBackupConfigArgs{
			AutoBackupEnabled:    pulumi.Bool(false),
			AutoBackupWindow:     pulumi.String("string"),
			AutoFullBackupDay:    pulumi.String("string"),
			AutoFullBackupWindow: pulumi.String("string"),
			BackupDeletionPolicy: pulumi.String("string"),
			BackupDestinationDetails: database.DbHomeDatabaseDbBackupConfigBackupDestinationDetailArray{
				&database.DbHomeDatabaseDbBackupConfigBackupDestinationDetailArgs{
					DbrsPolicyId: pulumi.String("string"),
					Id:           pulumi.String("string"),
					Type:         pulumi.String("string"),
				},
			},
			RecoveryWindowInDays:   pulumi.Int(0),
			RunImmediateFullBackup: pulumi.Bool(false),
		},
		DbName:       pulumi.String("string"),
		DbUniqueName: pulumi.String("string"),
		DbWorkload:   pulumi.String("string"),
		DefinedTags: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		EncryptionKeyLocationDetails: &database.DbHomeDatabaseEncryptionKeyLocationDetailsArgs{
			HsmPassword:  pulumi.String("string"),
			ProviderType: pulumi.String("string"),
		},
		FreeformTags: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		Id:               pulumi.String("string"),
		KeyStoreId:       pulumi.String("string"),
		KmsKeyId:         pulumi.String("string"),
		KmsKeyVersionId:  pulumi.String("string"),
		LifecycleDetails: pulumi.String("string"),
		NcharacterSet:    pulumi.String("string"),
		OneOffPatches: pulumi.StringArray{
			pulumi.String("string"),
		},
		PdbName: pulumi.String("string"),
		PluggableDatabases: pulumi.StringArray{
			pulumi.String("string"),
		},
		SidPrefix:                       pulumi.String("string"),
		State:                           pulumi.String("string"),
		TdeWalletPassword:               pulumi.String("string"),
		TimeCreated:                     pulumi.String("string"),
		TimeStampForPointInTimeRecovery: pulumi.String("string"),
		VaultId:                         pulumi.String("string"),
	},
	DatabaseSoftwareImageId: pulumi.String("string"),
	DbSystemId:              pulumi.String("string"),
	DbVersion:               pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DisplayName:          pulumi.String("string"),
	EnableDatabaseDelete: pulumi.Bool(false),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	IsDesupportedVersion:     pulumi.Bool(false),
	IsUnifiedAuditingEnabled: pulumi.Bool(false),
	KmsKeyId:                 pulumi.String("string"),
	KmsKeyVersionId:          pulumi.String("string"),
	Source:                   pulumi.String("string"),
	VmClusterId:              pulumi.String("string"),
})
var dbHomeResource = new DbHome("dbHomeResource", DbHomeArgs.builder()
    .database(DbHomeDatabaseArgs.builder()
        .adminPassword("string")
        .backupId("string")
        .backupTdePassword("string")
        .characterSet("string")
        .connectionStrings(DbHomeDatabaseConnectionStringArgs.builder()
            .allConnectionStrings(Map.of("string", "string"))
            .cdbDefault("string")
            .cdbIpDefault("string")
            .build())
        .databaseId("string")
        .databaseSoftwareImageId("string")
        .dbBackupConfig(DbHomeDatabaseDbBackupConfigArgs.builder()
            .autoBackupEnabled(false)
            .autoBackupWindow("string")
            .autoFullBackupDay("string")
            .autoFullBackupWindow("string")
            .backupDeletionPolicy("string")
            .backupDestinationDetails(DbHomeDatabaseDbBackupConfigBackupDestinationDetailArgs.builder()
                .dbrsPolicyId("string")
                .id("string")
                .type("string")
                .build())
            .recoveryWindowInDays(0)
            .runImmediateFullBackup(false)
            .build())
        .dbName("string")
        .dbUniqueName("string")
        .dbWorkload("string")
        .definedTags(Map.of("string", "string"))
        .encryptionKeyLocationDetails(DbHomeDatabaseEncryptionKeyLocationDetailsArgs.builder()
            .hsmPassword("string")
            .providerType("string")
            .build())
        .freeformTags(Map.of("string", "string"))
        .id("string")
        .keyStoreId("string")
        .kmsKeyId("string")
        .kmsKeyVersionId("string")
        .lifecycleDetails("string")
        .ncharacterSet("string")
        .oneOffPatches("string")
        .pdbName("string")
        .pluggableDatabases("string")
        .sidPrefix("string")
        .state("string")
        .tdeWalletPassword("string")
        .timeCreated("string")
        .timeStampForPointInTimeRecovery("string")
        .vaultId("string")
        .build())
    .databaseSoftwareImageId("string")
    .dbSystemId("string")
    .dbVersion("string")
    .definedTags(Map.of("string", "string"))
    .displayName("string")
    .enableDatabaseDelete(false)
    .freeformTags(Map.of("string", "string"))
    .isDesupportedVersion(false)
    .isUnifiedAuditingEnabled(false)
    .kmsKeyId("string")
    .kmsKeyVersionId("string")
    .source("string")
    .vmClusterId("string")
    .build());
db_home_resource = oci.database.DbHome("dbHomeResource",
    database={
        "admin_password": "string",
        "backup_id": "string",
        "backup_tde_password": "string",
        "character_set": "string",
        "connection_strings": [{
            "all_connection_strings": {
                "string": "string",
            },
            "cdb_default": "string",
            "cdb_ip_default": "string",
        }],
        "database_id": "string",
        "database_software_image_id": "string",
        "db_backup_config": {
            "auto_backup_enabled": False,
            "auto_backup_window": "string",
            "auto_full_backup_day": "string",
            "auto_full_backup_window": "string",
            "backup_deletion_policy": "string",
            "backup_destination_details": [{
                "dbrs_policy_id": "string",
                "id": "string",
                "type": "string",
            }],
            "recovery_window_in_days": 0,
            "run_immediate_full_backup": False,
        },
        "db_name": "string",
        "db_unique_name": "string",
        "db_workload": "string",
        "defined_tags": {
            "string": "string",
        },
        "encryption_key_location_details": {
            "hsm_password": "string",
            "provider_type": "string",
        },
        "freeform_tags": {
            "string": "string",
        },
        "id": "string",
        "key_store_id": "string",
        "kms_key_id": "string",
        "kms_key_version_id": "string",
        "lifecycle_details": "string",
        "ncharacter_set": "string",
        "one_off_patches": ["string"],
        "pdb_name": "string",
        "pluggable_databases": ["string"],
        "sid_prefix": "string",
        "state": "string",
        "tde_wallet_password": "string",
        "time_created": "string",
        "time_stamp_for_point_in_time_recovery": "string",
        "vault_id": "string",
    },
    database_software_image_id="string",
    db_system_id="string",
    db_version="string",
    defined_tags={
        "string": "string",
    },
    display_name="string",
    enable_database_delete=False,
    freeform_tags={
        "string": "string",
    },
    is_desupported_version=False,
    is_unified_auditing_enabled=False,
    kms_key_id="string",
    kms_key_version_id="string",
    source="string",
    vm_cluster_id="string")
const dbHomeResource = new oci.database.DbHome("dbHomeResource", {
    database: {
        adminPassword: "string",
        backupId: "string",
        backupTdePassword: "string",
        characterSet: "string",
        connectionStrings: [{
            allConnectionStrings: {
                string: "string",
            },
            cdbDefault: "string",
            cdbIpDefault: "string",
        }],
        databaseId: "string",
        databaseSoftwareImageId: "string",
        dbBackupConfig: {
            autoBackupEnabled: false,
            autoBackupWindow: "string",
            autoFullBackupDay: "string",
            autoFullBackupWindow: "string",
            backupDeletionPolicy: "string",
            backupDestinationDetails: [{
                dbrsPolicyId: "string",
                id: "string",
                type: "string",
            }],
            recoveryWindowInDays: 0,
            runImmediateFullBackup: false,
        },
        dbName: "string",
        dbUniqueName: "string",
        dbWorkload: "string",
        definedTags: {
            string: "string",
        },
        encryptionKeyLocationDetails: {
            hsmPassword: "string",
            providerType: "string",
        },
        freeformTags: {
            string: "string",
        },
        id: "string",
        keyStoreId: "string",
        kmsKeyId: "string",
        kmsKeyVersionId: "string",
        lifecycleDetails: "string",
        ncharacterSet: "string",
        oneOffPatches: ["string"],
        pdbName: "string",
        pluggableDatabases: ["string"],
        sidPrefix: "string",
        state: "string",
        tdeWalletPassword: "string",
        timeCreated: "string",
        timeStampForPointInTimeRecovery: "string",
        vaultId: "string",
    },
    databaseSoftwareImageId: "string",
    dbSystemId: "string",
    dbVersion: "string",
    definedTags: {
        string: "string",
    },
    displayName: "string",
    enableDatabaseDelete: false,
    freeformTags: {
        string: "string",
    },
    isDesupportedVersion: false,
    isUnifiedAuditingEnabled: false,
    kmsKeyId: "string",
    kmsKeyVersionId: "string",
    source: "string",
    vmClusterId: "string",
});
type: oci:Database:DbHome
properties:
    database:
        adminPassword: string
        backupId: string
        backupTdePassword: string
        characterSet: string
        connectionStrings:
            - allConnectionStrings:
                string: string
              cdbDefault: string
              cdbIpDefault: string
        databaseId: string
        databaseSoftwareImageId: string
        dbBackupConfig:
            autoBackupEnabled: false
            autoBackupWindow: string
            autoFullBackupDay: string
            autoFullBackupWindow: string
            backupDeletionPolicy: string
            backupDestinationDetails:
                - dbrsPolicyId: string
                  id: string
                  type: string
            recoveryWindowInDays: 0
            runImmediateFullBackup: false
        dbName: string
        dbUniqueName: string
        dbWorkload: string
        definedTags:
            string: string
        encryptionKeyLocationDetails:
            hsmPassword: string
            providerType: string
        freeformTags:
            string: string
        id: string
        keyStoreId: string
        kmsKeyId: string
        kmsKeyVersionId: string
        lifecycleDetails: string
        ncharacterSet: string
        oneOffPatches:
            - string
        pdbName: string
        pluggableDatabases:
            - string
        sidPrefix: string
        state: string
        tdeWalletPassword: string
        timeCreated: string
        timeStampForPointInTimeRecovery: string
        vaultId: string
    databaseSoftwareImageId: string
    dbSystemId: string
    dbVersion: string
    definedTags:
        string: string
    displayName: string
    enableDatabaseDelete: false
    freeformTags:
        string: string
    isDesupportedVersion: false
    isUnifiedAuditingEnabled: false
    kmsKeyId: string
    kmsKeyVersionId: string
    source: string
    vmClusterId: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The DbHome resource accepts the following input properties:
- Database
DbHome Database 
- (Updatable) Details for creating a database. - Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API. 
- DatabaseSoftware stringImage Id 
- The database software image OCID
- DbSystem stringId 
- 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. 
- Dictionary<string, string>
- (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.
- EnableDatabase boolDelete 
- Dictionary<string, string>
- (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"}
- IsDesupported boolVersion 
- If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI.
- IsUnified boolAuditing Enabled 
- Indicates whether unified autiding is enabled or not. Set to True to enable unified auditing on respective DBHome.
- KmsKey stringId 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- KmsKey stringVersion Id 
- 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.
- VmCluster stringId 
- 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 Database Args 
- (Updatable) Details for creating a database. - Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API. 
- DatabaseSoftware stringImage Id 
- The database software image OCID
- DbSystem stringId 
- 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. 
- map[string]string
- (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.
- EnableDatabase boolDelete 
- map[string]string
- (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"}
- IsDesupported boolVersion 
- If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI.
- IsUnified boolAuditing Enabled 
- Indicates whether unified autiding is enabled or not. Set to True to enable unified auditing on respective DBHome.
- KmsKey stringId 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- KmsKey stringVersion Id 
- 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.
- VmCluster stringId 
- 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. 
- databaseSoftware StringImage Id 
- The database software image OCID
- dbSystem StringId 
- 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. 
- Map<String,String>
- (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.
- enableDatabase BooleanDelete 
- Map<String,String>
- (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"}
- isDesupported BooleanVersion 
- If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI.
- isUnified BooleanAuditing Enabled 
- Indicates whether unified autiding is enabled or not. Set to True to enable unified auditing on respective DBHome.
- kmsKey StringId 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kmsKey StringVersion Id 
- 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.
- vmCluster StringId 
- 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 Database 
- (Updatable) Details for creating a database. - Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API. 
- databaseSoftware stringImage Id 
- The database software image OCID
- dbSystem stringId 
- 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. 
- {[key: string]: string}
- (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.
- enableDatabase booleanDelete 
- {[key: string]: string}
- (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"}
- isDesupported booleanVersion 
- If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI.
- isUnified booleanAuditing Enabled 
- Indicates whether unified autiding is enabled or not. Set to True to enable unified auditing on respective DBHome.
- kmsKey stringId 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kmsKey stringVersion Id 
- 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.
- vmCluster stringId 
- 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 Database Args 
- (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_ strimage_ id 
- The database software image OCID
- db_system_ strid 
- 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. 
- Mapping[str, str]
- (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_ booldelete 
- Mapping[str, str]
- (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_ boolversion 
- If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI.
- is_unified_ boolauditing_ enabled 
- Indicates whether unified autiding is enabled or not. Set to True to enable unified auditing on respective DBHome.
- kms_key_ strid 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms_key_ strversion_ id 
- 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_ strid 
- 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. 
- databaseSoftware StringImage Id 
- The database software image OCID
- dbSystem StringId 
- 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. 
- Map<String>
- (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.
- enableDatabase BooleanDelete 
- Map<String>
- (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"}
- isDesupported BooleanVersion 
- If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI.
- isUnified BooleanAuditing Enabled 
- Indicates whether unified autiding is enabled or not. Set to True to enable unified auditing on respective DBHome.
- kmsKey StringId 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kmsKey StringVersion Id 
- 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.
- vmCluster StringId 
- 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.
- DbHome stringLocation 
- The location of the Oracle Database Home.
- Id string
- The provider-assigned unique ID for this managed resource.
- LastPatch stringHistory Entry Id 
- 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.
- DbHome stringLocation 
- The location of the Oracle Database Home.
- Id string
- The provider-assigned unique ID for this managed resource.
- LastPatch stringHistory Entry Id 
- 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.
- dbHome StringLocation 
- The location of the Oracle Database Home.
- id String
- The provider-assigned unique ID for this managed resource.
- lastPatch StringHistory Entry Id 
- 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.
- dbHome stringLocation 
- The location of the Oracle Database Home.
- id string
- The provider-assigned unique ID for this managed resource.
- lastPatch stringHistory Entry Id 
- 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_ strlocation 
- The location of the Oracle Database Home.
- id str
- The provider-assigned unique ID for this managed resource.
- last_patch_ strhistory_ entry_ id 
- 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.
- dbHome StringLocation 
- The location of the Oracle Database Home.
- id String
- The provider-assigned unique ID for this managed resource.
- lastPatch StringHistory Entry Id 
- 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[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, str]] = None,
        display_name: Optional[str] = None,
        enable_database_delete: Optional[bool] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        is_desupported_version: Optional[bool] = None,
        is_unified_auditing_enabled: 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) -> DbHomefunc 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)resources:  _:    type: oci:Database:DbHome    get:      id: ${id}- 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.
- CompartmentId string
- The OCID of the compartment.
- Database
DbHome Database 
- (Updatable) Details for creating a database. - Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API. 
- DatabaseSoftware stringImage Id 
- The database software image OCID
- DbHome stringLocation 
- The location of the Oracle Database Home.
- DbSystem stringId 
- 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. 
- Dictionary<string, string>
- (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.
- EnableDatabase boolDelete 
- Dictionary<string, string>
- (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"}
- IsDesupported boolVersion 
- If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI.
- IsUnified boolAuditing Enabled 
- Indicates whether unified autiding is enabled or not. Set to True to enable unified auditing on respective DBHome.
- KmsKey stringId 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- KmsKey stringVersion Id 
- 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.
- LastPatch stringHistory Entry Id 
- 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.
- VmCluster stringId 
- 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 Database Args 
- (Updatable) Details for creating a database. - Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API. 
- DatabaseSoftware stringImage Id 
- The database software image OCID
- DbHome stringLocation 
- The location of the Oracle Database Home.
- DbSystem stringId 
- 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. 
- map[string]string
- (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.
- EnableDatabase boolDelete 
- map[string]string
- (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"}
- IsDesupported boolVersion 
- If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI.
- IsUnified boolAuditing Enabled 
- Indicates whether unified autiding is enabled or not. Set to True to enable unified auditing on respective DBHome.
- KmsKey stringId 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- KmsKey stringVersion Id 
- 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.
- LastPatch stringHistory Entry Id 
- 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.
- VmCluster stringId 
- 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. 
- databaseSoftware StringImage Id 
- The database software image OCID
- dbHome StringLocation 
- The location of the Oracle Database Home.
- dbSystem StringId 
- 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. 
- Map<String,String>
- (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.
- enableDatabase BooleanDelete 
- Map<String,String>
- (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"}
- isDesupported BooleanVersion 
- If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI.
- isUnified BooleanAuditing Enabled 
- Indicates whether unified autiding is enabled or not. Set to True to enable unified auditing on respective DBHome.
- kmsKey StringId 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kmsKey StringVersion Id 
- 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.
- lastPatch StringHistory Entry Id 
- 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.
- vmCluster StringId 
- 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 Database 
- (Updatable) Details for creating a database. - Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API. 
- databaseSoftware stringImage Id 
- The database software image OCID
- dbHome stringLocation 
- The location of the Oracle Database Home.
- dbSystem stringId 
- 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. 
- {[key: string]: string}
- (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.
- enableDatabase booleanDelete 
- {[key: string]: string}
- (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"}
- isDesupported booleanVersion 
- If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI.
- isUnified booleanAuditing Enabled 
- Indicates whether unified autiding is enabled or not. Set to True to enable unified auditing on respective DBHome.
- kmsKey stringId 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kmsKey stringVersion Id 
- 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.
- lastPatch stringHistory Entry Id 
- 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.
- vmCluster stringId 
- 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
DbHome Database Args 
- (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_ strimage_ id 
- The database software image OCID
- db_home_ strlocation 
- The location of the Oracle Database Home.
- db_system_ strid 
- 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. 
- Mapping[str, str]
- (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_ booldelete 
- Mapping[str, str]
- (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_ boolversion 
- If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI.
- is_unified_ boolauditing_ enabled 
- Indicates whether unified autiding is enabled or not. Set to True to enable unified auditing on respective DBHome.
- kms_key_ strid 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms_key_ strversion_ id 
- 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_ strhistory_ entry_ id 
- 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_ strid 
- 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. 
- databaseSoftware StringImage Id 
- The database software image OCID
- dbHome StringLocation 
- The location of the Oracle Database Home.
- dbSystem StringId 
- 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. 
- Map<String>
- (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.
- enableDatabase BooleanDelete 
- Map<String>
- (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"}
- isDesupported BooleanVersion 
- If true, the customer acknowledges that the specified Oracle Database software is an older release that is not currently supported by OCI.
- isUnified BooleanAuditing Enabled 
- Indicates whether unified autiding is enabled or not. Set to True to enable unified auditing on respective DBHome.
- kmsKey StringId 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kmsKey StringVersion Id 
- 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.
- lastPatch StringHistory Entry Id 
- 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.
- vmCluster StringId 
- 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.
- BackupTde stringPassword 
- 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<DbHome Database Connection String> 
- DatabaseId string
- The database OCID.
- DatabaseSoftware stringImage Id 
- The database software image OCID
- DbBackup DbConfig Home Database Db Backup Config 
- (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.
- DbUnique stringName 
- 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. 
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- EncryptionKey DbLocation Details Home Database Encryption Key Location Details 
- Types of providers supported for managing database encryption keys
- Dictionary<string, string>
- (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 Database Home.
- KeyStore stringId 
- The OCID of the key store of Oracle Vault.
- KmsKey stringId 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- KmsKey stringVersion Id 
- The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- 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.
- OneOff List<string>Patches 
- 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.
- PluggableDatabases List<string>
- The list of pluggable databases that needs to be restored into new database.
- SidPrefix string
- Specifies a prefix for the Oracle SIDof the database to be created.
- State string
- The current state of the Database Home.
- TdeWallet stringPassword 
- 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.
- TimeStamp stringFor Point In Time Recovery 
- 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. This parameter and secretIdare required for Customer Managed Keys.
- 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.
- BackupTde stringPassword 
- 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 []DbHome Database Connection String 
- DatabaseId string
- The database OCID.
- DatabaseSoftware stringImage Id 
- The database software image OCID
- DbBackup DbConfig Home Database Db Backup Config 
- (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.
- DbUnique stringName 
- 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. 
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- EncryptionKey DbLocation Details Home Database Encryption Key Location Details 
- Types of providers supported for managing database encryption keys
- map[string]string
- (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 Database Home.
- KeyStore stringId 
- The OCID of the key store of Oracle Vault.
- KmsKey stringId 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- KmsKey stringVersion Id 
- The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- 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.
- OneOff []stringPatches 
- 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.
- PluggableDatabases []string
- The list of pluggable databases that needs to be restored into new database.
- SidPrefix string
- Specifies a prefix for the Oracle SIDof the database to be created.
- State string
- The current state of the Database Home.
- TdeWallet stringPassword 
- 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.
- TimeStamp stringFor Point In Time Recovery 
- 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. This parameter and secretIdare required for Customer Managed Keys.
- 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.
- backupTde StringPassword 
- 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<DbHome Connection String> 
- databaseId String
- The database OCID.
- databaseSoftware StringImage Id 
- The database software image OCID
- dbBackup DbConfig Home Db Backup Config 
- (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.
- dbUnique StringName 
- 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. 
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- encryptionKey DbLocation Details Home Encryption Key Location Details 
- Types of providers supported for managing database encryption keys
- Map<String,String>
- (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 Database Home.
- keyStore StringId 
- The OCID of the key store of Oracle Vault.
- kmsKey StringId 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kmsKey StringVersion Id 
- The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- 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.
- oneOff List<String>Patches 
- 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.
- pluggableDatabases List<String>
- The list of pluggable databases that needs to be restored into new database.
- sidPrefix String
- Specifies a prefix for the Oracle SIDof the database to be created.
- state String
- The current state of the Database Home.
- tdeWallet StringPassword 
- 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.
- timeStamp StringFor Point In Time Recovery 
- 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. This parameter and secretIdare required for Customer Managed Keys.
- 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.
- backupTde stringPassword 
- 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 DbHome Database Connection String[] 
- databaseId string
- The database OCID.
- databaseSoftware stringImage Id 
- The database software image OCID
- dbBackup DbConfig Home Database Db Backup Config 
- (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.
- dbUnique stringName 
- 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. 
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- encryptionKey DbLocation Details Home Database Encryption Key Location Details 
- Types of providers supported for managing database encryption keys
- {[key: string]: string}
- (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 Database Home.
- keyStore stringId 
- The OCID of the key store of Oracle Vault.
- kmsKey stringId 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kmsKey stringVersion Id 
- The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- 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.
- oneOff string[]Patches 
- 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.
- pluggableDatabases string[]
- The list of pluggable databases that needs to be restored into new database.
- sidPrefix string
- Specifies a prefix for the Oracle SIDof the database to be created.
- state string
- The current state of the Database Home.
- tdeWallet stringPassword 
- 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.
- timeStamp stringFor Point In Time Recovery 
- 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. This parameter and secretIdare required for Customer Managed Keys.
- 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_ strpassword 
- 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 Sequence[DbHome Database Connection String] 
- database_id str
- The database OCID.
- database_software_ strimage_ id 
- The database software image OCID
- db_backup_ Dbconfig Home Database Db Backup Config 
- (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_ strname 
- 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. 
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- encryption_key_ Dblocation_ details Home Database Encryption Key Location Details 
- Types of providers supported for managing database encryption keys
- Mapping[str, str]
- (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 Database Home.
- key_store_ strid 
- The OCID of the key store of Oracle Vault.
- kms_key_ strid 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms_key_ strversion_ id 
- The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- 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_ Sequence[str]patches 
- 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.
- pluggable_databases Sequence[str]
- The list of pluggable databases that needs to be restored into new database.
- sid_prefix str
- Specifies a prefix for the Oracle SIDof the database to be created.
- state str
- The current state of the Database Home.
- tde_wallet_ strpassword 
- 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_ strfor_ point_ in_ time_ recovery 
- 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. This parameter and secretIdare required for Customer Managed Keys.
- 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.
- backupTde StringPassword 
- 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.
- databaseSoftware StringImage Id 
- The database software image OCID
- dbBackup Property MapConfig 
- (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.
- dbUnique StringName 
- 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. 
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- encryptionKey Property MapLocation Details 
- Types of providers supported for managing database encryption keys
- Map<String>
- (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 Database Home.
- keyStore StringId 
- The OCID of the key store of Oracle Vault.
- kmsKey StringId 
- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kmsKey StringVersion Id 
- The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- 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.
- oneOff List<String>Patches 
- 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.
- pluggableDatabases List<String>
- The list of pluggable databases that needs to be restored into new database.
- sidPrefix String
- Specifies a prefix for the Oracle SIDof the database to be created.
- state String
- The current state of the Database Home.
- tdeWallet StringPassword 
- 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.
- timeStamp StringFor Point In Time Recovery 
- 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. This parameter and secretIdare required for Customer Managed Keys.
DbHomeDatabaseConnectionString, DbHomeDatabaseConnectionStringArgs          
- AllConnection Dictionary<string, string>Strings 
- CdbDefault string
- CdbIp stringDefault 
- AllConnection map[string]stringStrings 
- CdbDefault string
- CdbIp stringDefault 
- allConnection Map<String,String>Strings 
- cdbDefault String
- cdbIp StringDefault 
- allConnection {[key: string]: string}Strings 
- cdbDefault string
- cdbIp stringDefault 
- all_connection_ Mapping[str, str]strings 
- cdb_default str
- cdb_ip_ strdefault 
- allConnection Map<String>Strings 
- cdbDefault String
- cdbIp StringDefault 
DbHomeDatabaseDbBackupConfig, DbHomeDatabaseDbBackupConfigArgs            
- AutoBackup boolEnabled 
- (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.
- AutoBackup stringWindow 
- (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
- AutoFull stringBackup Day 
- 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.
- AutoFull stringBackup Window 
- 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
- BackupDeletion stringPolicy 
- 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.
- BackupDestination List<DbDetails Home Database Db Backup Config Backup Destination Detail> 
- Backup destination details.
- RecoveryWindow intIn Days 
- (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.
- RunImmediate boolFull Backup 
- If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
- AutoBackup boolEnabled 
- (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.
- AutoBackup stringWindow 
- (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
- AutoFull stringBackup Day 
- 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.
- AutoFull stringBackup Window 
- 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
- BackupDeletion stringPolicy 
- 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.
- BackupDestination []DbDetails Home Database Db Backup Config Backup Destination Detail 
- Backup destination details.
- RecoveryWindow intIn Days 
- (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.
- RunImmediate boolFull Backup 
- If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
- autoBackup BooleanEnabled 
- (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.
- autoBackup StringWindow 
- (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
- autoFull StringBackup Day 
- 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.
- autoFull StringBackup Window 
- 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
- backupDeletion StringPolicy 
- 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.
- backupDestination List<DbDetails Home Db Backup Config Backup Destination Detail> 
- Backup destination details.
- recoveryWindow IntegerIn Days 
- (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.
- runImmediate BooleanFull Backup 
- If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
- autoBackup booleanEnabled 
- (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.
- autoBackup stringWindow 
- (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
- autoFull stringBackup Day 
- 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.
- autoFull stringBackup Window 
- 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
- backupDeletion stringPolicy 
- 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.
- backupDestination DbDetails Home Database Db Backup Config Backup Destination Detail[] 
- Backup destination details.
- recoveryWindow numberIn Days 
- (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.
- runImmediate booleanFull Backup 
- 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_ boolenabled 
- (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_ strwindow 
- (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_ strbackup_ day 
- 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_ strbackup_ window 
- 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_ strpolicy 
- 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_ Sequence[Dbdetails Home Database Db Backup Config Backup Destination Detail] 
- Backup destination details.
- recovery_window_ intin_ days 
- (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_ boolfull_ backup 
- If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
- autoBackup BooleanEnabled 
- (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.
- autoBackup StringWindow 
- (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
- autoFull StringBackup Day 
- 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.
- autoFull StringBackup Window 
- 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
- backupDeletion StringPolicy 
- 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.
- backupDestination List<Property Map>Details 
- Backup destination details.
- recoveryWindow NumberIn Days 
- (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.
- runImmediate BooleanFull Backup 
- 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                  
- DbrsPolicy stringId 
- 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.
- DbrsPolicy stringId 
- 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.
- dbrsPolicy StringId 
- 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.
- dbrsPolicy stringId 
- 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_ strid 
- 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.
- dbrsPolicy StringId 
- 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.
DbHomeDatabaseEncryptionKeyLocationDetails, DbHomeDatabaseEncryptionKeyLocationDetailsArgs              
- HsmPassword string
- Provide the HSM password as you would in RDBMS for External HSM.
- ProviderType string
- Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.
- HsmPassword string
- Provide the HSM password as you would in RDBMS for External HSM.
- ProviderType string
- Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.
- hsmPassword String
- Provide the HSM password as you would in RDBMS for External HSM.
- providerType String
- Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.
- hsmPassword string
- Provide the HSM password as you would in RDBMS for External HSM.
- providerType string
- Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.
- hsm_password str
- Provide the HSM password as you would in RDBMS for External HSM.
- provider_type str
- Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.
- hsmPassword String
- Provide the HSM password as you would in RDBMS for External HSM.
- providerType String
- Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.
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”.
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the ociTerraform Provider.