MysqlConnectionSummary¶

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

Bases: ConnectionSummary

Summary of the MySQL Connection.

Attributes:

`CONNECTION_TYPE_MYSQL`	A constant which can be used with the connection_type property of a ConnectionSummary.
`CONNECTION_TYPE_ORACLE`	A constant which can be used with the connection_type property of a ConnectionSummary.
`additional_attributes`	Gets the additional_attributes of this MysqlConnectionSummary.
`compartment_id`	[Required] Gets the compartment_id of this ConnectionSummary.
`connection_type`	[Required] Gets the connection_type of this ConnectionSummary.
`database_name`	Gets the database_name of this MysqlConnectionSummary.
`db_system_id`	Gets the db_system_id of this MysqlConnectionSummary.
`defined_tags`	Gets the defined_tags of this ConnectionSummary.
`description`	Gets the description of this ConnectionSummary.
`display_name`	[Required] Gets the display_name of this ConnectionSummary.
`freeform_tags`	Gets the freeform_tags of this ConnectionSummary.
`host`	Gets the host of this MysqlConnectionSummary.
`id`	[Required] Gets the id of this ConnectionSummary.
`ingress_ips`	Gets the ingress_ips of this ConnectionSummary.
`key_id`	Gets the key_id of this ConnectionSummary.
`lifecycle_details`	Gets the lifecycle_details of this ConnectionSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ConnectionSummary.
`nsg_ids`	Gets the nsg_ids of this ConnectionSummary.
`port`	Gets the port of this MysqlConnectionSummary.
`security_protocol`	[Required] Gets the security_protocol of this MysqlConnectionSummary.
`ssl_mode`	Gets the ssl_mode of this MysqlConnectionSummary.
`subnet_id`	Gets the subnet_id of this ConnectionSummary.
`system_tags`	Gets the system_tags of this ConnectionSummary.
`technology_type`	[Required] Gets the technology_type of this MysqlConnectionSummary.
`time_created`	[Required] Gets the time_created of this ConnectionSummary.
`time_updated`	[Required] Gets the time_updated of this ConnectionSummary.
`vault_id`	Gets the vault_id of this ConnectionSummary.

Methods:

`__init__`(**kwargs)	Initializes a new MysqlConnectionSummary 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 ConnectionSummary. This constant has a value of “MYSQL”

CONNECTION_TYPE_ORACLE = 'ORACLE'¶: A constant which can be used with the connection_type property of a ConnectionSummary. This constant has a value of “ORACLE”

__init__(**kwargs)¶

Initializes a new MysqlConnectionSummary 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 MysqlConnectionSummary. Allowed values for this property are: “MYSQL”, “ORACLE”
id (str) – The value to assign to the id property of this MysqlConnectionSummary.
display_name (str) – The value to assign to the display_name property of this MysqlConnectionSummary.
description (str) – The value to assign to the description property of this MysqlConnectionSummary.
compartment_id (str) – The value to assign to the compartment_id property of this MysqlConnectionSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this MysqlConnectionSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this MysqlConnectionSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this MysqlConnectionSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this MysqlConnectionSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this MysqlConnectionSummary.
time_created (datetime) – The value to assign to the time_created property of this MysqlConnectionSummary.
time_updated (datetime) – The value to assign to the time_updated property of this MysqlConnectionSummary.
vault_id (str) – The value to assign to the vault_id property of this MysqlConnectionSummary.
key_id (str) – The value to assign to the key_id property of this MysqlConnectionSummary.
subnet_id (str) – The value to assign to the subnet_id property of this MysqlConnectionSummary.
ingress_ips (list[oci.database_migration.models.IngressIpDetails]) – The value to assign to the ingress_ips property of this MysqlConnectionSummary.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this MysqlConnectionSummary.
technology_type (str) – The value to assign to the technology_type property of this MysqlConnectionSummary.
host (str) – The value to assign to the host property of this MysqlConnectionSummary.
port (int) – The value to assign to the port property of this MysqlConnectionSummary.
database_name (str) – The value to assign to the database_name property of this MysqlConnectionSummary.
security_protocol (str) – The value to assign to the security_protocol property of this MysqlConnectionSummary.
ssl_mode (str) – The value to assign to the ssl_mode property of this MysqlConnectionSummary.
additional_attributes (list[oci.database_migration.models.NameValuePair]) – The value to assign to the additional_attributes property of this MysqlConnectionSummary.
db_system_id (str) – The value to assign to the db_system_id property of this MysqlConnectionSummary.

property additional_attributes¶

Gets the additional_attributes of this MysqlConnectionSummary. An array of name-value pair attribute entries.

Returns: The additional_attributes of this MysqlConnectionSummary.
Return type: list[oci.database_migration.models.NameValuePair]

property compartment_id¶

[Required] Gets the compartment_id of this ConnectionSummary. The OCID of the compartment.

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

property connection_type¶

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

property database_name¶

Gets the database_name of this MysqlConnectionSummary. The name of the database being referenced.

Returns: The database_name of this MysqlConnectionSummary.
Return type: str

property db_system_id¶

Gets the db_system_id of this MysqlConnectionSummary. The OCID of the database system being referenced.

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

property defined_tags¶

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

property description¶

Gets the description of this ConnectionSummary. A user-friendly description. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

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

property display_name¶

[Required] Gets the display_name of this ConnectionSummary. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

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

property freeform_tags¶

Gets the freeform_tags of this ConnectionSummary. 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 ConnectionSummary.
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 MysqlConnectionSummary. The IP Address of the host.

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

property id¶

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

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

property ingress_ips¶

Gets the ingress_ips of this ConnectionSummary. List of ingress IP addresses from where to connect to this connection’s privateIp.

Returns: The ingress_ips of this ConnectionSummary.
Return type: list[oci.database_migration.models.IngressIpDetails]

property key_id¶

Gets the key_id of this ConnectionSummary. The OCID of the key used in cryptographic operations.

Returns: The key_id of this ConnectionSummary.
Return type: str

property lifecycle_details¶

Gets the lifecycle_details of this ConnectionSummary. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

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

property lifecycle_state¶

[Required] Gets the lifecycle_state of this ConnectionSummary. Lifecycle state for connection.

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

property nsg_ids¶

Gets the nsg_ids of this ConnectionSummary. An array of Network Security Group OCIDs used to define network access for Connections.

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

property port¶

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

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

property security_protocol¶

[Required] Gets the security_protocol of this MysqlConnectionSummary. Security Type for MySQL.

Returns: The security_protocol of this MysqlConnectionSummary.
Return type: str

property ssl_mode¶

Gets the ssl_mode of this MysqlConnectionSummary. SSL modes for MySQL.

Returns: The ssl_mode of this MysqlConnectionSummary.
Return type: str

property subnet_id¶

Gets the subnet_id of this ConnectionSummary. OCI resource ID.

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

property system_tags¶

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

property technology_type¶

[Required] Gets the technology_type of this MysqlConnectionSummary. The type of MySQL source or target connection. Example: OCI_MYSQL represents OCI MySQL HeatWave Database Service

Returns: The technology_type of this MysqlConnectionSummary.
Return type: str

property time_created¶

[Required] Gets the time_created of this ConnectionSummary. 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 ConnectionSummary.
Return type: datetime

property time_updated¶

[Required] Gets the time_updated of this ConnectionSummary. 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 ConnectionSummary.
Return type: datetime

property vault_id¶

Gets the vault_id of this ConnectionSummary. OCI resource ID.

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