CreateDbHomeWithVmClusterIdDetails¶

class oci.database.models.CreateDbHomeWithVmClusterIdDetails(**kwargs)¶

Bases: oci.database.models.create_db_home_base.CreateDbHomeBase

Note that a valid vmClusterId value must be supplied for the CreateDbHomeWithVmClusterId API operation to successfully complete.

Attributes

`SOURCE_DATABASE`	str(object=’’) -> str
`SOURCE_DB_BACKUP`	str(object=’’) -> str
`SOURCE_NONE`	str(object=’’) -> str
`SOURCE_VM_CLUSTER_BACKUP`	str(object=’’) -> str
`SOURCE_VM_CLUSTER_NEW`	str(object=’’) -> str
`database`	Gets the database of this CreateDbHomeWithVmClusterIdDetails.
`database_software_image_id`	Gets the database_software_image_id of this CreateDbHomeBase.
`db_version`	Gets the db_version of this CreateDbHomeWithVmClusterIdDetails.
`defined_tags`	Gets the defined_tags of this CreateDbHomeBase.
`display_name`	Gets the display_name of this CreateDbHomeBase.
`freeform_tags`	Gets the freeform_tags of this CreateDbHomeBase.
`is_desupported_version`	Gets the is_desupported_version of this CreateDbHomeBase.
`is_unified_auditing_enabled`	Gets the is_unified_auditing_enabled of this CreateDbHomeBase.
`kms_key_id`	Gets the kms_key_id of this CreateDbHomeBase.
`kms_key_version_id`	Gets the kms_key_version_id of this CreateDbHomeBase.
`source`	Gets the source of this CreateDbHomeBase.
`vm_cluster_id`	[Required] Gets the vm_cluster_id of this CreateDbHomeWithVmClusterIdDetails.

Methods

`__init__`(**kwargs)	Initializes a new CreateDbHomeWithVmClusterIdDetails object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

SOURCE_DATABASE = 'DATABASE'¶

SOURCE_DB_BACKUP = 'DB_BACKUP'¶

SOURCE_NONE = 'NONE'¶

SOURCE_VM_CLUSTER_BACKUP = 'VM_CLUSTER_BACKUP'¶

SOURCE_VM_CLUSTER_NEW = 'VM_CLUSTER_NEW'¶

__init__(**kwargs)¶

Initializes a new CreateDbHomeWithVmClusterIdDetails object with values from keyword arguments. The default value of the source attribute of this class is VM_CLUSTER_NEW and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

display_name (str) – The value to assign to the display_name property of this CreateDbHomeWithVmClusterIdDetails.
kms_key_id (str) – The value to assign to the kms_key_id property of this CreateDbHomeWithVmClusterIdDetails.
kms_key_version_id (str) – The value to assign to the kms_key_version_id property of this CreateDbHomeWithVmClusterIdDetails.
database_software_image_id (str) – The value to assign to the database_software_image_id property of this CreateDbHomeWithVmClusterIdDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateDbHomeWithVmClusterIdDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateDbHomeWithVmClusterIdDetails.
source (str) – The value to assign to the source property of this CreateDbHomeWithVmClusterIdDetails. Allowed values for this property are: “NONE”, “DB_BACKUP”, “DATABASE”, “VM_CLUSTER_BACKUP”, “VM_CLUSTER_NEW”
is_desupported_version (bool) – The value to assign to the is_desupported_version property of this CreateDbHomeWithVmClusterIdDetails.
is_unified_auditing_enabled (bool) – The value to assign to the is_unified_auditing_enabled property of this CreateDbHomeWithVmClusterIdDetails.
vm_cluster_id (str) – The value to assign to the vm_cluster_id property of this CreateDbHomeWithVmClusterIdDetails.
db_version (str) – The value to assign to the db_version property of this CreateDbHomeWithVmClusterIdDetails.
database (oci.database.models.CreateDatabaseDetails) – The value to assign to the database property of this CreateDbHomeWithVmClusterIdDetails.

database¶

Gets the database of this CreateDbHomeWithVmClusterIdDetails.

Returns:	The database of this CreateDbHomeWithVmClusterIdDetails.
Return type:	oci.database.models.CreateDatabaseDetails

database_software_image_id¶

Gets the database_software_image_id of this CreateDbHomeBase. The database software image OCID

Returns:	The database_software_image_id of this CreateDbHomeBase.
Return type:	str

db_version¶

Gets the db_version of this CreateDbHomeWithVmClusterIdDetails. 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.

Returns:	The db_version of this CreateDbHomeWithVmClusterIdDetails.
Return type:	str

defined_tags¶

Gets the defined_tags of this CreateDbHomeBase. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Returns:	The defined_tags of this CreateDbHomeBase.
Return type:	dict(str, dict(str, object))

display_name¶

Gets the display_name of this CreateDbHomeBase. The user-provided name of the Database Home.

Returns:	The display_name of this CreateDbHomeBase.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this CreateDbHomeBase. 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”}

Returns:	The freeform_tags of this CreateDbHomeBase.
Return type:	dict(str, str)

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

is_desupported_version¶

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

Returns:	The is_desupported_version of this CreateDbHomeBase.
Return type:	bool

is_unified_auditing_enabled¶

Gets the is_unified_auditing_enabled of this CreateDbHomeBase. Indicates whether unified autiding is enabled or not. Set to True to enable unified auditing on respective DBHome.

Returns:	The is_unified_auditing_enabled of this CreateDbHomeBase.
Return type:	bool

kms_key_id¶

Gets the kms_key_id of this CreateDbHomeBase. The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

Returns:	The kms_key_id of this CreateDbHomeBase.
Return type:	str

kms_key_version_id¶

Gets the kms_key_version_id of this CreateDbHomeBase. 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.

Returns:	The kms_key_version_id of this CreateDbHomeBase.
Return type:	str

source¶

Gets the source of this CreateDbHomeBase. The source of database: NONE for creating a new database. DB_BACKUP for creating a new database by restoring from a database backup.

Allowed values for this property are: “NONE”, “DB_BACKUP”, “DATABASE”, “VM_CLUSTER_BACKUP”, “VM_CLUSTER_NEW”

Returns:	The source of this CreateDbHomeBase.
Return type:	str

vm_cluster_id¶

[Required] Gets the vm_cluster_id of this CreateDbHomeWithVmClusterIdDetails. The OCID of the VM cluster.

Returns:	The vm_cluster_id of this CreateDbHomeWithVmClusterIdDetails.
Return type:	str