CreateDb2ConnectionDetails¶

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

Bases: oci.golden_gate.models.create_connection_details.CreateConnectionDetails

The information about a new DB2 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 CreateDb2ConnectionDetails.
`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 CreateDb2ConnectionDetails.
`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.
`does_use_secret_ids`	Gets the does_use_secret_ids of this CreateConnectionDetails.
`freeform_tags`	Gets the freeform_tags of this CreateConnectionDetails.
`host`	[Required] Gets the host of this CreateDb2ConnectionDetails.
`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`	Gets the password of this CreateDb2ConnectionDetails.
`password_secret_id`	Gets the password_secret_id of this CreateDb2ConnectionDetails.
`port`	[Required] Gets the port of this CreateDb2ConnectionDetails.
`routing_method`	Gets the routing_method of this CreateConnectionDetails.
`security_protocol`	[Required] Gets the security_protocol of this CreateDb2ConnectionDetails.
`ssl_client_keystash`	Gets the ssl_client_keystash of this CreateDb2ConnectionDetails.
`ssl_client_keystash_secret_id`	Gets the ssl_client_keystash_secret_id of this CreateDb2ConnectionDetails.
`ssl_client_keystoredb`	Gets the ssl_client_keystoredb of this CreateDb2ConnectionDetails.
`ssl_client_keystoredb_secret_id`	Gets the ssl_client_keystoredb_secret_id of this CreateDb2ConnectionDetails.
`ssl_server_certificate`	Gets the ssl_server_certificate of this CreateDb2ConnectionDetails.
`subnet_id`	Gets the subnet_id of this CreateConnectionDetails.
`technology_type`	[Required] Gets the technology_type of this CreateDb2ConnectionDetails.
`username`	[Required] Gets the username of this CreateDb2ConnectionDetails.
`vault_id`	Gets the vault_id of this CreateConnectionDetails.

Methods

`__init__`(**kwargs)	Initializes a new CreateDb2ConnectionDetails 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 CreateDb2ConnectionDetails object with values from keyword arguments. The default value of the connection_type attribute of this class is DB2 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 CreateDb2ConnectionDetails. 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 CreateDb2ConnectionDetails.
description (str) – The value to assign to the description property of this CreateDb2ConnectionDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateDb2ConnectionDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateDb2ConnectionDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateDb2ConnectionDetails.
locks (list[oci.golden_gate.models.AddResourceLockDetails]) – The value to assign to the locks property of this CreateDb2ConnectionDetails.
vault_id (str) – The value to assign to the vault_id property of this CreateDb2ConnectionDetails.
key_id (str) – The value to assign to the key_id property of this CreateDb2ConnectionDetails.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this CreateDb2ConnectionDetails.
subnet_id (str) – The value to assign to the subnet_id property of this CreateDb2ConnectionDetails.
routing_method (str) – The value to assign to the routing_method property of this CreateDb2ConnectionDetails. 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 CreateDb2ConnectionDetails.
technology_type (str) – The value to assign to the technology_type property of this CreateDb2ConnectionDetails.
database_name (str) – The value to assign to the database_name property of this CreateDb2ConnectionDetails.
host (str) – The value to assign to the host property of this CreateDb2ConnectionDetails.
port (int) – The value to assign to the port property of this CreateDb2ConnectionDetails.
username (str) – The value to assign to the username property of this CreateDb2ConnectionDetails.
password (str) – The value to assign to the password property of this CreateDb2ConnectionDetails.
password_secret_id (str) – The value to assign to the password_secret_id property of this CreateDb2ConnectionDetails.
additional_attributes (list[oci.golden_gate.models.NameValuePair]) – The value to assign to the additional_attributes property of this CreateDb2ConnectionDetails.
security_protocol (str) – The value to assign to the security_protocol property of this CreateDb2ConnectionDetails.
ssl_client_keystoredb (str) – The value to assign to the ssl_client_keystoredb property of this CreateDb2ConnectionDetails.
ssl_client_keystoredb_secret_id (str) – The value to assign to the ssl_client_keystoredb_secret_id property of this CreateDb2ConnectionDetails.
ssl_client_keystash (str) – The value to assign to the ssl_client_keystash property of this CreateDb2ConnectionDetails.
ssl_client_keystash_secret_id (str) – The value to assign to the ssl_client_keystash_secret_id property of this CreateDb2ConnectionDetails.
ssl_server_certificate (str) – The value to assign to the ssl_server_certificate property of this CreateDb2ConnectionDetails.

additional_attributes¶

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

Returns:	The additional_attributes of this CreateDb2ConnectionDetails.
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 CreateDb2ConnectionDetails. The name of the database.

Returns:	The database_name of this CreateDb2ConnectionDetails.
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

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

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 CreateDb2ConnectionDetails. The name or address of a host.

Returns:	The host of this CreateDb2ConnectionDetails.
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 CreateDb2ConnectionDetails. The password Oracle GoldenGate uses to connect the associated DB2 database.

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

password_secret_id¶

Gets the password_secret_id of this CreateDb2ConnectionDetails. The OCID of the Secret where the password is stored, that Oracle GoldenGate uses to connect the associated DB2 database. Note: When provided, ‘password’ field must not be provided.

Returns:	The password_secret_id of this CreateDb2ConnectionDetails.
Return type:	str

port¶

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

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

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 CreateDb2ConnectionDetails. Security protocol for the DB2 database.

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

ssl_client_keystash¶

Gets the ssl_client_keystash of this CreateDb2ConnectionDetails. The base64 encoded keystash file which contains the encrypted password to the key database file.

Returns:	The ssl_client_keystash of this CreateDb2ConnectionDetails.
Return type:	str

ssl_client_keystash_secret_id¶

Gets the ssl_client_keystash_secret_id of this CreateDb2ConnectionDetails. The OCID of the Secret where the keystash file is stored, which contains the encrypted password to the key database file. Note: When provided, ‘sslClientKeystash’ field must not be provided.

Returns:	The ssl_client_keystash_secret_id of this CreateDb2ConnectionDetails.
Return type:	str

ssl_client_keystoredb¶

Gets the ssl_client_keystoredb of this CreateDb2ConnectionDetails. The base64 encoded keystore file created at the client containing the server certificate / CA root certificate.

Returns:	The ssl_client_keystoredb of this CreateDb2ConnectionDetails.
Return type:	str

ssl_client_keystoredb_secret_id¶

Gets the ssl_client_keystoredb_secret_id of this CreateDb2ConnectionDetails. The OCID of the Secret where the keystore file stored, which created at the client containing the server certificate / CA root certificate. Note: When provided, ‘sslClientKeystoredb’ field must not be provided.

Returns:	The ssl_client_keystoredb_secret_id of this CreateDb2ConnectionDetails.
Return type:	str

ssl_server_certificate¶

Gets the ssl_server_certificate of this CreateDb2ConnectionDetails. The base64 encoded file which contains the self-signed server certificate / Certificate Authority (CA) certificate.

Returns:	The ssl_server_certificate of this CreateDb2ConnectionDetails.
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 CreateDb2ConnectionDetails. The DB2 technology type.

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

username¶

[Required] Gets the username of this CreateDb2ConnectionDetails. The username Oracle GoldenGate uses to connect to the DB2 database. This username must already exist and be available by the DB2 to be connected to.

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