MysqlConnection¶

class oci.database_migration.models.MysqlConnection(**kwargs)¶

Bases: oci.database_migration.models.connection.Connection

Represents the metadata of a MySQL Connection.

Attributes

`CONNECTION_TYPE_MYSQL`	str(object=’’) -> str
`CONNECTION_TYPE_ORACLE`	str(object=’’) -> str
`LIFECYCLE_STATE_ACTIVE`	str(object=’’) -> str
`LIFECYCLE_STATE_CREATING`	str(object=’’) -> str
`LIFECYCLE_STATE_DELETED`	str(object=’’) -> str
`LIFECYCLE_STATE_DELETING`	str(object=’’) -> str
`LIFECYCLE_STATE_FAILED`	str(object=’’) -> str
`LIFECYCLE_STATE_INACTIVE`	str(object=’’) -> str
`LIFECYCLE_STATE_UPDATING`	str(object=’’) -> str
`SECURITY_PROTOCOL_MTLS`	A constant which can be used with the security_protocol property of a MysqlConnection.
`SECURITY_PROTOCOL_PLAIN`	A constant which can be used with the security_protocol property of a MysqlConnection.
`SECURITY_PROTOCOL_TLS`	A constant which can be used with the security_protocol property of a MysqlConnection.
`SSL_MODE_DISABLED`	A constant which can be used with the ssl_mode property of a MysqlConnection.
`SSL_MODE_PREFERRED`	A constant which can be used with the ssl_mode property of a MysqlConnection.
`SSL_MODE_REQUIRED`	A constant which can be used with the ssl_mode property of a MysqlConnection.
`SSL_MODE_VERIFY_CA`	A constant which can be used with the ssl_mode property of a MysqlConnection.
`SSL_MODE_VERIFY_IDENTITY`	A constant which can be used with the ssl_mode property of a MysqlConnection.
`TECHNOLOGY_TYPE_AMAZON_AURORA_MYSQL`	A constant which can be used with the technology_type property of a MysqlConnection.
`TECHNOLOGY_TYPE_AMAZON_RDS_MYSQL`	A constant which can be used with the technology_type property of a MysqlConnection.
`TECHNOLOGY_TYPE_AZURE_MYSQL`	A constant which can be used with the technology_type property of a MysqlConnection.
`TECHNOLOGY_TYPE_GOOGLE_CLOUD_SQL_MYSQL`	A constant which can be used with the technology_type property of a MysqlConnection.
`TECHNOLOGY_TYPE_MYSQL_SERVER`	A constant which can be used with the technology_type property of a MysqlConnection.
`TECHNOLOGY_TYPE_OCI_MYSQL`	A constant which can be used with the technology_type property of a MysqlConnection.
`additional_attributes`	Gets the additional_attributes of this MysqlConnection.
`compartment_id`	[Required] Gets the compartment_id of this Connection.
`connection_type`	[Required] Gets the connection_type of this Connection.
`database_name`	Gets the database_name of this MysqlConnection.
`db_system_id`	Gets the db_system_id of this MysqlConnection.
`defined_tags`	Gets the defined_tags of this Connection.
`description`	Gets the description of this Connection.
`display_name`	[Required] Gets the display_name of this Connection.
`freeform_tags`	Gets the freeform_tags of this Connection.
`host`	Gets the host of this MysqlConnection.
`id`	[Required] Gets the id of this Connection.
`ingress_ips`	Gets the ingress_ips of this Connection.
`key_id`	Gets the key_id of this Connection.
`lifecycle_details`	Gets the lifecycle_details of this Connection.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Connection.
`nsg_ids`	Gets the nsg_ids of this Connection.
`password`	Gets the password of this Connection.
`port`	Gets the port of this MysqlConnection.
`private_endpoint_id`	Gets the private_endpoint_id of this Connection.
`replication_password`	Gets the replication_password of this Connection.
`replication_username`	Gets the replication_username of this Connection.
`secret_id`	Gets the secret_id of this Connection.
`security_protocol`	[Required] Gets the security_protocol of this MysqlConnection.
`ssl_mode`	Gets the ssl_mode of this MysqlConnection.
`subnet_id`	Gets the subnet_id of this Connection.
`system_tags`	Gets the system_tags of this Connection.
`technology_type`	[Required] Gets the technology_type of this MysqlConnection.
`time_created`	[Required] Gets the time_created of this Connection.
`time_updated`	[Required] Gets the time_updated of this Connection.
`username`	[Required] Gets the username of this Connection.
`vault_id`	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'¶

CONNECTION_TYPE_ORACLE = 'ORACLE'¶

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶

LIFECYCLE_STATE_CREATING = 'CREATING'¶

LIFECYCLE_STATE_DELETED = 'DELETED'¶

LIFECYCLE_STATE_DELETING = 'DELETING'¶

LIFECYCLE_STATE_FAILED = 'FAILED'¶

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶

LIFECYCLE_STATE_UPDATING = '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_type attribute of this class is MYSQL and 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.

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:	list[oci.database_migration.models.NameValuePair]

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

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

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

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

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))

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

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

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.

host¶

Gets the host of this MysqlConnection. The IP Address of the host.

Returns:	The host of this MysqlConnection.
Return type:	str

id¶

[Required] Gets the id of this Connection. The OCID of the connection being referenced.

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

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:	list[oci.database_migration.models.IngressIpDetails]

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

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

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

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]

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

port¶

Gets the port of this MysqlConnection. The port to be used for the connection.

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

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

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

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

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

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

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

subnet_id¶

Gets the subnet_id of this Connection. OCI resource ID.

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

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))

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

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

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

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

vault_id¶

Gets the vault_id of this Connection. OCI resource ID.

Returns:	The vault_id of this Connection.
Return type:	str