CreateMysqlConnectionDetails¶
-
class
oci.golden_gate.models.CreateMysqlConnectionDetails(**kwargs)¶ Bases:
oci.golden_gate.models.create_connection_details.CreateConnectionDetailsThe information about a new MySQL Connection.
Attributes
CONNECTION_TYPE_AMAZON_KINESISstr(object=’’) -> str CONNECTION_TYPE_AMAZON_REDSHIFTstr(object=’’) -> str CONNECTION_TYPE_AMAZON_S3str(object=’’) -> str CONNECTION_TYPE_AZURE_DATA_LAKE_STORAGEstr(object=’’) -> str CONNECTION_TYPE_AZURE_SYNAPSE_ANALYTICSstr(object=’’) -> str CONNECTION_TYPE_DATABRICKSstr(object=’’) -> str CONNECTION_TYPE_DB2str(object=’’) -> str CONNECTION_TYPE_ELASTICSEARCHstr(object=’’) -> str CONNECTION_TYPE_GENERICstr(object=’’) -> str CONNECTION_TYPE_GOLDENGATEstr(object=’’) -> str CONNECTION_TYPE_GOOGLE_BIGQUERYstr(object=’’) -> str CONNECTION_TYPE_GOOGLE_CLOUD_STORAGEstr(object=’’) -> str CONNECTION_TYPE_GOOGLE_PUBSUBstr(object=’’) -> str CONNECTION_TYPE_HDFSstr(object=’’) -> str CONNECTION_TYPE_ICEBERGstr(object=’’) -> str CONNECTION_TYPE_JAVA_MESSAGE_SERVICEstr(object=’’) -> str CONNECTION_TYPE_KAFKAstr(object=’’) -> str CONNECTION_TYPE_KAFKA_SCHEMA_REGISTRYstr(object=’’) -> str CONNECTION_TYPE_MICROSOFT_FABRICstr(object=’’) -> str CONNECTION_TYPE_MICROSOFT_SQLSERVERstr(object=’’) -> str CONNECTION_TYPE_MONGODBstr(object=’’) -> str CONNECTION_TYPE_MYSQLstr(object=’’) -> str CONNECTION_TYPE_OCI_OBJECT_STORAGEstr(object=’’) -> str CONNECTION_TYPE_ORACLEstr(object=’’) -> str CONNECTION_TYPE_ORACLE_AI_DATA_PLATFORMstr(object=’’) -> str CONNECTION_TYPE_ORACLE_NOSQLstr(object=’’) -> str CONNECTION_TYPE_POSTGRESQLstr(object=’’) -> str CONNECTION_TYPE_REDISstr(object=’’) -> str CONNECTION_TYPE_SNOWFLAKEstr(object=’’) -> str ROUTING_METHOD_DEDICATED_ENDPOINTstr(object=’’) -> str ROUTING_METHOD_SHARED_DEPLOYMENT_ENDPOINTstr(object=’’) -> str ROUTING_METHOD_SHARED_SERVICE_ENDPOINTstr(object=’’) -> str additional_attributesGets the additional_attributes of this CreateMysqlConnectionDetails. cluster_placement_group_idGets the cluster_placement_group_id of this CreateConnectionDetails. compartment_id[Required] Gets the compartment_id of this CreateConnectionDetails. connection_type[Required] Gets the connection_type of this CreateConnectionDetails. database_name[Required] Gets the database_name of this CreateMysqlConnectionDetails. db_system_idGets the db_system_id of this CreateMysqlConnectionDetails. defined_tagsGets the defined_tags of this CreateConnectionDetails. descriptionGets the description of this CreateConnectionDetails. display_name[Required] Gets the display_name of this CreateConnectionDetails. does_use_secret_idsGets the does_use_secret_ids of this CreateConnectionDetails. freeform_tagsGets the freeform_tags of this CreateConnectionDetails. hostGets the host of this CreateMysqlConnectionDetails. key_idGets the key_id of this CreateConnectionDetails. locksGets the locks of this CreateConnectionDetails. nsg_idsGets the nsg_ids of this CreateConnectionDetails. passwordGets the password of this CreateMysqlConnectionDetails. password_secret_idGets the password_secret_id of this CreateMysqlConnectionDetails. portGets the port of this CreateMysqlConnectionDetails. private_ipGets the private_ip of this CreateMysqlConnectionDetails. routing_methodGets the routing_method of this CreateConnectionDetails. security_attributesGets the security_attributes of this CreateConnectionDetails. security_protocol[Required] Gets the security_protocol of this CreateMysqlConnectionDetails. ssl_caGets the ssl_ca of this CreateMysqlConnectionDetails. ssl_certGets the ssl_cert of this CreateMysqlConnectionDetails. ssl_crlGets the ssl_crl of this CreateMysqlConnectionDetails. ssl_keyGets the ssl_key of this CreateMysqlConnectionDetails. ssl_key_secret_idGets the ssl_key_secret_id of this CreateMysqlConnectionDetails. ssl_modeGets the ssl_mode of this CreateMysqlConnectionDetails. subnet_idGets the subnet_id of this CreateConnectionDetails. subscription_idGets the subscription_id of this CreateConnectionDetails. technology_type[Required] Gets the technology_type of this CreateMysqlConnectionDetails. username[Required] Gets the username of this CreateMysqlConnectionDetails. vault_idGets the vault_id of this CreateConnectionDetails. Methods
__init__(**kwargs)Initializes a new CreateMysqlConnectionDetails 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_AMAZON_KINESIS= 'AMAZON_KINESIS'¶
-
CONNECTION_TYPE_AMAZON_REDSHIFT= 'AMAZON_REDSHIFT'¶
-
CONNECTION_TYPE_AMAZON_S3= 'AMAZON_S3'¶
-
CONNECTION_TYPE_AZURE_DATA_LAKE_STORAGE= 'AZURE_DATA_LAKE_STORAGE'¶
-
CONNECTION_TYPE_AZURE_SYNAPSE_ANALYTICS= 'AZURE_SYNAPSE_ANALYTICS'¶
-
CONNECTION_TYPE_DATABRICKS= 'DATABRICKS'¶
-
CONNECTION_TYPE_DB2= 'DB2'¶
-
CONNECTION_TYPE_ELASTICSEARCH= 'ELASTICSEARCH'¶
-
CONNECTION_TYPE_GENERIC= 'GENERIC'¶
-
CONNECTION_TYPE_GOLDENGATE= 'GOLDENGATE'¶
-
CONNECTION_TYPE_GOOGLE_BIGQUERY= 'GOOGLE_BIGQUERY'¶
-
CONNECTION_TYPE_GOOGLE_CLOUD_STORAGE= 'GOOGLE_CLOUD_STORAGE'¶
-
CONNECTION_TYPE_GOOGLE_PUBSUB= 'GOOGLE_PUBSUB'¶
-
CONNECTION_TYPE_HDFS= 'HDFS'¶
-
CONNECTION_TYPE_ICEBERG= 'ICEBERG'¶
-
CONNECTION_TYPE_JAVA_MESSAGE_SERVICE= 'JAVA_MESSAGE_SERVICE'¶
-
CONNECTION_TYPE_KAFKA= 'KAFKA'¶
-
CONNECTION_TYPE_KAFKA_SCHEMA_REGISTRY= 'KAFKA_SCHEMA_REGISTRY'¶
-
CONNECTION_TYPE_MICROSOFT_FABRIC= 'MICROSOFT_FABRIC'¶
-
CONNECTION_TYPE_MICROSOFT_SQLSERVER= 'MICROSOFT_SQLSERVER'¶
-
CONNECTION_TYPE_MONGODB= 'MONGODB'¶
-
CONNECTION_TYPE_MYSQL= 'MYSQL'¶
-
CONNECTION_TYPE_OCI_OBJECT_STORAGE= 'OCI_OBJECT_STORAGE'¶
-
CONNECTION_TYPE_ORACLE= 'ORACLE'¶
-
CONNECTION_TYPE_ORACLE_AI_DATA_PLATFORM= 'ORACLE_AI_DATA_PLATFORM'¶
-
CONNECTION_TYPE_ORACLE_NOSQL= 'ORACLE_NOSQL'¶
-
CONNECTION_TYPE_POSTGRESQL= 'POSTGRESQL'¶
-
CONNECTION_TYPE_REDIS= 'REDIS'¶
-
CONNECTION_TYPE_SNOWFLAKE= 'SNOWFLAKE'¶
-
ROUTING_METHOD_DEDICATED_ENDPOINT= 'DEDICATED_ENDPOINT'¶
-
ROUTING_METHOD_SHARED_DEPLOYMENT_ENDPOINT= 'SHARED_DEPLOYMENT_ENDPOINT'¶
-
ROUTING_METHOD_SHARED_SERVICE_ENDPOINT= 'SHARED_SERVICE_ENDPOINT'¶
-
__init__(**kwargs)¶ Initializes a new CreateMysqlConnectionDetails 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 CreateMysqlConnectionDetails. Allowed values for this property are: “GOLDENGATE”, “KAFKA”, “KAFKA_SCHEMA_REGISTRY”, “MYSQL”, “JAVA_MESSAGE_SERVICE”, “MICROSOFT_SQLSERVER”, “OCI_OBJECT_STORAGE”, “ORACLE”, “AZURE_DATA_LAKE_STORAGE”, “POSTGRESQL”, “AZURE_SYNAPSE_ANALYTICS”, “SNOWFLAKE”, “AMAZON_S3”, “HDFS”, “ORACLE_AI_DATA_PLATFORM”, “ORACLE_NOSQL”, “MONGODB”, “AMAZON_KINESIS”, “AMAZON_REDSHIFT”, “DB2”, “REDIS”, “ELASTICSEARCH”, “GENERIC”, “GOOGLE_CLOUD_STORAGE”, “GOOGLE_BIGQUERY”, “DATABRICKS”, “GOOGLE_PUBSUB”, “MICROSOFT_FABRIC”, “ICEBERG”
- display_name (str) – The value to assign to the display_name property of this CreateMysqlConnectionDetails.
- description (str) – The value to assign to the description property of this CreateMysqlConnectionDetails.
- compartment_id (str) – The value to assign to the compartment_id property of this CreateMysqlConnectionDetails.
- freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateMysqlConnectionDetails.
- defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateMysqlConnectionDetails.
- locks (list[oci.golden_gate.models.AddResourceLockDetails]) – The value to assign to the locks property of this CreateMysqlConnectionDetails.
- vault_id (str) – The value to assign to the vault_id property of this CreateMysqlConnectionDetails.
- key_id (str) – The value to assign to the key_id property of this CreateMysqlConnectionDetails.
- nsg_ids (list[str]) – The value to assign to the nsg_ids property of this CreateMysqlConnectionDetails.
- subnet_id (str) – The value to assign to the subnet_id property of this CreateMysqlConnectionDetails.
- routing_method (str) – The value to assign to the routing_method property of this CreateMysqlConnectionDetails. Allowed values for this property are: “SHARED_SERVICE_ENDPOINT”, “SHARED_DEPLOYMENT_ENDPOINT”, “DEDICATED_ENDPOINT”
- does_use_secret_ids (bool) – The value to assign to the does_use_secret_ids property of this CreateMysqlConnectionDetails.
- subscription_id (str) – The value to assign to the subscription_id property of this CreateMysqlConnectionDetails.
- cluster_placement_group_id (str) – The value to assign to the cluster_placement_group_id property of this CreateMysqlConnectionDetails.
- security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this CreateMysqlConnectionDetails.
- technology_type (str) – The value to assign to the technology_type property of this CreateMysqlConnectionDetails.
- username (str) – The value to assign to the username property of this CreateMysqlConnectionDetails.
- password (str) – The value to assign to the password property of this CreateMysqlConnectionDetails.
- password_secret_id (str) – The value to assign to the password_secret_id property of this CreateMysqlConnectionDetails.
- host (str) – The value to assign to the host property of this CreateMysqlConnectionDetails.
- port (int) – The value to assign to the port property of this CreateMysqlConnectionDetails.
- database_name (str) – The value to assign to the database_name property of this CreateMysqlConnectionDetails.
- security_protocol (str) – The value to assign to the security_protocol property of this CreateMysqlConnectionDetails.
- ssl_mode (str) – The value to assign to the ssl_mode property of this CreateMysqlConnectionDetails.
- ssl_ca (str) – The value to assign to the ssl_ca property of this CreateMysqlConnectionDetails.
- ssl_crl (str) – The value to assign to the ssl_crl property of this CreateMysqlConnectionDetails.
- ssl_cert (str) – The value to assign to the ssl_cert property of this CreateMysqlConnectionDetails.
- ssl_key (str) – The value to assign to the ssl_key property of this CreateMysqlConnectionDetails.
- ssl_key_secret_id (str) – The value to assign to the ssl_key_secret_id property of this CreateMysqlConnectionDetails.
- private_ip (str) – The value to assign to the private_ip property of this CreateMysqlConnectionDetails.
- additional_attributes (list[oci.golden_gate.models.NameValuePair]) – The value to assign to the additional_attributes property of this CreateMysqlConnectionDetails.
- db_system_id (str) – The value to assign to the db_system_id property of this CreateMysqlConnectionDetails.
-
additional_attributes¶ Gets the additional_attributes of this CreateMysqlConnectionDetails. An array of name-value pair attribute entries. Used as additional parameters in connection string.
Returns: The additional_attributes of this CreateMysqlConnectionDetails. Return type: list[oci.golden_gate.models.NameValuePair]
-
cluster_placement_group_id¶ Gets the cluster_placement_group_id of this CreateConnectionDetails. The OCID(/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group must not be provided.
Returns: The cluster_placement_group_id of this CreateConnectionDetails. Return type: str
-
compartment_id¶ [Required] Gets the compartment_id of this CreateConnectionDetails. The OCID of the compartment being referenced.
Returns: The compartment_id of this CreateConnectionDetails. Return type: str
-
connection_type¶ [Required] Gets the connection_type of this CreateConnectionDetails. The connection type.
Allowed values for this property are: “GOLDENGATE”, “KAFKA”, “KAFKA_SCHEMA_REGISTRY”, “MYSQL”, “JAVA_MESSAGE_SERVICE”, “MICROSOFT_SQLSERVER”, “OCI_OBJECT_STORAGE”, “ORACLE”, “AZURE_DATA_LAKE_STORAGE”, “POSTGRESQL”, “AZURE_SYNAPSE_ANALYTICS”, “SNOWFLAKE”, “AMAZON_S3”, “HDFS”, “ORACLE_AI_DATA_PLATFORM”, “ORACLE_NOSQL”, “MONGODB”, “AMAZON_KINESIS”, “AMAZON_REDSHIFT”, “DB2”, “REDIS”, “ELASTICSEARCH”, “GENERIC”, “GOOGLE_CLOUD_STORAGE”, “GOOGLE_BIGQUERY”, “DATABRICKS”, “GOOGLE_PUBSUB”, “MICROSOFT_FABRIC”, “ICEBERG”
Returns: The connection_type of this CreateConnectionDetails. Return type: str
-
database_name¶ [Required] Gets the database_name of this CreateMysqlConnectionDetails. The name of the database.
Returns: The database_name of this CreateMysqlConnectionDetails. Return type: str
-
db_system_id¶ Gets the db_system_id of this CreateMysqlConnectionDetails. The OCID of the database system being referenced.
Returns: The db_system_id of this CreateMysqlConnectionDetails. Return type: str
Gets the defined_tags of this CreateConnectionDetails. Tags defined for this resource. Each key is predefined and scoped to a namespace.
Example: {“foo-namespace”: {“bar-key”: “value”}}
Returns: The defined_tags of this CreateConnectionDetails. Return type: dict(str, dict(str, object))
-
description¶ Gets the description of this CreateConnectionDetails. Metadata about this specific object.
Returns: The description of this CreateConnectionDetails. Return type: str
-
display_name¶ [Required] Gets the display_name of this CreateConnectionDetails. An object’s Display Name.
Returns: The display_name of this CreateConnectionDetails. Return type: str
-
does_use_secret_ids¶ Gets the does_use_secret_ids of this CreateConnectionDetails. Indicates that sensitive attributes are provided via Secrets.
Returns: The does_use_secret_ids of this CreateConnectionDetails. Return type: bool
Gets the freeform_tags of this CreateConnectionDetails. A 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 CreateConnectionDetails. 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 CreateMysqlConnectionDetails. The name or address of a host.
Returns: The host of this CreateMysqlConnectionDetails. Return type: str
-
key_id¶ Gets the key_id of this CreateConnectionDetails. Refers to the customer’s master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.
Returns: The key_id of this CreateConnectionDetails. Return type: str
-
locks¶ Gets the locks of this CreateConnectionDetails. Locks associated with this resource.
Returns: The locks of this CreateConnectionDetails. Return type: list[oci.golden_gate.models.AddResourceLockDetails]
-
nsg_ids¶ Gets the nsg_ids of this CreateConnectionDetails. An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
Returns: The nsg_ids of this CreateConnectionDetails. Return type: list[str]
-
password¶ Gets the password of this CreateMysqlConnectionDetails. The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. Deprecated: This field is deprecated and replaced by “passwordSecretId”. This field will be removed after February 15 2026.
Returns: The password of this CreateMysqlConnectionDetails. Return type: str
-
password_secret_id¶ Gets the password_secret_id of this CreateMysqlConnectionDetails. The OCID of the Secret where the password is stored. The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. If secretId is used plaintext field must not be provided. Note: When provided, ‘password’ field must not be provided.
Returns: The password_secret_id of this CreateMysqlConnectionDetails. Return type: str
-
port¶ Gets the port of this CreateMysqlConnectionDetails. The port of an endpoint usually specified for a connection.
Returns: The port of this CreateMysqlConnectionDetails. Return type: int
-
private_ip¶ Gets the private_ip of this CreateMysqlConnectionDetails. Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.
The private IP address of the connection’s endpoint in the customer’s VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
Returns: The private_ip of this CreateMysqlConnectionDetails. Return type: str
-
routing_method¶ Gets the routing_method of this CreateConnectionDetails. Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service’s network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment’s private endpoint through the deployment’s subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.
Allowed values for this property are: “SHARED_SERVICE_ENDPOINT”, “SHARED_DEPLOYMENT_ENDPOINT”, “DEDICATED_ENDPOINT”
Returns: The routing_method of this CreateConnectionDetails. Return type: str
-
security_attributes¶ Gets the security_attributes of this CreateConnectionDetails. Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {“Oracle-ZPR”: {“MaxEgressCount”: {“value”: “42”, “mode”: “enforce”}}}
Returns: The security_attributes of this CreateConnectionDetails. Return type: dict(str, dict(str, object))
-
security_protocol¶ [Required] Gets the security_protocol of this CreateMysqlConnectionDetails. Security Type for MySQL.
Returns: The security_protocol of this CreateMysqlConnectionDetails. Return type: str
-
ssl_ca¶ Gets the ssl_ca of this CreateMysqlConnectionDetails. Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1 and 2-way SSL). It is not included in GET responses if the view=COMPACT query parameter is specified.
Returns: The ssl_ca of this CreateMysqlConnectionDetails. Return type: str
-
ssl_cert¶ Gets the ssl_cert of this CreateMysqlConnectionDetails. Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the view=COMPACT query parameter is specified.
Returns: The ssl_cert of this CreateMysqlConnectionDetails. Return type: str
-
ssl_crl¶ Gets the ssl_crl of this CreateMysqlConnectionDetails. The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA). Note: This is an optional property and only applicable if TLS/MTLS option is selected. It is not included in GET responses if the view=COMPACT query parameter is specified.
Returns: The ssl_crl of this CreateMysqlConnectionDetails. Return type: str
-
ssl_key¶ Gets the ssl_key of this CreateMysqlConnectionDetails. Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL). Deprecated: This field is deprecated and replaced by “sslKeySecretId”. This field will be removed after February 15 2026.
Returns: The ssl_key of this CreateMysqlConnectionDetails. Return type: str
-
ssl_key_secret_id¶ Gets the ssl_key_secret_id of this CreateMysqlConnectionDetails. The OCID of the Secret that stores the Client Key - The content of a .pem or .crt file containing the client private key (for 2-way SSL). Note: When provided, ‘sslKey’ field must not be provided.
Returns: The ssl_key_secret_id of this CreateMysqlConnectionDetails. Return type: str
-
ssl_mode¶ Gets the ssl_mode of this CreateMysqlConnectionDetails. SSL modes for MySQL.
Returns: The ssl_mode of this CreateMysqlConnectionDetails. Return type: str
-
subnet_id¶ Gets the subnet_id of this CreateConnectionDetails. The OCID of the target subnet of the dedicated connection.
Returns: The subnet_id of this CreateConnectionDetails. Return type: str
-
subscription_id¶ Gets the subscription_id of this CreateConnectionDetails. The OCID of the subscription with which resource needs to be associated with.
Returns: The subscription_id of this CreateConnectionDetails. Return type: str
-
technology_type¶ [Required] Gets the technology_type of this CreateMysqlConnectionDetails. The MySQL technology type.
Returns: The technology_type of this CreateMysqlConnectionDetails. Return type: str
-
username¶ [Required] Gets the username of this CreateMysqlConnectionDetails. The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.
Returns: The username of this CreateMysqlConnectionDetails. Return type: str
-
vault_id¶ Gets the vault_id of this CreateConnectionDetails. Refers to the customer’s vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.
Returns: The vault_id of this CreateConnectionDetails. Return type: str
-