CloudDbSystem¶

class oci.database_management.models.CloudDbSystem(**kwargs)¶

Bases: object

The details of a cloud DB system.

Attributes

`DEPLOYMENT_TYPE_EXADATA`	A constant which can be used with the deployment_type property of a CloudDbSystem.
`DEPLOYMENT_TYPE_EXADATA_CC`	A constant which can be used with the deployment_type property of a CloudDbSystem.
`DEPLOYMENT_TYPE_EXADATA_XS`	A constant which can be used with the deployment_type property of a CloudDbSystem.
`DEPLOYMENT_TYPE_VM`	A constant which can be used with the deployment_type property of a CloudDbSystem.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a CloudDbSystem.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a CloudDbSystem.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a CloudDbSystem.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a CloudDbSystem.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a CloudDbSystem.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a CloudDbSystem.
`compartment_id`	[Required] Gets the compartment_id of this CloudDbSystem.
`database_management_config`	Gets the database_management_config of this CloudDbSystem.
`db_system_discovery_id`	Gets the db_system_discovery_id of this CloudDbSystem.
`dbaas_parent_infrastructure_id`	[Required] Gets the dbaas_parent_infrastructure_id of this CloudDbSystem.
`defined_tags`	Gets the defined_tags of this CloudDbSystem.
`deployment_type`	[Required] Gets the deployment_type of this CloudDbSystem.
`discovery_agent_id`	Gets the discovery_agent_id of this CloudDbSystem.
`display_name`	[Required] Gets the display_name of this CloudDbSystem.
`freeform_tags`	Gets the freeform_tags of this CloudDbSystem.
`home_directory`	Gets the home_directory of this CloudDbSystem.
`id`	[Required] Gets the id of this CloudDbSystem.
`is_cluster`	Gets the is_cluster of this CloudDbSystem.
`lifecycle_details`	Gets the lifecycle_details of this CloudDbSystem.
`lifecycle_state`	[Required] Gets the lifecycle_state of this CloudDbSystem.
`stack_monitoring_config`	Gets the stack_monitoring_config of this CloudDbSystem.
`system_tags`	Gets the system_tags of this CloudDbSystem.
`time_created`	[Required] Gets the time_created of this CloudDbSystem.
`time_updated`	[Required] Gets the time_updated of this CloudDbSystem.

Methods

__init__(**kwargs) Initializes a new CloudDbSystem object with values from keyword arguments.

DEPLOYMENT_TYPE_EXADATA = 'EXADATA'¶: A constant which can be used with the deployment_type property of a CloudDbSystem. 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 CloudDbSystem. 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 CloudDbSystem. This constant has a value of “EXADATA_XS”

DEPLOYMENT_TYPE_VM = 'VM'¶: A constant which can be used with the deployment_type property of a CloudDbSystem. This constant has a value of “VM”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a CloudDbSystem. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a CloudDbSystem. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a CloudDbSystem. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a CloudDbSystem. This constant has a value of “DELETING”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a CloudDbSystem. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a CloudDbSystem. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new CloudDbSystem 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 CloudDbSystem.
dbaas_parent_infrastructure_id (str) – The value to assign to the dbaas_parent_infrastructure_id property of this CloudDbSystem.
deployment_type (str) – The value to assign to the deployment_type property of this CloudDbSystem. Allowed values for this property are: “VM”, “EXADATA”, “EXADATA_CC”, “EXADATA_XS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
display_name (str) – The value to assign to the display_name property of this CloudDbSystem.
compartment_id (str) – The value to assign to the compartment_id property of this CloudDbSystem.
db_system_discovery_id (str) – The value to assign to the db_system_discovery_id property of this CloudDbSystem.
discovery_agent_id (str) – The value to assign to the discovery_agent_id property of this CloudDbSystem.
is_cluster (bool) – The value to assign to the is_cluster property of this CloudDbSystem.
home_directory (str) – The value to assign to the home_directory property of this CloudDbSystem.
database_management_config (oci.database_management.models.CloudDbSystemDatabaseManagementConfigDetails) – The value to assign to the database_management_config property of this CloudDbSystem.
stack_monitoring_config (oci.database_management.models.CloudDbSystemStackMonitoringConfigDetails) – The value to assign to the stack_monitoring_config property of this CloudDbSystem.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this CloudDbSystem. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this CloudDbSystem.
time_created (datetime) – The value to assign to the time_created property of this CloudDbSystem.
time_updated (datetime) – The value to assign to the time_updated property of this CloudDbSystem.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CloudDbSystem.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CloudDbSystem.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this CloudDbSystem.

compartment_id¶

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

Returns:	The compartment_id of this CloudDbSystem.
Return type:	str

database_management_config¶

Gets the database_management_config of this CloudDbSystem.

Returns:	The database_management_config of this CloudDbSystem.
Return type:	oci.database_management.models.CloudDbSystemDatabaseManagementConfigDetails

db_system_discovery_id¶

Gets the db_system_discovery_id of this CloudDbSystem. The OCID of the DB system discovery.

Returns:	The db_system_discovery_id of this CloudDbSystem.
Return type:	str

dbaas_parent_infrastructure_id¶

[Required] Gets the dbaas_parent_infrastructure_id of this CloudDbSystem. The OCID of the parent cloud DB Infrastructure. For VM Dbsystems , it will be the DBSystem Id. For ExaCS and ExaCC, it will be the cloudVmClusterId and vmClusterId respectively.

Returns:	The dbaas_parent_infrastructure_id of this CloudDbSystem.
Return type:	str

defined_tags¶

Gets the defined_tags of this CloudDbSystem. 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 CloudDbSystem.
Return type:	dict(str, dict(str, object))

deployment_type¶

[Required] Gets the deployment_type of this CloudDbSystem. The deployment type of cloud dbsystem.

Allowed values for this property are: “VM”, “EXADATA”, “EXADATA_CC”, “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 CloudDbSystem.
Return type:	str

discovery_agent_id¶

Gets the discovery_agent_id of this CloudDbSystem. The OCID of the management agent used during the discovery of the DB system.

Returns:	The discovery_agent_id of this CloudDbSystem.
Return type:	str

display_name¶

[Required] Gets the display_name of this CloudDbSystem. The user-friendly name for the DB system. The name does not have to be unique.

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

freeform_tags¶

Gets the freeform_tags of this CloudDbSystem. 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 CloudDbSystem.
Return type:	dict(str, str)

home_directory¶

Gets the home_directory of this CloudDbSystem. The Oracle Grid home directory in case of cluster-based DB system and Oracle home directory in case of single instance-based DB system.

Returns:	The home_directory of this CloudDbSystem.
Return type:	str

id¶

[Required] Gets the id of this CloudDbSystem. The OCID of the cloud DB system.

Returns:	The id of this CloudDbSystem.
Return type:	str

is_cluster¶

Gets the is_cluster of this CloudDbSystem. Indicates whether the DB system is a cluster DB system or not.

Returns:	The is_cluster of this CloudDbSystem.
Return type:	bool

lifecycle_details¶

Gets the lifecycle_details of this CloudDbSystem. Additional information about the current lifecycle state.

Returns:	The lifecycle_details of this CloudDbSystem.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this CloudDbSystem. The current lifecycle state of the cloud DB system resource.

Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this CloudDbSystem.
Return type:	str

stack_monitoring_config¶

Gets the stack_monitoring_config of this CloudDbSystem.

Returns:	The stack_monitoring_config of this CloudDbSystem.
Return type:	oci.database_management.models.CloudDbSystemStackMonitoringConfigDetails

system_tags¶

Gets the system_tags of this CloudDbSystem. 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 CloudDbSystem.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this CloudDbSystem. The date and time the cloud DB system was created.

Returns:	The time_created of this CloudDbSystem.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this CloudDbSystem. The date and time the cloud DB system was last updated.

Returns:	The time_updated of this CloudDbSystem.
Return type:	datetime