UpdateDb2ConnectionDetails¶

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

Bases: oci.golden_gate.models.update_connection_details.UpdateConnectionDetails

The information to update a DB2 Connection.

Attributes

`CONNECTION_TYPE_AI_MODEL`	str(object=’’) -> str
`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_DATABRICKS`	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_GOOGLE_PUBSUB`	str(object=’’) -> str
`CONNECTION_TYPE_HDFS`	str(object=’’) -> str
`CONNECTION_TYPE_ICEBERG`	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_FABRIC`	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_AI_DATA_PLATFORM`	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 UpdateDb2ConnectionDetails.
`connection_type`	Gets the connection_type of this UpdateConnectionDetails.
`database_name`	Gets the database_name of this UpdateDb2ConnectionDetails.
`defined_tags`	Gets the defined_tags of this UpdateConnectionDetails.
`description`	Gets the description of this UpdateConnectionDetails.
`display_name`	Gets the display_name of this UpdateConnectionDetails.
`does_use_secret_ids`	Gets the does_use_secret_ids of this UpdateConnectionDetails.
`freeform_tags`	Gets the freeform_tags of this UpdateConnectionDetails.
`host`	Gets the host of this UpdateDb2ConnectionDetails.
`key_id`	Gets the key_id of this UpdateConnectionDetails.
`nsg_ids`	Gets the nsg_ids of this UpdateConnectionDetails.
`password`	Gets the password of this UpdateDb2ConnectionDetails.
`password_secret_id`	Gets the password_secret_id of this UpdateDb2ConnectionDetails.
`port`	Gets the port of this UpdateDb2ConnectionDetails.
`routing_method`	Gets the routing_method of this UpdateConnectionDetails.
`security_attributes`	Gets the security_attributes of this UpdateConnectionDetails.
`security_protocol`	Gets the security_protocol of this UpdateDb2ConnectionDetails.
`ssl_client_keystash`	Gets the ssl_client_keystash of this UpdateDb2ConnectionDetails.
`ssl_client_keystash_secret_id`	Gets the ssl_client_keystash_secret_id of this UpdateDb2ConnectionDetails.
`ssl_client_keystoredb`	Gets the ssl_client_keystoredb of this UpdateDb2ConnectionDetails.
`ssl_client_keystoredb_secret_id`	Gets the ssl_client_keystoredb_secret_id of this UpdateDb2ConnectionDetails.
`ssl_server_certificate`	Gets the ssl_server_certificate of this UpdateDb2ConnectionDetails.
`subnet_id`	Gets the subnet_id of this UpdateConnectionDetails.
`username`	Gets the username of this UpdateDb2ConnectionDetails.
`vault_id`	Gets the vault_id of this UpdateConnectionDetails.

Methods

`__init__`(**kwargs)	Initializes a new UpdateDb2ConnectionDetails 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_AI_MODEL = 'AI_MODEL'¶

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 UpdateDb2ConnectionDetails 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 UpdateDb2ConnectionDetails. 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”, “AI_MODEL”
display_name (str) – The value to assign to the display_name property of this UpdateDb2ConnectionDetails.
description (str) – The value to assign to the description property of this UpdateDb2ConnectionDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateDb2ConnectionDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateDb2ConnectionDetails.
vault_id (str) – The value to assign to the vault_id property of this UpdateDb2ConnectionDetails.
key_id (str) – The value to assign to the key_id property of this UpdateDb2ConnectionDetails.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this UpdateDb2ConnectionDetails.
subnet_id (str) – The value to assign to the subnet_id property of this UpdateDb2ConnectionDetails.
routing_method (str) – The value to assign to the routing_method property of this UpdateDb2ConnectionDetails. 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 UpdateDb2ConnectionDetails.
security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this UpdateDb2ConnectionDetails.
database_name (str) – The value to assign to the database_name property of this UpdateDb2ConnectionDetails.
host (str) – The value to assign to the host property of this UpdateDb2ConnectionDetails.
port (int) – The value to assign to the port property of this UpdateDb2ConnectionDetails.
username (str) – The value to assign to the username property of this UpdateDb2ConnectionDetails.
password (str) – The value to assign to the password property of this UpdateDb2ConnectionDetails.
password_secret_id (str) – The value to assign to the password_secret_id property of this UpdateDb2ConnectionDetails.
additional_attributes (list[oci.golden_gate.models.NameValuePair]) – The value to assign to the additional_attributes property of this UpdateDb2ConnectionDetails.
security_protocol (str) – The value to assign to the security_protocol property of this UpdateDb2ConnectionDetails.
ssl_client_keystoredb (str) – The value to assign to the ssl_client_keystoredb property of this UpdateDb2ConnectionDetails.
ssl_client_keystoredb_secret_id (str) – The value to assign to the ssl_client_keystoredb_secret_id property of this UpdateDb2ConnectionDetails.
ssl_client_keystash (str) – The value to assign to the ssl_client_keystash property of this UpdateDb2ConnectionDetails.
ssl_client_keystash_secret_id (str) – The value to assign to the ssl_client_keystash_secret_id property of this UpdateDb2ConnectionDetails.
ssl_server_certificate (str) – The value to assign to the ssl_server_certificate property of this UpdateDb2ConnectionDetails.

additional_attributes¶

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

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

connection_type¶

Gets the connection_type of this UpdateConnectionDetails. 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”, “AI_MODEL”

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

database_name¶

Gets the database_name of this UpdateDb2ConnectionDetails. The name of the database.

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

defined_tags¶

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

description¶

Gets the description of this UpdateConnectionDetails. Metadata about this specific object.

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

display_name¶

Gets the display_name of this UpdateConnectionDetails. An object’s Display Name.

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

does_use_secret_ids¶

Gets the does_use_secret_ids of this UpdateConnectionDetails. Indicates that sensitive attributes are provided via Secrets.

Deprecated: This field is deprecated. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example, passwordSecretId) instead of plain-text attributes. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

When set to true, all sensitive information must be provided as OCI Vault secrets using the corresponding *SecretId attributes of the connection (for example, passwordSecretId). Plain-text sensitive attributes (for example, password) must not be used. This ensures that sensitive information remains stored and managed in the customer’s OCI Vault rather than by the GoldenGate service.

When set to false, sensitive information must be provided in the corresponding plain-text attributes (for example, password) rather than in secret OCID attributes. In this mode, the sensitive information is stored by the GoldenGate service. If vaultId and keyId are not specified, the GoldenGate service uses Oracle-managed encryption keys to encrypt the stored data.

If vaultId and keyId are provided, the specified customer-managed key is used.

Returns:	The does_use_secret_ids of this UpdateConnectionDetails.
Return type:	bool

freeform_tags¶

Gets the freeform_tags of this UpdateConnectionDetails. 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 UpdateConnectionDetails.
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 UpdateDb2ConnectionDetails. The name or address of a host.

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

key_id¶

Gets the key_id of this UpdateConnectionDetails. References the OCI Vault key in the OCI Vault identified by vaultId.

Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example, passwordSecretId) instead of plain-text attributes encrypted with vaultId and keyId. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

The GoldenGate service uses this key to encrypt sensitive information (for example, password) that is provided in plain-text connection attributes through the API. This field is applicable only when doesUseSecretIds is set to false. If both vaultId and keyId are provided, the GoldenGate service uses the specified customer-managed key to encrypt the sensitive data. If neither vaultId nor keyId is provided, the GoldenGate service uses Oracle-managed encryption keys.

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

nsg_ids¶

Gets the nsg_ids of this UpdateConnectionDetails. An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

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

password¶

Gets the password of this UpdateDb2ConnectionDetails. The password Oracle GoldenGate uses to connect the associated DB2 database. Deprecated: This field is deprecated and replaced by “passwordSecretId”. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

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

password_secret_id¶

Gets the password_secret_id of this UpdateDb2ConnectionDetails. 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 UpdateDb2ConnectionDetails.
Return type:	str

port¶

Gets the port of this UpdateDb2ConnectionDetails. The port of an endpoint usually specified for a connection.

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

routing_method¶

Gets the routing_method of this UpdateConnectionDetails. Controls the network traffic direction to the target: 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. SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service’s network to public hosts. Cannot be used for private targets.

Deprecated: SHARED_SERVICE_ENDPOINT is deprecated. Use another supported routingMethod value, or update existing connections to use a supported routing method. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

Allowed values for this property are: “SHARED_SERVICE_ENDPOINT”, “SHARED_DEPLOYMENT_ENDPOINT”, “DEDICATED_ENDPOINT”

Returns:	The routing_method of this UpdateConnectionDetails.
Return type:	str

security_attributes¶

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

security_protocol¶

Gets the security_protocol of this UpdateDb2ConnectionDetails. Security protocol for the DB2 database.

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

ssl_client_keystash¶

Gets the ssl_client_keystash of this UpdateDb2ConnectionDetails. The base64 encoded keystash file which contains the encrypted password to the key database file. This property is not supported for IBM Db2 for i, as client TLS mode is not available.

Deprecated: This field is deprecated and replaced by “sslClientKeystashSecretId”. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

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

ssl_client_keystash_secret_id¶

Gets the ssl_client_keystash_secret_id of this UpdateDb2ConnectionDetails. The OCID of the Secret where the keystash file is stored, which contains the encrypted password to the key database file. This property is not supported for IBM Db2 for i, as client TLS mode is not available.

Note: When provided, ‘sslClientKeystash’ field must not be provided.

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

ssl_client_keystoredb¶

Gets the ssl_client_keystoredb of this UpdateDb2ConnectionDetails. The base64 encoded keystore file created at the client containing the server certificate / CA root certificate. This property is not supported for IBM Db2 for i, as client TLS mode is not available.

Deprecated: This field is deprecated and replaced by “sslClientKeystoredbSecretId”. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

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

ssl_client_keystoredb_secret_id¶

Gets the ssl_client_keystoredb_secret_id of this UpdateDb2ConnectionDetails. The OCID of the Secret where the keystore file stored, which created at the client containing the server certificate / CA root certificate. This property is not supported for IBM Db2 for i, as client TLS mode is not available.

Note: When provided, ‘sslClientKeystoredb’ field must not be provided.

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

ssl_server_certificate¶

Gets the ssl_server_certificate of this UpdateDb2ConnectionDetails. The base64 encoded file which contains the self-signed server certificate / Certificate Authority (CA) certificate. It is not included in GET responses if the view=COMPACT query parameter is specified.

Returns:	The ssl_server_certificate of this UpdateDb2ConnectionDetails.
Return type:	str

subnet_id¶

Gets the subnet_id of this UpdateConnectionDetails. The OCID of the target subnet of the dedicated connection.

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

username¶

Gets the username of this UpdateDb2ConnectionDetails. 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 UpdateDb2ConnectionDetails.
Return type:	str

vault_id¶

Gets the vault_id of this UpdateConnectionDetails. References the OCI Vault that contains the customer-managed encryption key identified by keyId.

Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example, passwordSecretId) instead of plain-text attributes encrypted with vaultId and keyId. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

This field is applicable only when doesUseSecretIds is set to false. If vaultId is provided, keyId must also be provided.

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