CreateDbHomeBase

class oci.database.models.CreateDbHomeBase(**kwargs)

Bases: object

Details for creating a Database Home.

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

Attributes

SOURCE_DATABASE A constant which can be used with the source property of a CreateDbHomeBase.
SOURCE_DB_BACKUP A constant which can be used with the source property of a CreateDbHomeBase.
SOURCE_NONE A constant which can be used with the source property of a CreateDbHomeBase.
SOURCE_VM_CLUSTER_BACKUP A constant which can be used with the source property of a CreateDbHomeBase.
SOURCE_VM_CLUSTER_NEW A constant which can be used with the source property of a CreateDbHomeBase.
database_software_image_id Gets the database_software_image_id of this CreateDbHomeBase.
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.
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.

Methods

__init__(**kwargs) Initializes a new CreateDbHomeBase 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'

A constant which can be used with the source property of a CreateDbHomeBase. This constant has a value of “DATABASE”

SOURCE_DB_BACKUP = 'DB_BACKUP'

A constant which can be used with the source property of a CreateDbHomeBase. This constant has a value of “DB_BACKUP”

SOURCE_NONE = 'NONE'

A constant which can be used with the source property of a CreateDbHomeBase. This constant has a value of “NONE”

SOURCE_VM_CLUSTER_BACKUP = 'VM_CLUSTER_BACKUP'

A constant which can be used with the source property of a CreateDbHomeBase. This constant has a value of “VM_CLUSTER_BACKUP”

SOURCE_VM_CLUSTER_NEW = 'VM_CLUSTER_NEW'

A constant which can be used with the source property of a CreateDbHomeBase. This constant has a value of “VM_CLUSTER_NEW”

__init__(**kwargs)

Initializes a new CreateDbHomeBase object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

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 CreateDbHomeBase.
  • kms_key_id (str) – The value to assign to the kms_key_id property of this CreateDbHomeBase.
  • kms_key_version_id (str) – The value to assign to the kms_key_version_id property of this CreateDbHomeBase.
  • database_software_image_id (str) – The value to assign to the database_software_image_id property of this CreateDbHomeBase.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateDbHomeBase.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateDbHomeBase.
  • source (str) – The value to assign to the source property of this CreateDbHomeBase. 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 CreateDbHomeBase.
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
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
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.

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