DbSystemSummary

class oci.mysql.models.DbSystemSummary(**kwargs)

Bases: object

A summary of a DB System.

Methods

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

Attributes

analytics_cluster Gets the analytics_cluster of this DbSystemSummary.
availability_domain Gets the availability_domain of this DbSystemSummary.
compartment_id Gets the compartment_id of this DbSystemSummary.
current_placement Gets the current_placement of this DbSystemSummary.
defined_tags Gets the defined_tags of this DbSystemSummary.
description Gets the description of this DbSystemSummary.
display_name [Required] Gets the display_name of this DbSystemSummary.
endpoints Gets the endpoints of this DbSystemSummary.
fault_domain Gets the fault_domain of this DbSystemSummary.
freeform_tags Gets the freeform_tags of this DbSystemSummary.
heat_wave_cluster Gets the heat_wave_cluster of this DbSystemSummary.
id [Required] Gets the id of this DbSystemSummary.
is_analytics_cluster_attached Gets the is_analytics_cluster_attached of this DbSystemSummary.
is_heat_wave_cluster_attached Gets the is_heat_wave_cluster_attached of this DbSystemSummary.
is_highly_available Gets the is_highly_available of this DbSystemSummary.
lifecycle_state [Required] Gets the lifecycle_state of this DbSystemSummary.
mysql_version [Required] Gets the mysql_version of this DbSystemSummary.
time_created [Required] Gets the time_created of this DbSystemSummary.
time_updated [Required] Gets the time_updated of this DbSystemSummary.
__init__(**kwargs)

Initializes a new DbSystemSummary 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 DbSystemSummary.
  • display_name (str) – The value to assign to the display_name property of this DbSystemSummary.
  • description (str) – The value to assign to the description property of this DbSystemSummary.
  • compartment_id (str) – The value to assign to the compartment_id property of this DbSystemSummary.
  • is_highly_available (bool) – The value to assign to the is_highly_available property of this DbSystemSummary.
  • current_placement (oci.mysql.models.DbSystemPlacement) – The value to assign to the current_placement property of this DbSystemSummary.
  • is_analytics_cluster_attached (bool) – The value to assign to the is_analytics_cluster_attached property of this DbSystemSummary.
  • analytics_cluster (oci.mysql.models.AnalyticsClusterSummary) – The value to assign to the analytics_cluster property of this DbSystemSummary.
  • is_heat_wave_cluster_attached (bool) – The value to assign to the is_heat_wave_cluster_attached property of this DbSystemSummary.
  • heat_wave_cluster (oci.mysql.models.HeatWaveClusterSummary) – The value to assign to the heat_wave_cluster property of this DbSystemSummary.
  • availability_domain (str) – The value to assign to the availability_domain property of this DbSystemSummary.
  • fault_domain (str) – The value to assign to the fault_domain property of this DbSystemSummary.
  • endpoints (list[oci.mysql.models.DbSystemEndpoint]) – The value to assign to the endpoints property of this DbSystemSummary.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this DbSystemSummary.
  • mysql_version (str) – The value to assign to the mysql_version property of this DbSystemSummary.
  • time_created (datetime) – The value to assign to the time_created property of this DbSystemSummary.
  • time_updated (datetime) – The value to assign to the time_updated property of this DbSystemSummary.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DbSystemSummary.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DbSystemSummary.
analytics_cluster

Gets the analytics_cluster of this DbSystemSummary.

Returns:The analytics_cluster of this DbSystemSummary.
Return type:oci.mysql.models.AnalyticsClusterSummary
availability_domain

Gets the availability_domain of this DbSystemSummary. The availability domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance.

In a failover scenario, the Read/Write endpoint is redirected to one of the other availability domains and the MySQL instance in that domain is promoted to the primary instance. This redirection does not affect the IP address of the DB System in any way.

For a standalone DB System, this defines the availability domain in which the DB System is placed.

Returns:The availability_domain of this DbSystemSummary.
Return type:str
compartment_id

Gets the compartment_id of this DbSystemSummary. The OCID of the compartment the DB System belongs in.

Returns:The compartment_id of this DbSystemSummary.
Return type:str
current_placement

Gets the current_placement of this DbSystemSummary.

Returns:The current_placement of this DbSystemSummary.
Return type:oci.mysql.models.DbSystemPlacement
defined_tags

Gets the defined_tags of this DbSystemSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

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

Gets the description of this DbSystemSummary. User-provided data about the DB System.

Returns:The description of this DbSystemSummary.
Return type:str
display_name

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

Returns:The display_name of this DbSystemSummary.
Return type:str
endpoints

Gets the endpoints of this DbSystemSummary. The network endpoints available for this DB System.

Returns:The endpoints of this DbSystemSummary.
Return type:list[oci.mysql.models.DbSystemEndpoint]
fault_domain

Gets the fault_domain of this DbSystemSummary. The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance.

In a failover scenario, the Read/Write endpoint is redirected to one of the other fault domains and the MySQL instance in that domain is promoted to the primary instance. This redirection does not affect the IP address of the DB System in any way.

For a standalone DB System, this defines the fault domain in which the DB System is placed.

Returns:The fault_domain of this DbSystemSummary.
Return type:str
freeform_tags

Gets the freeform_tags of this DbSystemSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

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

Gets the heat_wave_cluster of this DbSystemSummary.

Returns:The heat_wave_cluster of this DbSystemSummary.
Return type:oci.mysql.models.HeatWaveClusterSummary
id

[Required] Gets the id of this DbSystemSummary. The OCID of the DB System.

Returns:The id of this DbSystemSummary.
Return type:str
is_analytics_cluster_attached

Gets the is_analytics_cluster_attached of this DbSystemSummary. DEPRECATED – please use isHeatWaveClusterAttached instead. If the DB System has an Analytics Cluster attached.

Returns:The is_analytics_cluster_attached of this DbSystemSummary.
Return type:bool
is_heat_wave_cluster_attached

Gets the is_heat_wave_cluster_attached of this DbSystemSummary. If the DB System has a HeatWave Cluster attached.

Returns:The is_heat_wave_cluster_attached of this DbSystemSummary.
Return type:bool
is_highly_available

Gets the is_highly_available of this DbSystemSummary. If the policy is to enable high availability of the instance, by maintaining secondary/failover capacity as necessary.

Returns:The is_highly_available of this DbSystemSummary.
Return type:bool
lifecycle_state

[Required] Gets the lifecycle_state of this DbSystemSummary. The current state of the DB System.

Returns:The lifecycle_state of this DbSystemSummary.
Return type:str
mysql_version

[Required] Gets the mysql_version of this DbSystemSummary. Name of the MySQL Version in use for the DB System.

Returns:The mysql_version of this DbSystemSummary.
Return type:str
time_created

[Required] Gets the time_created of this DbSystemSummary. The date and time the DB System was created.

Returns:The time_created of this DbSystemSummary.
Return type:datetime
time_updated

[Required] Gets the time_updated of this DbSystemSummary. The time the DB System was last updated.

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