ReplicaSummary¶

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

Bases: object

Summary of the read replica.

Attributes:

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

Methods:

__init__(**kwargs)

Initializes a new ReplicaSummary object with values from keyword arguments.

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

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

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

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

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a ReplicaSummary. 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 ReplicaSummary. 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 ReplicaSummary. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new ReplicaSummary 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 ReplicaSummary.
db_system_id (str) – The value to assign to the db_system_id property of this ReplicaSummary.
compartment_id (str) – The value to assign to the compartment_id property of this ReplicaSummary.
display_name (str) – The value to assign to the display_name property of this ReplicaSummary.
description (str) – The value to assign to the description property of this ReplicaSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ReplicaSummary. 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 ReplicaSummary.
time_created (datetime) – The value to assign to the time_created property of this ReplicaSummary.
time_updated (datetime) – The value to assign to the time_updated property of this ReplicaSummary.
mysql_version (str) – The value to assign to the mysql_version property of this ReplicaSummary.
availability_domain (str) – The value to assign to the availability_domain property of this ReplicaSummary.
fault_domain (str) – The value to assign to the fault_domain property of this ReplicaSummary.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this ReplicaSummary.
security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this ReplicaSummary.
ip_address (str) – The value to assign to the ip_address property of this ReplicaSummary.
ipv6_address (str) – The value to assign to the ipv6_address property of this ReplicaSummary.
port (int) – The value to assign to the port property of this ReplicaSummary.
port_x (int) – The value to assign to the port_x property of this ReplicaSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ReplicaSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ReplicaSummary.
is_delete_protected (bool) – The value to assign to the is_delete_protected property of this ReplicaSummary.
shape_name (str) – The value to assign to the shape_name property of this ReplicaSummary.
configuration_id (str) – The value to assign to the configuration_id property of this ReplicaSummary.
replica_overrides (oci.mysql.models.ReplicaOverrides) – The value to assign to the replica_overrides property of this ReplicaSummary.
telemetry_configuration (oci.mysql.models.TelemetryConfigurationDetails) – The value to assign to the telemetry_configuration property of this ReplicaSummary.

property availability_domain¶

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

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

property compartment_id¶

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

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

property configuration_id¶

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

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

property db_system_id¶

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

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

property defined_tags¶

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

property description¶

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

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

property display_name¶

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

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

property fault_domain¶

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

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

property freeform_tags¶

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

property id¶

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

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

property ip_address¶

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

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

property ipv6_address¶

Gets the ipv6_address of this ReplicaSummary. The IPv6 address the read replica is configured to listen on.

Returns: The ipv6_address of this ReplicaSummary.
Return type: str

property is_delete_protected¶

Gets the is_delete_protected of this ReplicaSummary. 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 ReplicaSummary.
Return type: bool

property lifecycle_details¶

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

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

property lifecycle_state¶

[Required] Gets the lifecycle_state of this ReplicaSummary. 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 ReplicaSummary.
Return type: str

property mysql_version¶

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

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

property nsg_ids¶

Gets the nsg_ids of this ReplicaSummary. Network Security Group OCIDs used for the VNIC attachment.

Returns: The nsg_ids of this ReplicaSummary.
Return type: list[str]

property port¶

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

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

property port_x¶

[Required] Gets the port_x of this ReplicaSummary. 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 ReplicaSummary.
Return type: int

property replica_overrides¶

Gets the replica_overrides of this ReplicaSummary.

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

property security_attributes¶

Gets the security_attributes of this ReplicaSummary. Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see ZPR Artifacts. Example: {“Oracle-ZPR”: {“MaxEgressCount”: {“value”: “42”, “mode”: “audit”}}}

Returns: The security_attributes of this ReplicaSummary.
Return type: dict(str, dict(str, object))

property shape_name¶

Gets the shape_name of this ReplicaSummary. 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 ReplicaSummary.
Return type: str

property telemetry_configuration¶

Gets the telemetry_configuration of this ReplicaSummary.

Returns: The telemetry_configuration of this ReplicaSummary.
Return type: oci.mysql.models.TelemetryConfigurationDetails

property time_created¶

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

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

property time_updated¶

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

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