DbSystem

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

Bases: object

A DB System is the core logical unit of MySQL Database Service. # NOTE: definitions/DbSystemSnapshot is a snapshot version of DbSystem which is stored during backup. Any # addition/deletion of properties should also consider snapshot’s definition

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a DbSystem.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a DbSystem.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a DbSystem.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a DbSystem.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a DbSystem.
LIFECYCLE_STATE_INACTIVE A constant which can be used with the lifecycle_state property of a DbSystem.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a DbSystem.
analytics_cluster Gets the analytics_cluster of this DbSystem.
availability_domain Gets the availability_domain of this DbSystem.
backup_policy Gets the backup_policy of this DbSystem.
channels Gets the channels of this DbSystem.
compartment_id [Required] Gets the compartment_id of this DbSystem.
configuration_id Gets the configuration_id of this DbSystem.
data_storage_size_in_gbs [Required] Gets the data_storage_size_in_gbs of this DbSystem.
defined_tags Gets the defined_tags of this DbSystem.
description Gets the description of this DbSystem.
display_name [Required] Gets the display_name of this DbSystem.
endpoints Gets the endpoints of this DbSystem.
fault_domain Gets the fault_domain of this DbSystem.
freeform_tags Gets the freeform_tags of this DbSystem.
hostname_label Gets the hostname_label of this DbSystem.
id [Required] Gets the id of this DbSystem.
ip_address Gets the ip_address of this DbSystem.
is_analytics_cluster_attached Gets the is_analytics_cluster_attached of this DbSystem.
lifecycle_details Gets the lifecycle_details of this DbSystem.
lifecycle_state [Required] Gets the lifecycle_state of this DbSystem.
maintenance [Required] Gets the maintenance of this DbSystem.
mysql_version [Required] Gets the mysql_version of this DbSystem.
port Gets the port of this DbSystem.
port_x Gets the port_x of this DbSystem.
shape_name Gets the shape_name of this DbSystem.
source Gets the source of this DbSystem.
subnet_id [Required] Gets the subnet_id of this DbSystem.
time_created [Required] Gets the time_created of this DbSystem.
time_updated [Required] Gets the time_updated of this DbSystem.

Methods

__init__(**kwargs) Initializes a new DbSystem object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a DbSystem. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a DbSystem. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a DbSystem. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a DbSystem. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a DbSystem. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a DbSystem. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a DbSystem. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new DbSystem 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 DbSystem.
  • display_name (str) – The value to assign to the display_name property of this DbSystem.
  • description (str) – The value to assign to the description property of this DbSystem.
  • compartment_id (str) – The value to assign to the compartment_id property of this DbSystem.
  • subnet_id (str) – The value to assign to the subnet_id property of this DbSystem.
  • is_analytics_cluster_attached (bool) – The value to assign to the is_analytics_cluster_attached property of this DbSystem.
  • analytics_cluster (oci.mysql.models.AnalyticsClusterSummary) – The value to assign to the analytics_cluster property of this DbSystem.
  • availability_domain (str) – The value to assign to the availability_domain property of this DbSystem.
  • fault_domain (str) – The value to assign to the fault_domain property of this DbSystem.
  • shape_name (str) – The value to assign to the shape_name property of this DbSystem.
  • mysql_version (str) – The value to assign to the mysql_version property of this DbSystem.
  • backup_policy (oci.mysql.models.BackupPolicy) – The value to assign to the backup_policy property of this DbSystem.
  • source (oci.mysql.models.DbSystemSource) – The value to assign to the source property of this DbSystem.
  • configuration_id (str) – The value to assign to the configuration_id property of this DbSystem.
  • data_storage_size_in_gbs (int) – The value to assign to the data_storage_size_in_gbs property of this DbSystem.
  • hostname_label (str) – The value to assign to the hostname_label property of this DbSystem.
  • ip_address (str) – The value to assign to the ip_address property of this DbSystem.
  • port (int) – The value to assign to the port property of this DbSystem.
  • port_x (int) – The value to assign to the port_x property of this DbSystem.
  • endpoints (list[oci.mysql.models.DbSystemEndpoint]) – The value to assign to the endpoints property of this DbSystem.
  • channels (list[oci.mysql.models.ChannelSummary]) – The value to assign to the channels property of this DbSystem.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this DbSystem. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘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 DbSystem.
  • maintenance (oci.mysql.models.MaintenanceDetails) – The value to assign to the maintenance property of this DbSystem.
  • time_created (datetime) – The value to assign to the time_created property of this DbSystem.
  • time_updated (datetime) – The value to assign to the time_updated property of this DbSystem.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DbSystem.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DbSystem.
analytics_cluster

Gets the analytics_cluster of this DbSystem.

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

Gets the availability_domain of this DbSystem. The Availability Domain where the primary DB System should be located.

Returns:The availability_domain of this DbSystem.
Return type:str
backup_policy

Gets the backup_policy of this DbSystem.

Returns:The backup_policy of this DbSystem.
Return type:oci.mysql.models.BackupPolicy
channels

Gets the channels of this DbSystem. A list with a summary of all the Channels attached to the DB System.

Returns:The channels of this DbSystem.
Return type:list[oci.mysql.models.ChannelSummary]
compartment_id

[Required] Gets the compartment_id of this DbSystem. The OCID of the compartment the DB System belongs in.

Returns:The compartment_id of this DbSystem.
Return type:str
configuration_id

Gets the configuration_id of this DbSystem. The OCID of the Configuration to be used for Instances in this DB System.

Returns:The configuration_id of this DbSystem.
Return type:str
data_storage_size_in_gbs

[Required] Gets the data_storage_size_in_gbs of this DbSystem. Initial size of the data volume in GiBs that will be created and attached.

Returns:The data_storage_size_in_gbs of this DbSystem.
Return type:int
defined_tags

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

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

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

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

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

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

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

Gets the fault_domain of this DbSystem. The name of the Fault Domain the DB System is located in.

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

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

Gets the hostname_label of this DbSystem. The hostname for the primary endpoint of the DB System. Used for DNS. The value is the hostname portion of the primary private IP’s fully qualified domain name (FQDN) (for example, “dbsystem-1” in FQDN “dbsystem-1.subnet123.vcn1.oraclevcn.com”). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.

Returns:The hostname_label of this DbSystem.
Return type:str
id

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

Returns:The id of this DbSystem.
Return type:str
ip_address

Gets the ip_address of this DbSystem. The IP address the DB System is configured to listen on. A private IP address of the primary endpoint of the DB System. Must be an available IP address within the subnet’s CIDR. This will be a “dotted-quad” style IPv4 address.

Returns:The ip_address of this DbSystem.
Return type:str
is_analytics_cluster_attached

Gets the is_analytics_cluster_attached of this DbSystem. If the DB System has an Analytics Cluster attached.

Returns:The is_analytics_cluster_attached of this DbSystem.
Return type:bool
lifecycle_details

Gets the lifecycle_details of this DbSystem. Additional information about the current lifecycleState.

Returns:The lifecycle_details of this DbSystem.
Return type:str
lifecycle_state

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

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

Returns:The lifecycle_state of this DbSystem.
Return type:str
maintenance

[Required] Gets the maintenance of this DbSystem.

Returns:The maintenance of this DbSystem.
Return type:oci.mysql.models.MaintenanceDetails
mysql_version

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

Returns:The mysql_version of this DbSystem.
Return type:str
port

Gets the port of this DbSystem. The port for primary endpoint of the DB System to listen on.

Returns:The port of this DbSystem.
Return type:int
port_x

Gets the port_x of this DbSystem. The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port.

Returns:The port_x of this DbSystem.
Return type:int
shape_name

Gets the shape_name of this DbSystem. The shape of the primary instances of the DB System. The shape determines resources allocated to a DB System - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. To get a list of shapes, use (the list_shapes() operation.

Returns:The shape_name of this DbSystem.
Return type:str
source

Gets the source of this DbSystem.

Returns:The source of this DbSystem.
Return type:oci.mysql.models.DbSystemSource
subnet_id

[Required] Gets the subnet_id of this DbSystem. The OCID of the subnet the DB System is associated with.

Returns:The subnet_id of this DbSystem.
Return type:str
time_created

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

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

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

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