CreateMicrosoftSqlserverConnectionDetails¶

class oci.golden_gate.models.CreateMicrosoftSqlserverConnectionDetails(**kwargs)¶

Bases: oci.golden_gate.models.create_connection_details.CreateConnectionDetails

The information about a new Microsoft SQL Server Connection.

Attributes

`CONNECTION_TYPE_AMAZON_KINESIS`	str(object=’’) -> str
`CONNECTION_TYPE_AMAZON_REDSHIFT`	str(object=’’) -> str
`CONNECTION_TYPE_AMAZON_S3`	str(object=’’) -> str
`CONNECTION_TYPE_AZURE_DATA_LAKE_STORAGE`	str(object=’’) -> str
`CONNECTION_TYPE_AZURE_SYNAPSE_ANALYTICS`	str(object=’’) -> str
`CONNECTION_TYPE_DB2`	str(object=’’) -> str
`CONNECTION_TYPE_ELASTICSEARCH`	str(object=’’) -> str
`CONNECTION_TYPE_GENERIC`	str(object=’’) -> str
`CONNECTION_TYPE_GOLDENGATE`	str(object=’’) -> str
`CONNECTION_TYPE_GOOGLE_BIGQUERY`	str(object=’’) -> str
`CONNECTION_TYPE_GOOGLE_CLOUD_STORAGE`	str(object=’’) -> str
`CONNECTION_TYPE_HDFS`	str(object=’’) -> str
`CONNECTION_TYPE_JAVA_MESSAGE_SERVICE`	str(object=’’) -> str
`CONNECTION_TYPE_KAFKA`	str(object=’’) -> str
`CONNECTION_TYPE_KAFKA_SCHEMA_REGISTRY`	str(object=’’) -> str
`CONNECTION_TYPE_MICROSOFT_SQLSERVER`	str(object=’’) -> str
`CONNECTION_TYPE_MONGODB`	str(object=’’) -> str
`CONNECTION_TYPE_MYSQL`	str(object=’’) -> str
`CONNECTION_TYPE_OCI_OBJECT_STORAGE`	str(object=’’) -> str
`CONNECTION_TYPE_ORACLE`	str(object=’’) -> str
`CONNECTION_TYPE_ORACLE_NOSQL`	str(object=’’) -> str
`CONNECTION_TYPE_POSTGRESQL`	str(object=’’) -> str
`CONNECTION_TYPE_REDIS`	str(object=’’) -> str
`CONNECTION_TYPE_SNOWFLAKE`	str(object=’’) -> str
`ROUTING_METHOD_DEDICATED_ENDPOINT`	str(object=’’) -> str
`ROUTING_METHOD_SHARED_DEPLOYMENT_ENDPOINT`	str(object=’’) -> str
`ROUTING_METHOD_SHARED_SERVICE_ENDPOINT`	str(object=’’) -> str
`additional_attributes`	Gets the additional_attributes of this CreateMicrosoftSqlserverConnectionDetails.
`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 CreateMicrosoftSqlserverConnectionDetails.
`defined_tags`	Gets the defined_tags of this CreateConnectionDetails.
`description`	Gets the description of this CreateConnectionDetails.
`display_name`	[Required] Gets the display_name of this CreateConnectionDetails.
`freeform_tags`	Gets the freeform_tags of this CreateConnectionDetails.
`host`	[Required] Gets the host of this CreateMicrosoftSqlserverConnectionDetails.
`key_id`	Gets the key_id of this CreateConnectionDetails.
`locks`	Gets the locks of this CreateConnectionDetails.
`nsg_ids`	Gets the nsg_ids of this CreateConnectionDetails.
`password`	[Required] Gets the password of this CreateMicrosoftSqlserverConnectionDetails.
`port`	[Required] Gets the port of this CreateMicrosoftSqlserverConnectionDetails.
`private_ip`	Gets the private_ip of this CreateMicrosoftSqlserverConnectionDetails.
`routing_method`	Gets the routing_method of this CreateConnectionDetails.
`security_protocol`	[Required] Gets the security_protocol of this CreateMicrosoftSqlserverConnectionDetails.
`should_validate_server_certificate`	Gets the should_validate_server_certificate of this CreateMicrosoftSqlserverConnectionDetails.
`ssl_ca`	Gets the ssl_ca of this CreateMicrosoftSqlserverConnectionDetails.
`subnet_id`	Gets the subnet_id of this CreateConnectionDetails.
`technology_type`	[Required] Gets the technology_type of this CreateMicrosoftSqlserverConnectionDetails.
`username`	[Required] Gets the username of this CreateMicrosoftSqlserverConnectionDetails.
`vault_id`	Gets the vault_id of this CreateConnectionDetails.

Methods

`__init__`(**kwargs)	Initializes a new CreateMicrosoftSqlserverConnectionDetails 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_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_HDFS = 'HDFS'¶

CONNECTION_TYPE_JAVA_MESSAGE_SERVICE = 'JAVA_MESSAGE_SERVICE'¶

CONNECTION_TYPE_KAFKA = 'KAFKA'¶

CONNECTION_TYPE_KAFKA_SCHEMA_REGISTRY = 'KAFKA_SCHEMA_REGISTRY'¶

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_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 CreateMicrosoftSqlserverConnectionDetails object with values from keyword arguments. The default value of the connection_type attribute of this class is MICROSOFT_SQLSERVER 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 CreateMicrosoftSqlserverConnectionDetails. 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_NOSQL”, “MONGODB”, “AMAZON_KINESIS”, “AMAZON_REDSHIFT”, “DB2”, “REDIS”, “ELASTICSEARCH”, “GENERIC”, “GOOGLE_CLOUD_STORAGE”, “GOOGLE_BIGQUERY”
display_name (str) – The value to assign to the display_name property of this CreateMicrosoftSqlserverConnectionDetails.
description (str) – The value to assign to the description property of this CreateMicrosoftSqlserverConnectionDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateMicrosoftSqlserverConnectionDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateMicrosoftSqlserverConnectionDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateMicrosoftSqlserverConnectionDetails.
locks (list[oci.golden_gate.models.AddResourceLockDetails]) – The value to assign to the locks property of this CreateMicrosoftSqlserverConnectionDetails.
vault_id (str) – The value to assign to the vault_id property of this CreateMicrosoftSqlserverConnectionDetails.
key_id (str) – The value to assign to the key_id property of this CreateMicrosoftSqlserverConnectionDetails.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this CreateMicrosoftSqlserverConnectionDetails.
subnet_id (str) – The value to assign to the subnet_id property of this CreateMicrosoftSqlserverConnectionDetails.
routing_method (str) – The value to assign to the routing_method property of this CreateMicrosoftSqlserverConnectionDetails. Allowed values for this property are: “SHARED_SERVICE_ENDPOINT”, “SHARED_DEPLOYMENT_ENDPOINT”, “DEDICATED_ENDPOINT”
technology_type (str) – The value to assign to the technology_type property of this CreateMicrosoftSqlserverConnectionDetails.
database_name (str) – The value to assign to the database_name property of this CreateMicrosoftSqlserverConnectionDetails.
host (str) – The value to assign to the host property of this CreateMicrosoftSqlserverConnectionDetails.
port (int) – The value to assign to the port property of this CreateMicrosoftSqlserverConnectionDetails.
username (str) – The value to assign to the username property of this CreateMicrosoftSqlserverConnectionDetails.
password (str) – The value to assign to the password property of this CreateMicrosoftSqlserverConnectionDetails.
additional_attributes (list[oci.golden_gate.models.NameValuePair]) – The value to assign to the additional_attributes property of this CreateMicrosoftSqlserverConnectionDetails.
security_protocol (str) – The value to assign to the security_protocol property of this CreateMicrosoftSqlserverConnectionDetails.
ssl_ca (str) – The value to assign to the ssl_ca property of this CreateMicrosoftSqlserverConnectionDetails.
should_validate_server_certificate (bool) – The value to assign to the should_validate_server_certificate property of this CreateMicrosoftSqlserverConnectionDetails.
private_ip (str) – The value to assign to the private_ip property of this CreateMicrosoftSqlserverConnectionDetails.

additional_attributes¶

Gets the additional_attributes of this CreateMicrosoftSqlserverConnectionDetails. An array of name-value pair attribute entries. Used as additional parameters in connection string.

Returns:	The additional_attributes of this CreateMicrosoftSqlserverConnectionDetails.
Return type:	list[oci.golden_gate.models.NameValuePair]

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_NOSQL”, “MONGODB”, “AMAZON_KINESIS”, “AMAZON_REDSHIFT”, “DB2”, “REDIS”, “ELASTICSEARCH”, “GENERIC”, “GOOGLE_CLOUD_STORAGE”, “GOOGLE_BIGQUERY”

Returns:	The connection_type of this CreateConnectionDetails.
Return type:	str

database_name¶

[Required] Gets the database_name of this CreateMicrosoftSqlserverConnectionDetails. The name of the database.

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

defined_tags¶

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

freeform_tags¶

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¶

[Required] Gets the host of this CreateMicrosoftSqlserverConnectionDetails. The name or address of a host.

Returns:	The host of this CreateMicrosoftSqlserverConnectionDetails.
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¶

[Required] Gets the password of this CreateMicrosoftSqlserverConnectionDetails. The password Oracle GoldenGate uses to connect the associated Microsoft SQL Server.

Returns:	The password of this CreateMicrosoftSqlserverConnectionDetails.
Return type:	str

port¶

[Required] Gets the port of this CreateMicrosoftSqlserverConnectionDetails. The port of an endpoint usually specified for a connection.

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

private_ip¶

Gets the private_ip of this CreateMicrosoftSqlserverConnectionDetails. 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 CreateMicrosoftSqlserverConnectionDetails.
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_protocol¶

[Required] Gets the security_protocol of this CreateMicrosoftSqlserverConnectionDetails. Security Type for Microsoft SQL Server.

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

should_validate_server_certificate¶

Gets the should_validate_server_certificate of this CreateMicrosoftSqlserverConnectionDetails. If set to true, the driver validates the certificate that is sent by the database server.

Returns:	The should_validate_server_certificate of this CreateMicrosoftSqlserverConnectionDetails.
Return type:	bool

ssl_ca¶

Gets the ssl_ca of this CreateMicrosoftSqlserverConnectionDetails. Database Certificate - The base64 encoded content of a .pem or .crt file. containing the server public key (for 1-way SSL).

Returns:	The ssl_ca of this CreateMicrosoftSqlserverConnectionDetails.
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

technology_type¶

[Required] Gets the technology_type of this CreateMicrosoftSqlserverConnectionDetails. The Microsoft SQL Server technology type.

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

username¶

[Required] Gets the username of this CreateMicrosoftSqlserverConnectionDetails. The username Oracle GoldenGate uses to connect to the Microsoft SQL Server. This username must already exist and be available by the Microsoft SQL Server to be connected to.

Returns:	The username of this CreateMicrosoftSqlserverConnectionDetails.
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