MysqlConnection¶
- class oci.database_migration.models.MysqlConnection(**kwargs)¶
Bases:
ConnectionRepresents the metadata of a MySQL Connection.
Attributes:
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the lifecycle_state property of a Connection.
A constant which can be used with the lifecycle_state property of a Connection.
A constant which can be used with the lifecycle_state property of a Connection.
A constant which can be used with the lifecycle_state property of a Connection.
A constant which can be used with the lifecycle_state property of a Connection.
A constant which can be used with the lifecycle_state property of a Connection.
A constant which can be used with the lifecycle_state property of a Connection.
A constant which can be used with the security_protocol property of a MysqlConnection.
A constant which can be used with the security_protocol property of a MysqlConnection.
A constant which can be used with the security_protocol property of a MysqlConnection.
A constant which can be used with the ssl_mode property of a MysqlConnection.
A constant which can be used with the ssl_mode property of a MysqlConnection.
A constant which can be used with the ssl_mode property of a MysqlConnection.
A constant which can be used with the ssl_mode property of a MysqlConnection.
A constant which can be used with the ssl_mode property of a MysqlConnection.
A constant which can be used with the technology_type property of a MysqlConnection.
A constant which can be used with the technology_type property of a MysqlConnection.
A constant which can be used with the technology_type property of a MysqlConnection.
A constant which can be used with the technology_type property of a MysqlConnection.
A constant which can be used with the technology_type property of a MysqlConnection.
A constant which can be used with the technology_type property of a MysqlConnection.
Gets the additional_attributes of this MysqlConnection.
[Required] Gets the compartment_id of this Connection.
[Required] Gets the connection_type of this Connection.
Gets the database_name of this MysqlConnection.
Gets the db_system_id of this MysqlConnection.
Gets the defined_tags of this Connection.
Gets the description of this Connection.
[Required] Gets the display_name of this Connection.
Gets the freeform_tags of this Connection.
Gets the host of this MysqlConnection.
[Required] Gets the id of this Connection.
Gets the ingress_ips of this Connection.
Gets the key_id of this Connection.
Gets the lifecycle_details of this Connection.
[Required] Gets the lifecycle_state of this Connection.
Gets the nsg_ids of this Connection.
Gets the password of this Connection.
Gets the port of this MysqlConnection.
Gets the private_endpoint_id of this Connection.
Gets the replication_password of this Connection.
Gets the replication_username of this Connection.
Gets the secret_id of this Connection.
[Required] Gets the security_protocol of this MysqlConnection.
Gets the ssl_mode of this MysqlConnection.
Gets the subnet_id of this Connection.
Gets the system_tags of this Connection.
[Required] Gets the technology_type of this MysqlConnection.
[Required] Gets the time_created of this Connection.
[Required] Gets the time_updated of this Connection.
[Required] Gets the username of this Connection.
Gets the vault_id of this Connection.
Methods:
__init__(**kwargs)Initializes a new MysqlConnection object with values from keyword arguments.
get_subtype(object_dictionary)Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
- CONNECTION_TYPE_MYSQL = 'MYSQL'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “MYSQL”
- CONNECTION_TYPE_ORACLE = 'ORACLE'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “ORACLE”
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a Connection. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a Connection. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a Connection. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a Connection. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a Connection. This constant has a value of “FAILED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a Connection. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a Connection. This constant has a value of “UPDATING”
- SECURITY_PROTOCOL_MTLS = 'MTLS'¶
A constant which can be used with the security_protocol property of a MysqlConnection. This constant has a value of “MTLS”
- SECURITY_PROTOCOL_PLAIN = 'PLAIN'¶
A constant which can be used with the security_protocol property of a MysqlConnection. This constant has a value of “PLAIN”
- SECURITY_PROTOCOL_TLS = 'TLS'¶
A constant which can be used with the security_protocol property of a MysqlConnection. This constant has a value of “TLS”
- SSL_MODE_DISABLED = 'DISABLED'¶
A constant which can be used with the ssl_mode property of a MysqlConnection. This constant has a value of “DISABLED”
- SSL_MODE_PREFERRED = 'PREFERRED'¶
A constant which can be used with the ssl_mode property of a MysqlConnection. This constant has a value of “PREFERRED”
- SSL_MODE_REQUIRED = 'REQUIRED'¶
A constant which can be used with the ssl_mode property of a MysqlConnection. This constant has a value of “REQUIRED”
- SSL_MODE_VERIFY_CA = 'VERIFY_CA'¶
A constant which can be used with the ssl_mode property of a MysqlConnection. This constant has a value of “VERIFY_CA”
- SSL_MODE_VERIFY_IDENTITY = 'VERIFY_IDENTITY'¶
A constant which can be used with the ssl_mode property of a MysqlConnection. This constant has a value of “VERIFY_IDENTITY”
- TECHNOLOGY_TYPE_AMAZON_AURORA_MYSQL = 'AMAZON_AURORA_MYSQL'¶
A constant which can be used with the technology_type property of a MysqlConnection. This constant has a value of “AMAZON_AURORA_MYSQL”
- TECHNOLOGY_TYPE_AMAZON_RDS_MYSQL = 'AMAZON_RDS_MYSQL'¶
A constant which can be used with the technology_type property of a MysqlConnection. This constant has a value of “AMAZON_RDS_MYSQL”
- TECHNOLOGY_TYPE_AZURE_MYSQL = 'AZURE_MYSQL'¶
A constant which can be used with the technology_type property of a MysqlConnection. This constant has a value of “AZURE_MYSQL”
- TECHNOLOGY_TYPE_GOOGLE_CLOUD_SQL_MYSQL = 'GOOGLE_CLOUD_SQL_MYSQL'¶
A constant which can be used with the technology_type property of a MysqlConnection. This constant has a value of “GOOGLE_CLOUD_SQL_MYSQL”
- TECHNOLOGY_TYPE_MYSQL_SERVER = 'MYSQL_SERVER'¶
A constant which can be used with the technology_type property of a MysqlConnection. This constant has a value of “MYSQL_SERVER”
- TECHNOLOGY_TYPE_OCI_MYSQL = 'OCI_MYSQL'¶
A constant which can be used with the technology_type property of a MysqlConnection. This constant has a value of “OCI_MYSQL”
- __init__(**kwargs)¶
Initializes a new MysqlConnection object with values from keyword arguments. The default value of the
connection_typeattribute of this class isMYSQLand it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):- Parameters
connection_type (str) – The value to assign to the connection_type property of this MysqlConnection. Allowed values for this property are: “MYSQL”, “ORACLE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
id (str) – The value to assign to the id property of this MysqlConnection.
display_name (str) – The value to assign to the display_name property of this MysqlConnection.
description (str) – The value to assign to the description property of this MysqlConnection.
compartment_id (str) – The value to assign to the compartment_id property of this MysqlConnection.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this MysqlConnection.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this MysqlConnection.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this MysqlConnection.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this MysqlConnection. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “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 MysqlConnection.
time_created (datetime) – The value to assign to the time_created property of this MysqlConnection.
time_updated (datetime) – The value to assign to the time_updated property of this MysqlConnection.
vault_id (str) – The value to assign to the vault_id property of this MysqlConnection.
key_id (str) – The value to assign to the key_id property of this MysqlConnection.
subnet_id (str) – The value to assign to the subnet_id property of this MysqlConnection.
ingress_ips (list[oci.database_migration.models.IngressIpDetails]) – The value to assign to the ingress_ips property of this MysqlConnection.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this MysqlConnection.
username (str) – The value to assign to the username property of this MysqlConnection.
password (str) – The value to assign to the password property of this MysqlConnection.
replication_username (str) – The value to assign to the replication_username property of this MysqlConnection.
replication_password (str) – The value to assign to the replication_password property of this MysqlConnection.
secret_id (str) – The value to assign to the secret_id property of this MysqlConnection.
private_endpoint_id (str) – The value to assign to the private_endpoint_id property of this MysqlConnection.
technology_type (str) – The value to assign to the technology_type property of this MysqlConnection. Allowed values for this property are: “AMAZON_AURORA_MYSQL”, “AMAZON_RDS_MYSQL”, “AZURE_MYSQL”, “GOOGLE_CLOUD_SQL_MYSQL”, “MYSQL_SERVER”, “OCI_MYSQL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
host (str) – The value to assign to the host property of this MysqlConnection.
port (int) – The value to assign to the port property of this MysqlConnection.
database_name (str) – The value to assign to the database_name property of this MysqlConnection.
security_protocol (str) – The value to assign to the security_protocol property of this MysqlConnection. Allowed values for this property are: “PLAIN”, “TLS”, “MTLS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
ssl_mode (str) – The value to assign to the ssl_mode property of this MysqlConnection. Allowed values for this property are: “DISABLED”, “PREFERRED”, “REQUIRED”, “VERIFY_CA”, “VERIFY_IDENTITY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
additional_attributes (list[oci.database_migration.models.NameValuePair]) – The value to assign to the additional_attributes property of this MysqlConnection.
db_system_id (str) – The value to assign to the db_system_id property of this MysqlConnection.
- property additional_attributes¶
Gets the additional_attributes of this MysqlConnection. An array of name-value pair attribute entries.
- Returns
The additional_attributes of this MysqlConnection.
- Return type
- property compartment_id¶
[Required] Gets the compartment_id of this Connection. The OCID of the compartment.
- Returns
The compartment_id of this Connection.
- Return type
str
- property connection_type¶
[Required] Gets the connection_type of this Connection. Defines the type of connection. For example, ORACLE.
Allowed values for this property are: “MYSQL”, “ORACLE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The connection_type of this Connection.
- Return type
str
- property database_name¶
Gets the database_name of this MysqlConnection. The name of the database being referenced.
- Returns
The database_name of this MysqlConnection.
- Return type
str
- property db_system_id¶
Gets the db_system_id of this MysqlConnection. The OCID of the database system being referenced.
- Returns
The db_system_id of this MysqlConnection.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this Connection. 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 Connection.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this Connection. A user-friendly description. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Returns
The description of this Connection.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this Connection. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Returns
The display_name of this Connection.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this Connection. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {“Department”: “Finance”}
- Returns
The freeform_tags of this Connection.
- Return type
dict(str, str)
- static get_subtype(object_dictionary)¶
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
- property host¶
Gets the host of this MysqlConnection. The IP Address of the host.
- Returns
The host of this MysqlConnection.
- Return type
str
- property id¶
[Required] Gets the id of this Connection. The OCID of the connection being referenced.
- Returns
The id of this Connection.
- Return type
str
- property ingress_ips¶
Gets the ingress_ips of this Connection. List of ingress IP addresses from where to connect to this connection’s privateIp.
- Returns
The ingress_ips of this Connection.
- Return type
- property key_id¶
Gets the key_id of this Connection. The OCID of the key used in cryptographic operations.
- Returns
The key_id of this Connection.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this Connection. The message describing the current state of the connection’s lifecycle in detail. For example, can be used to provide actionable information for a connection in a Failed state.
- Returns
The lifecycle_details of this Connection.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this Connection. The Connection’s current lifecycle state.
Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “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 Connection.
- Return type
str
- property nsg_ids¶
Gets the nsg_ids of this Connection. An array of Network Security Group OCIDs used to define network access for Connections.
- Returns
The nsg_ids of this Connection.
- Return type
list[str]
- property password¶
Gets the password of this Connection. The password (credential) used when creating or updating this resource.
- Returns
The password of this Connection.
- Return type
str
- property port¶
Gets the port of this MysqlConnection. The port to be used for the connection.
- Returns
The port of this MysqlConnection.
- Return type
int
- property private_endpoint_id¶
Gets the private_endpoint_id of this Connection. The OCID of the resource being referenced.
- Returns
The private_endpoint_id of this Connection.
- Return type
str
- property replication_password¶
Gets the replication_password of this Connection. The password (credential) used when creating or updating this resource.
- Returns
The replication_password of this Connection.
- Return type
str
- property replication_username¶
Gets the replication_username of this Connection. The username (credential) used when creating or updating this resource.
- Returns
The replication_username of this Connection.
- Return type
str
- property secret_id¶
Gets the secret_id of this Connection. The OCID of the resource being referenced.
- Returns
The secret_id of this Connection.
- Return type
str
- property security_protocol¶
[Required] Gets the security_protocol of this MysqlConnection. Security Protocol to be used for the connection.
Allowed values for this property are: “PLAIN”, “TLS”, “MTLS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The security_protocol of this MysqlConnection.
- Return type
str
- property ssl_mode¶
Gets the ssl_mode of this MysqlConnection. SSL mode to be used for the connection.
Allowed values for this property are: “DISABLED”, “PREFERRED”, “REQUIRED”, “VERIFY_CA”, “VERIFY_IDENTITY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The ssl_mode of this MysqlConnection.
- Return type
str
- property subnet_id¶
Gets the subnet_id of this Connection. OCI resource ID.
- Returns
The subnet_id of this Connection.
- Return type
str
- property system_tags¶
Gets the system_tags of this Connection. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
- Returns
The system_tags of this Connection.
- Return type
dict(str, dict(str, object))
- property technology_type¶
[Required] Gets the technology_type of this MysqlConnection. The type of MySQL source or target connection. Example: OCI_MYSQL represents OCI MySQL HeatWave Database Service
Allowed values for this property are: “AMAZON_AURORA_MYSQL”, “AMAZON_RDS_MYSQL”, “AZURE_MYSQL”, “GOOGLE_CLOUD_SQL_MYSQL”, “MYSQL_SERVER”, “OCI_MYSQL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The technology_type of this MysqlConnection.
- Return type
str
- property time_created¶
[Required] Gets the time_created of this Connection. The time when this resource was created. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.
- Returns
The time_created of this Connection.
- Return type
datetime
- property time_updated¶
[Required] Gets the time_updated of this Connection. The time when this resource was updated. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.
- Returns
The time_updated of this Connection.
- Return type
datetime
- property username¶
[Required] Gets the username of this Connection. The username (credential) used when creating or updating this resource.
- Returns
The username of this Connection.
- Return type
str
- property vault_id¶
Gets the vault_id of this Connection. OCI resource ID.
- Returns
The vault_id of this Connection.
- Return type
str