DbSystemSnapshot¶

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

Bases: object

Snapshot of the DbSystem details at the time of the backup

Attributes

`CRASH_RECOVERY_DISABLED`	A constant which can be used with the crash_recovery property of a DbSystemSnapshot.
`CRASH_RECOVERY_ENABLED`	A constant which can be used with the crash_recovery property of a DbSystemSnapshot.
`DATABASE_MANAGEMENT_DISABLED`	A constant which can be used with the database_management property of a DbSystemSnapshot.
`DATABASE_MANAGEMENT_ENABLED`	A constant which can be used with the database_management property of a DbSystemSnapshot.
`admin_username`	Gets the admin_username of this DbSystemSnapshot.
`availability_domain`	Gets the availability_domain of this DbSystemSnapshot.
`backup_policy`	Gets the backup_policy of this DbSystemSnapshot.
`compartment_id`	[Required] Gets the compartment_id of this DbSystemSnapshot.
`configuration_id`	Gets the configuration_id of this DbSystemSnapshot.
`crash_recovery`	Gets the crash_recovery of this DbSystemSnapshot.
`data_storage`	Gets the data_storage of this DbSystemSnapshot.
`data_storage_size_in_gbs`	[Required] Gets the data_storage_size_in_gbs of this DbSystemSnapshot.
`database_management`	Gets the database_management of this DbSystemSnapshot.
`defined_tags`	Gets the defined_tags of this DbSystemSnapshot.
`deletion_policy`	[Required] Gets the deletion_policy of this DbSystemSnapshot.
`description`	Gets the description of this DbSystemSnapshot.
`display_name`	[Required] Gets the display_name of this DbSystemSnapshot.
`endpoints`	Gets the endpoints of this DbSystemSnapshot.
`fault_domain`	Gets the fault_domain of this DbSystemSnapshot.
`freeform_tags`	Gets the freeform_tags of this DbSystemSnapshot.
`hostname_label`	Gets the hostname_label of this DbSystemSnapshot.
`id`	[Required] Gets the id of this DbSystemSnapshot.
`ip_address`	Gets the ip_address of this DbSystemSnapshot.
`is_highly_available`	Gets the is_highly_available of this DbSystemSnapshot.
`maintenance`	[Required] Gets the maintenance of this DbSystemSnapshot.
`mysql_version`	[Required] Gets the mysql_version of this DbSystemSnapshot.
`port`	Gets the port of this DbSystemSnapshot.
`port_x`	Gets the port_x of this DbSystemSnapshot.
`region`	Gets the region of this DbSystemSnapshot.
`secure_connections`	Gets the secure_connections of this DbSystemSnapshot.
`shape_name`	Gets the shape_name of this DbSystemSnapshot.
`subnet_id`	[Required] Gets the subnet_id of this DbSystemSnapshot.

Methods

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

CRASH_RECOVERY_DISABLED = 'DISABLED'¶: A constant which can be used with the crash_recovery property of a DbSystemSnapshot. This constant has a value of “DISABLED”

CRASH_RECOVERY_ENABLED = 'ENABLED'¶: A constant which can be used with the crash_recovery property of a DbSystemSnapshot. This constant has a value of “ENABLED”

DATABASE_MANAGEMENT_DISABLED = 'DISABLED'¶: A constant which can be used with the database_management property of a DbSystemSnapshot. This constant has a value of “DISABLED”

DATABASE_MANAGEMENT_ENABLED = 'ENABLED'¶: A constant which can be used with the database_management property of a DbSystemSnapshot. This constant has a value of “ENABLED”

__init__(**kwargs)¶

Initializes a new DbSystemSnapshot 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 DbSystemSnapshot.
display_name (str) – The value to assign to the display_name property of this DbSystemSnapshot.
description (str) – The value to assign to the description property of this DbSystemSnapshot.
compartment_id (str) – The value to assign to the compartment_id property of this DbSystemSnapshot.
subnet_id (str) – The value to assign to the subnet_id property of this DbSystemSnapshot.
availability_domain (str) – The value to assign to the availability_domain property of this DbSystemSnapshot.
fault_domain (str) – The value to assign to the fault_domain property of this DbSystemSnapshot.
shape_name (str) – The value to assign to the shape_name property of this DbSystemSnapshot.
mysql_version (str) – The value to assign to the mysql_version property of this DbSystemSnapshot.
admin_username (str) – The value to assign to the admin_username property of this DbSystemSnapshot.
backup_policy (oci.mysql.models.BackupPolicy) – The value to assign to the backup_policy property of this DbSystemSnapshot.
configuration_id (str) – The value to assign to the configuration_id property of this DbSystemSnapshot.
data_storage_size_in_gbs (int) – The value to assign to the data_storage_size_in_gbs property of this DbSystemSnapshot.
data_storage (oci.mysql.models.DataStorage) – The value to assign to the data_storage property of this DbSystemSnapshot.
hostname_label (str) – The value to assign to the hostname_label property of this DbSystemSnapshot.
ip_address (str) – The value to assign to the ip_address property of this DbSystemSnapshot.
port (int) – The value to assign to the port property of this DbSystemSnapshot.
port_x (int) – The value to assign to the port_x property of this DbSystemSnapshot.
is_highly_available (bool) – The value to assign to the is_highly_available property of this DbSystemSnapshot.
endpoints (list[oci.mysql.models.DbSystemEndpoint]) – The value to assign to the endpoints property of this DbSystemSnapshot.
maintenance (oci.mysql.models.MaintenanceDetails) – The value to assign to the maintenance property of this DbSystemSnapshot.
deletion_policy (oci.mysql.models.DeletionPolicyDetails) – The value to assign to the deletion_policy property of this DbSystemSnapshot.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DbSystemSnapshot.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DbSystemSnapshot.
crash_recovery (str) – The value to assign to the crash_recovery property of this DbSystemSnapshot. Allowed values for this property are: “ENABLED”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
database_management (str) – The value to assign to the database_management property of this DbSystemSnapshot. Allowed values for this property are: “ENABLED”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
secure_connections (oci.mysql.models.SecureConnectionDetails) – The value to assign to the secure_connections property of this DbSystemSnapshot.
region (str) – The value to assign to the region property of this DbSystemSnapshot.

admin_username¶

Gets the admin_username of this DbSystemSnapshot. The username for the administrative user.

Returns:	The admin_username of this DbSystemSnapshot.
Return type:	str

availability_domain¶

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

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

backup_policy¶

Gets the backup_policy of this DbSystemSnapshot.

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

compartment_id¶

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

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

configuration_id¶

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

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

crash_recovery¶

Gets the crash_recovery of this DbSystemSnapshot. Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, and whether to enable or disable syncing of the Binary Logs.

Allowed values for this property are: “ENABLED”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The crash_recovery of this DbSystemSnapshot.
Return type:	str

data_storage¶

Gets the data_storage of this DbSystemSnapshot.

Returns:	The data_storage of this DbSystemSnapshot.
Return type:	oci.mysql.models.DataStorage

data_storage_size_in_gbs¶

[Required] Gets the data_storage_size_in_gbs of this DbSystemSnapshot. DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.

Returns:	The data_storage_size_in_gbs of this DbSystemSnapshot.
Return type:	int

database_management¶

Gets the database_management of this DbSystemSnapshot. Whether to enable monitoring via the Database Management service.

Allowed values for this property are: “ENABLED”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The database_management of this DbSystemSnapshot.
Return type:	str

defined_tags¶

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

deletion_policy¶

[Required] Gets the deletion_policy of this DbSystemSnapshot.

Returns:	The deletion_policy of this DbSystemSnapshot.
Return type:	oci.mysql.models.DeletionPolicyDetails

description¶

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

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

display_name¶

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

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

endpoints¶

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

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

fault_domain¶

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

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

freeform_tags¶

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

hostname_label¶

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

id¶

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

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

ip_address¶

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

is_highly_available¶

Gets the is_highly_available of this DbSystemSnapshot. Specifies if the DB System is highly available.

Returns:	The is_highly_available of this DbSystemSnapshot.
Return type:	bool

maintenance¶

[Required] Gets the maintenance of this DbSystemSnapshot.

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

mysql_version¶

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

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

port¶

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

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

port_x¶

Gets the port_x of this DbSystemSnapshot. 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 DbSystemSnapshot.
Return type:	int

region¶

Gets the region of this DbSystemSnapshot. The region identifier of the region where the DB system exists. For more information, please see Regions and Availability Domains.

Returns:	The region of this DbSystemSnapshot.
Return type:	str

secure_connections¶

Gets the secure_connections of this DbSystemSnapshot.

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

shape_name¶

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

subnet_id¶

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

Returns:	The subnet_id of this DbSystemSnapshot.
Return type:	str