ManagedDatabase

class oci.database_management.models.ManagedDatabase(**kwargs)

Bases: object

The details of a Managed Database.

Attributes:

DATABASE_STATUS_DOWN

A constant which can be used with the database_status property of a ManagedDatabase.

DATABASE_STATUS_UNKNOWN

A constant which can be used with the database_status property of a ManagedDatabase.

DATABASE_STATUS_UP

A constant which can be used with the database_status property of a ManagedDatabase.

DATABASE_SUB_TYPE_ACD

A constant which can be used with the database_sub_type property of a ManagedDatabase.

DATABASE_SUB_TYPE_ADB

A constant which can be used with the database_sub_type property of a ManagedDatabase.

DATABASE_SUB_TYPE_CDB

A constant which can be used with the database_sub_type property of a ManagedDatabase.

DATABASE_SUB_TYPE_NON_CDB

A constant which can be used with the database_sub_type property of a ManagedDatabase.

DATABASE_SUB_TYPE_PDB

A constant which can be used with the database_sub_type property of a ManagedDatabase.

DATABASE_TYPE_CLOUD_AT_CUSTOMER

A constant which can be used with the database_type property of a ManagedDatabase.

DATABASE_TYPE_CLOUD_RAC

A constant which can be used with the database_type property of a ManagedDatabase.

DATABASE_TYPE_CLOUD_SIDB

A constant which can be used with the database_type property of a ManagedDatabase.

DATABASE_TYPE_DEDICATED

A constant which can be used with the database_type property of a ManagedDatabase.

DATABASE_TYPE_EXTERNAL_RAC

A constant which can be used with the database_type property of a ManagedDatabase.

DATABASE_TYPE_EXTERNAL_SIDB

A constant which can be used with the database_type property of a ManagedDatabase.

DATABASE_TYPE_SHARED

A constant which can be used with the database_type property of a ManagedDatabase.

DEPLOYMENT_TYPE_AUTONOMOUS

A constant which can be used with the deployment_type property of a ManagedDatabase.

DEPLOYMENT_TYPE_BM

A constant which can be used with the deployment_type property of a ManagedDatabase.

DEPLOYMENT_TYPE_EXADATA

A constant which can be used with the deployment_type property of a ManagedDatabase.

DEPLOYMENT_TYPE_EXADATA_CC

A constant which can be used with the deployment_type property of a ManagedDatabase.

DEPLOYMENT_TYPE_EXADATA_XS

A constant which can be used with the deployment_type property of a ManagedDatabase.

DEPLOYMENT_TYPE_ONPREMISE

A constant which can be used with the deployment_type property of a ManagedDatabase.

DEPLOYMENT_TYPE_VM

A constant which can be used with the deployment_type property of a ManagedDatabase.

MANAGEMENT_OPTION_ADVANCED

A constant which can be used with the management_option property of a ManagedDatabase.

MANAGEMENT_OPTION_BASIC

A constant which can be used with the management_option property of a ManagedDatabase.

WORKLOAD_TYPE_AJD

A constant which can be used with the workload_type property of a ManagedDatabase.

WORKLOAD_TYPE_APEX

A constant which can be used with the workload_type property of a ManagedDatabase.

WORKLOAD_TYPE_DW

A constant which can be used with the workload_type property of a ManagedDatabase.

WORKLOAD_TYPE_OLTP

A constant which can be used with the workload_type property of a ManagedDatabase.

additional_details

Gets the additional_details of this ManagedDatabase.

compartment_id

[Required] Gets the compartment_id of this ManagedDatabase.

database_platform_name

Gets the database_platform_name of this ManagedDatabase.

database_status

Gets the database_status of this ManagedDatabase.

database_sub_type

[Required] Gets the database_sub_type of this ManagedDatabase.

database_type

[Required] Gets the database_type of this ManagedDatabase.

database_version

Gets the database_version of this ManagedDatabase.

db_system_id

Gets the db_system_id of this ManagedDatabase.

dbmgmt_feature_configs

Gets the dbmgmt_feature_configs of this ManagedDatabase.

defined_tags

Gets the defined_tags of this ManagedDatabase.

deployment_type

Gets the deployment_type of this ManagedDatabase.

freeform_tags

Gets the freeform_tags of this ManagedDatabase.

id

[Required] Gets the id of this ManagedDatabase.

instance_count

Gets the instance_count of this ManagedDatabase.

instance_details

Gets the instance_details of this ManagedDatabase.

is_cluster

[Required] Gets the is_cluster of this ManagedDatabase.

managed_database_groups

Gets the managed_database_groups of this ManagedDatabase.

management_option

Gets the management_option of this ManagedDatabase.

name

[Required] Gets the name of this ManagedDatabase.

parent_container_compartment_id

Gets the parent_container_compartment_id of this ManagedDatabase.

parent_container_id

Gets the parent_container_id of this ManagedDatabase.

parent_container_name

Gets the parent_container_name of this ManagedDatabase.

pdb_count

Gets the pdb_count of this ManagedDatabase.

pdb_status

Gets the pdb_status of this ManagedDatabase.

storage_system_id

Gets the storage_system_id of this ManagedDatabase.

system_tags

Gets the system_tags of this ManagedDatabase.

time_created

[Required] Gets the time_created of this ManagedDatabase.

workload_type

Gets the workload_type of this ManagedDatabase.

Methods:

__init__(**kwargs)

Initializes a new ManagedDatabase object with values from keyword arguments.

DATABASE_STATUS_DOWN = 'DOWN'

A constant which can be used with the database_status property of a ManagedDatabase. This constant has a value of “DOWN”

DATABASE_STATUS_UNKNOWN = 'UNKNOWN'

A constant which can be used with the database_status property of a ManagedDatabase. This constant has a value of “UNKNOWN”

DATABASE_STATUS_UP = 'UP'

A constant which can be used with the database_status property of a ManagedDatabase. This constant has a value of “UP”

DATABASE_SUB_TYPE_ACD = 'ACD'

A constant which can be used with the database_sub_type property of a ManagedDatabase. This constant has a value of “ACD”

DATABASE_SUB_TYPE_ADB = 'ADB'

A constant which can be used with the database_sub_type property of a ManagedDatabase. This constant has a value of “ADB”

DATABASE_SUB_TYPE_CDB = 'CDB'

A constant which can be used with the database_sub_type property of a ManagedDatabase. This constant has a value of “CDB”

DATABASE_SUB_TYPE_NON_CDB = 'NON_CDB'

A constant which can be used with the database_sub_type property of a ManagedDatabase. This constant has a value of “NON_CDB”

DATABASE_SUB_TYPE_PDB = 'PDB'

A constant which can be used with the database_sub_type property of a ManagedDatabase. This constant has a value of “PDB”

DATABASE_TYPE_CLOUD_AT_CUSTOMER = 'CLOUD_AT_CUSTOMER'

A constant which can be used with the database_type property of a ManagedDatabase. This constant has a value of “CLOUD_AT_CUSTOMER”

DATABASE_TYPE_CLOUD_RAC = 'CLOUD_RAC'

A constant which can be used with the database_type property of a ManagedDatabase. This constant has a value of “CLOUD_RAC”

DATABASE_TYPE_CLOUD_SIDB = 'CLOUD_SIDB'

A constant which can be used with the database_type property of a ManagedDatabase. This constant has a value of “CLOUD_SIDB”

DATABASE_TYPE_DEDICATED = 'DEDICATED'

A constant which can be used with the database_type property of a ManagedDatabase. This constant has a value of “DEDICATED”

DATABASE_TYPE_EXTERNAL_RAC = 'EXTERNAL_RAC'

A constant which can be used with the database_type property of a ManagedDatabase. This constant has a value of “EXTERNAL_RAC”

DATABASE_TYPE_EXTERNAL_SIDB = 'EXTERNAL_SIDB'

A constant which can be used with the database_type property of a ManagedDatabase. This constant has a value of “EXTERNAL_SIDB”

DATABASE_TYPE_SHARED = 'SHARED'

A constant which can be used with the database_type property of a ManagedDatabase. This constant has a value of “SHARED”

DEPLOYMENT_TYPE_AUTONOMOUS = 'AUTONOMOUS'

A constant which can be used with the deployment_type property of a ManagedDatabase. This constant has a value of “AUTONOMOUS”

DEPLOYMENT_TYPE_BM = 'BM'

A constant which can be used with the deployment_type property of a ManagedDatabase. This constant has a value of “BM”

DEPLOYMENT_TYPE_EXADATA = 'EXADATA'

A constant which can be used with the deployment_type property of a ManagedDatabase. This constant has a value of “EXADATA”

DEPLOYMENT_TYPE_EXADATA_CC = 'EXADATA_CC'

A constant which can be used with the deployment_type property of a ManagedDatabase. This constant has a value of “EXADATA_CC”

DEPLOYMENT_TYPE_EXADATA_XS = 'EXADATA_XS'

A constant which can be used with the deployment_type property of a ManagedDatabase. This constant has a value of “EXADATA_XS”

DEPLOYMENT_TYPE_ONPREMISE = 'ONPREMISE'

A constant which can be used with the deployment_type property of a ManagedDatabase. This constant has a value of “ONPREMISE”

DEPLOYMENT_TYPE_VM = 'VM'

A constant which can be used with the deployment_type property of a ManagedDatabase. This constant has a value of “VM”

MANAGEMENT_OPTION_ADVANCED = 'ADVANCED'

A constant which can be used with the management_option property of a ManagedDatabase. This constant has a value of “ADVANCED”

MANAGEMENT_OPTION_BASIC = 'BASIC'

A constant which can be used with the management_option property of a ManagedDatabase. This constant has a value of “BASIC”

WORKLOAD_TYPE_AJD = 'AJD'

A constant which can be used with the workload_type property of a ManagedDatabase. This constant has a value of “AJD”

WORKLOAD_TYPE_APEX = 'APEX'

A constant which can be used with the workload_type property of a ManagedDatabase. This constant has a value of “APEX”

WORKLOAD_TYPE_DW = 'DW'

A constant which can be used with the workload_type property of a ManagedDatabase. This constant has a value of “DW”

WORKLOAD_TYPE_OLTP = 'OLTP'

A constant which can be used with the workload_type property of a ManagedDatabase. This constant has a value of “OLTP”

__init__(**kwargs)

Initializes a new ManagedDatabase object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • id (str) – The value to assign to the id property of this ManagedDatabase.

  • compartment_id (str) – The value to assign to the compartment_id property of this ManagedDatabase.

  • name (str) – The value to assign to the name property of this ManagedDatabase.

  • database_type (str) – The value to assign to the database_type property of this ManagedDatabase. Allowed values for this property are: “EXTERNAL_SIDB”, “EXTERNAL_RAC”, “CLOUD_SIDB”, “CLOUD_RAC”, “SHARED”, “DEDICATED”, “CLOUD_AT_CUSTOMER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • database_sub_type (str) – The value to assign to the database_sub_type property of this ManagedDatabase. Allowed values for this property are: “CDB”, “PDB”, “NON_CDB”, “ACD”, “ADB”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • deployment_type (str) – The value to assign to the deployment_type property of this ManagedDatabase. Allowed values for this property are: “ONPREMISE”, “BM”, “VM”, “EXADATA”, “EXADATA_CC”, “AUTONOMOUS”, “EXADATA_XS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • management_option (str) – The value to assign to the management_option property of this ManagedDatabase. Allowed values for this property are: “BASIC”, “ADVANCED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • workload_type (str) – The value to assign to the workload_type property of this ManagedDatabase. Allowed values for this property are: “OLTP”, “DW”, “AJD”, “APEX”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • is_cluster (bool) – The value to assign to the is_cluster property of this ManagedDatabase.

  • parent_container_id (str) – The value to assign to the parent_container_id property of this ManagedDatabase.

  • managed_database_groups (list[oci.database_management.models.ParentGroup]) – The value to assign to the managed_database_groups property of this ManagedDatabase.

  • db_system_id (str) – The value to assign to the db_system_id property of this ManagedDatabase.

  • storage_system_id (str) – The value to assign to the storage_system_id property of this ManagedDatabase.

  • time_created (datetime) – The value to assign to the time_created property of this ManagedDatabase.

  • database_version (str) – The value to assign to the database_version property of this ManagedDatabase.

  • database_status (str) – The value to assign to the database_status property of this ManagedDatabase. Allowed values for this property are: “UP”, “DOWN”, “UNKNOWN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • parent_container_name (str) – The value to assign to the parent_container_name property of this ManagedDatabase.

  • parent_container_compartment_id (str) – The value to assign to the parent_container_compartment_id property of this ManagedDatabase.

  • instance_count (int) – The value to assign to the instance_count property of this ManagedDatabase.

  • instance_details (list[oci.database_management.models.InstanceDetails]) – The value to assign to the instance_details property of this ManagedDatabase.

  • pdb_count (int) – The value to assign to the pdb_count property of this ManagedDatabase.

  • pdb_status (list[oci.database_management.models.PdbStatusDetails]) – The value to assign to the pdb_status property of this ManagedDatabase.

  • additional_details (dict(str, str)) – The value to assign to the additional_details property of this ManagedDatabase.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ManagedDatabase.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ManagedDatabase.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ManagedDatabase.

  • dbmgmt_feature_configs (list[oci.database_management.models.DatabaseFeatureConfiguration]) – The value to assign to the dbmgmt_feature_configs property of this ManagedDatabase.

  • database_platform_name (str) – The value to assign to the database_platform_name property of this ManagedDatabase.

property additional_details

Gets the additional_details of this ManagedDatabase. The additional details specific to a type of database defined in {“key”: “value”} format. Example: {“bar-key”: “value”}

Returns

The additional_details of this ManagedDatabase.

Return type

dict(str, str)

property compartment_id

[Required] Gets the compartment_id of this ManagedDatabase. The OCID of the compartment.

Returns

The compartment_id of this ManagedDatabase.

Return type

str

property database_platform_name

Gets the database_platform_name of this ManagedDatabase. The operating system of database.

Returns

The database_platform_name of this ManagedDatabase.

Return type

str

property database_status

Gets the database_status of this ManagedDatabase. The status of the Oracle Database. Indicates whether the status of the database is UP, DOWN, or UNKNOWN at the current time.

Allowed values for this property are: “UP”, “DOWN”, “UNKNOWN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The database_status of this ManagedDatabase.

Return type

str

property database_sub_type

[Required] Gets the database_sub_type of this ManagedDatabase. The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.

Allowed values for this property are: “CDB”, “PDB”, “NON_CDB”, “ACD”, “ADB”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The database_sub_type of this ManagedDatabase.

Return type

str

property database_type

[Required] Gets the database_type of this ManagedDatabase. The type of Oracle Database installation.

Allowed values for this property are: “EXTERNAL_SIDB”, “EXTERNAL_RAC”, “CLOUD_SIDB”, “CLOUD_RAC”, “SHARED”, “DEDICATED”, “CLOUD_AT_CUSTOMER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The database_type of this ManagedDatabase.

Return type

str

property database_version

Gets the database_version of this ManagedDatabase. The Oracle Database version.

Returns

The database_version of this ManagedDatabase.

Return type

str

property db_system_id

Gets the db_system_id of this ManagedDatabase. The OCID of the DB system that this Managed Database is part of.

Returns

The db_system_id of this ManagedDatabase.

Return type

str

property dbmgmt_feature_configs

Gets the dbmgmt_feature_configs of this ManagedDatabase. The list of feature configurations

Returns

The dbmgmt_feature_configs of this ManagedDatabase.

Return type

list[oci.database_management.models.DatabaseFeatureConfiguration]

property defined_tags

Gets the defined_tags of this ManagedDatabase. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this ManagedDatabase.

Return type

dict(str, dict(str, object))

property deployment_type

Gets the deployment_type of this ManagedDatabase. The infrastructure used to deploy the Oracle Database.

Allowed values for this property are: “ONPREMISE”, “BM”, “VM”, “EXADATA”, “EXADATA_CC”, “AUTONOMOUS”, “EXADATA_XS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The deployment_type of this ManagedDatabase.

Return type

str

property freeform_tags

Gets the freeform_tags of this ManagedDatabase. 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 ManagedDatabase.

Return type

dict(str, str)

property id

[Required] Gets the id of this ManagedDatabase. The OCID of the Managed Database.

Returns

The id of this ManagedDatabase.

Return type

str

property instance_count

Gets the instance_count of this ManagedDatabase. The number of Oracle Real Application Clusters (Oracle RAC) database instances.

Returns

The instance_count of this ManagedDatabase.

Return type

int

property instance_details

Gets the instance_details of this ManagedDatabase. The details of the Oracle Real Application Clusters (Oracle RAC) database instances.

Returns

The instance_details of this ManagedDatabase.

Return type

list[oci.database_management.models.InstanceDetails]

property is_cluster

[Required] Gets the is_cluster of this ManagedDatabase. Indicates whether the Oracle Database is part of a cluster.

Returns

The is_cluster of this ManagedDatabase.

Return type

bool

property managed_database_groups

Gets the managed_database_groups of this ManagedDatabase. A list of Managed Database Groups that the Managed Database belongs to.

Returns

The managed_database_groups of this ManagedDatabase.

Return type

list[oci.database_management.models.ParentGroup]

property management_option

Gets the management_option of this ManagedDatabase. The management option used when enabling Database Management.

Allowed values for this property are: “BASIC”, “ADVANCED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The management_option of this ManagedDatabase.

Return type

str

property name

[Required] Gets the name of this ManagedDatabase. The name of the Managed Database.

Returns

The name of this ManagedDatabase.

Return type

str

property parent_container_compartment_id

Gets the parent_container_compartment_id of this ManagedDatabase. The OCID of the compartment in which the parent Container Database resides, if the Managed Database is a Pluggable Database (PDB).

Returns

The parent_container_compartment_id of this ManagedDatabase.

Return type

str

property parent_container_id

Gets the parent_container_id of this ManagedDatabase. The OCID of the parent Container Database if Managed Database is a Pluggable Database.

Returns

The parent_container_id of this ManagedDatabase.

Return type

str

property parent_container_name

Gets the parent_container_name of this ManagedDatabase. The name of the parent Container Database.

Returns

The parent_container_name of this ManagedDatabase.

Return type

str

property pdb_count

Gets the pdb_count of this ManagedDatabase. The number of PDBs in the Container Database.

Returns

The pdb_count of this ManagedDatabase.

Return type

int

property pdb_status

Gets the pdb_status of this ManagedDatabase. The status of the PDB in the Container Database.

Returns

The pdb_status of this ManagedDatabase.

Return type

list[oci.database_management.models.PdbStatusDetails]

property storage_system_id

Gets the storage_system_id of this ManagedDatabase. The OCID of the storage DB system.

Returns

The storage_system_id of this ManagedDatabase.

Return type

str

property system_tags

Gets the system_tags of this ManagedDatabase. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this ManagedDatabase.

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this ManagedDatabase. The date and time the Managed Database was created.

Returns

The time_created of this ManagedDatabase.

Return type

datetime

property workload_type

Gets the workload_type of this ManagedDatabase. The workload type of the Autonomous Database.

Allowed values for this property are: “OLTP”, “DW”, “AJD”, “APEX”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The workload_type of this ManagedDatabase.

Return type

str