Replica¶

class oci.mysql.models.Replica(**kwargs)¶

Bases: object

A DB System read replica.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Replica.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a Replica.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Replica.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a Replica.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a Replica.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a Replica.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a Replica.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a Replica.
`availability_domain`	Gets the availability_domain of this Replica.
`compartment_id`	[Required] Gets the compartment_id of this Replica.
`configuration_id`	Gets the configuration_id of this Replica.
`db_system_id`	[Required] Gets the db_system_id of this Replica.
`defined_tags`	Gets the defined_tags of this Replica.
`description`	Gets the description of this Replica.
`display_name`	[Required] Gets the display_name of this Replica.
`fault_domain`	Gets the fault_domain of this Replica.
`freeform_tags`	Gets the freeform_tags of this Replica.
`id`	[Required] Gets the id of this Replica.
`ip_address`	[Required] Gets the ip_address of this Replica.
`is_delete_protected`	Gets the is_delete_protected of this Replica.
`lifecycle_details`	Gets the lifecycle_details of this Replica.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Replica.
`mysql_version`	[Required] Gets the mysql_version of this Replica.
`port`	[Required] Gets the port of this Replica.
`port_x`	[Required] Gets the port_x of this Replica.
`replica_overrides`	Gets the replica_overrides of this Replica.
`secure_connections`	Gets the secure_connections of this Replica.
`shape_name`	Gets the shape_name of this Replica.
`time_created`	[Required] Gets the time_created of this Replica.
`time_updated`	Gets the time_updated of this Replica.

Methods

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

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

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

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

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

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a Replica. This constant has a value of “FAILED”

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

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the lifecycle_state property of a Replica. This constant has a value of “NEEDS_ATTENTION”

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

__init__(**kwargs)¶

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

Parameters:

secure_connections (oci.mysql.models.SecureConnectionDetails) – The value to assign to the secure_connections property of this Replica.
id (str) – The value to assign to the id property of this Replica.
db_system_id (str) – The value to assign to the db_system_id property of this Replica.
compartment_id (str) – The value to assign to the compartment_id property of this Replica.
display_name (str) – The value to assign to the display_name property of this Replica.
description (str) – The value to assign to the description property of this Replica.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Replica. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “NEEDS_ATTENTION”, “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 Replica.
time_created (datetime) – The value to assign to the time_created property of this Replica.
time_updated (datetime) – The value to assign to the time_updated property of this Replica.
mysql_version (str) – The value to assign to the mysql_version property of this Replica.
availability_domain (str) – The value to assign to the availability_domain property of this Replica.
fault_domain (str) – The value to assign to the fault_domain property of this Replica.
ip_address (str) – The value to assign to the ip_address property of this Replica.
port (int) – The value to assign to the port property of this Replica.
port_x (int) – The value to assign to the port_x property of this Replica.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Replica.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Replica.
is_delete_protected (bool) – The value to assign to the is_delete_protected property of this Replica.
shape_name (str) – The value to assign to the shape_name property of this Replica.
configuration_id (str) – The value to assign to the configuration_id property of this Replica.
replica_overrides (oci.mysql.models.ReplicaOverrides) – The value to assign to the replica_overrides property of this Replica.

availability_domain¶

Gets the availability_domain of this Replica. The name of the Availability Domain the read replica is located in.

Returns:	The availability_domain of this Replica.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this Replica. The OCID of the compartment that contains the read replica.

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

configuration_id¶

Gets the configuration_id of this Replica. The OCID of the Configuration currently in use by the read replica.

Returns:	The configuration_id of this Replica.
Return type:	str

db_system_id¶

[Required] Gets the db_system_id of this Replica. The OCID of the DB System the read replica is associated with.

Returns:	The db_system_id of this Replica.
Return type:	str

defined_tags¶

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

description¶

Gets the description of this Replica. User provided description of the read replica.

Returns:	The description of this Replica.
Return type:	str

display_name¶

[Required] Gets the display_name of this Replica. The user-friendly name for the read replica. It does not have to be unique.

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

fault_domain¶

Gets the fault_domain of this Replica. The name of the Fault Domain the read replica is located in.

Returns:	The fault_domain of this Replica.
Return type:	str

freeform_tags¶

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

id¶

[Required] Gets the id of this Replica. The OCID of the read replica.

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

ip_address¶

[Required] Gets the ip_address of this Replica. The IP address the read replica is configured to listen on.

Returns:	The ip_address of this Replica.
Return type:	str

is_delete_protected¶

Gets the is_delete_protected of this Replica. Specifies whether the read replica can be deleted. Set to true to prevent deletion, false (default) to allow. Note that if a read replica is delete protected it also prevents the entire DB System from being deleted. If the DB System is delete protected, read replicas can still be deleted individually if they are not delete protected themselves.

Returns:	The is_delete_protected of this Replica.
Return type:	bool

lifecycle_details¶

Gets the lifecycle_details of this Replica. A message describing the state of the read replica.

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this Replica. The state of the read replica.

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

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

mysql_version¶

[Required] Gets the mysql_version of this Replica. The MySQL version currently in use by the read replica.

Returns:	The mysql_version of this Replica.
Return type:	str

port¶

[Required] Gets the port of this Replica. The port the read replica is configured to listen on.

Returns:	The port of this Replica.
Return type:	int

port_x¶

[Required] Gets the port_x of this Replica. The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port.

Returns:	The port_x of this Replica.
Return type:	int

replica_overrides¶

Gets the replica_overrides of this Replica.

Returns:	The replica_overrides of this Replica.
Return type:	oci.mysql.models.ReplicaOverrides

secure_connections¶

Gets the secure_connections of this Replica.

Returns:	The secure_connections of this Replica.
Return type:	oci.mysql.models.SecureConnectionDetails

shape_name¶

Gets the shape_name of this Replica. The shape currently in use by the read replica. The shape determines the resources allocated: CPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes. To get a list of shapes, use the list_shapes() operation.

Returns:	The shape_name of this Replica.
Return type:	str

time_created¶

[Required] Gets the time_created of this Replica. The date and time the read replica was created, as described by RFC 3339.

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

time_updated¶

Gets the time_updated of this Replica. The time the read replica was last updated, as described by RFC 3339.

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