UpdateKafkaConnectionDetails

class oci.golden_gate.models.UpdateKafkaConnectionDetails(**kwargs)

Bases: UpdateConnectionDetails

The information to update a Kafka Connection.

Attributes:

CONNECTION_TYPE_AI_MODEL

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_AI_PROVIDER

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_AMAZON_KINESIS

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_AMAZON_REDSHIFT

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_AMAZON_S3

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_AZURE_DATA_LAKE_STORAGE

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_AZURE_SYNAPSE_ANALYTICS

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_DATABRICKS

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_DATABRICKS_ENGINE

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_DB2

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_ELASTICSEARCH

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_GENERIC

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_GOLDENGATE

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_GOOGLE_BIGQUERY

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_GOOGLE_CLOUD_STORAGE

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_GOOGLE_PUBSUB

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_HDFS

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_ICEBERG

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_JAVA_MESSAGE_SERVICE

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_KAFKA

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_KAFKA_SCHEMA_REGISTRY

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_MICROSOFT_FABRIC

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_MICROSOFT_SQLSERVER

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_MONGODB

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_MYSQL

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_OCI_OBJECT_STORAGE

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_ORACLE

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_ORACLE_AI_DATA_PLATFORM

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_ORACLE_AI_DATA_PLATFORM_ENGINE

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_ORACLE_NOSQL

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_POSTGRESQL

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_REDIS

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_SNOWFLAKE

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

CONNECTION_TYPE_SPARK

A constant which can be used with the connection_type property of a UpdateConnectionDetails.

ROUTING_METHOD_DEDICATED_ENDPOINT

A constant which can be used with the routing_method property of a UpdateConnectionDetails.

ROUTING_METHOD_SHARED_DEPLOYMENT_ENDPOINT

A constant which can be used with the routing_method property of a UpdateConnectionDetails.

ROUTING_METHOD_SHARED_SERVICE_ENDPOINT

A constant which can be used with the routing_method property of a UpdateConnectionDetails.

bootstrap_servers

Gets the bootstrap_servers of this UpdateKafkaConnectionDetails.

cluster_id

Gets the cluster_id of this UpdateKafkaConnectionDetails.

connection_type

Gets the connection_type of this UpdateConnectionDetails.

consumer_properties

Gets the consumer_properties of this UpdateKafkaConnectionDetails.

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.

key_id

Gets the key_id of this UpdateConnectionDetails.

key_store

Gets the key_store of this UpdateKafkaConnectionDetails.

key_store_password

Gets the key_store_password of this UpdateKafkaConnectionDetails.

key_store_password_secret_id

Gets the key_store_password_secret_id of this UpdateKafkaConnectionDetails.

key_store_secret_id

Gets the key_store_secret_id of this UpdateKafkaConnectionDetails.

nsg_ids

Gets the nsg_ids of this UpdateConnectionDetails.

password

Gets the password of this UpdateKafkaConnectionDetails.

password_secret_id

Gets the password_secret_id of this UpdateKafkaConnectionDetails.

producer_properties

Gets the producer_properties of this UpdateKafkaConnectionDetails.

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 UpdateKafkaConnectionDetails.

should_use_resource_principal

Gets the should_use_resource_principal of this UpdateKafkaConnectionDetails.

ssl_key_password

Gets the ssl_key_password of this UpdateKafkaConnectionDetails.

ssl_key_password_secret_id

Gets the ssl_key_password_secret_id of this UpdateKafkaConnectionDetails.

stream_pool_id

Gets the stream_pool_id of this UpdateKafkaConnectionDetails.

subnet_id

Gets the subnet_id of this UpdateConnectionDetails.

trust_store

Gets the trust_store of this UpdateKafkaConnectionDetails.

trust_store_password

Gets the trust_store_password of this UpdateKafkaConnectionDetails.

trust_store_password_secret_id

Gets the trust_store_password_secret_id of this UpdateKafkaConnectionDetails.

trust_store_secret_id

Gets the trust_store_secret_id of this UpdateKafkaConnectionDetails.

username

Gets the username of this UpdateKafkaConnectionDetails.

vault_id

Gets the vault_id of this UpdateConnectionDetails.

Methods:

__init__(**kwargs)

Initializes a new UpdateKafkaConnectionDetails 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'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “AI_MODEL”

CONNECTION_TYPE_AI_PROVIDER = 'AI_PROVIDER'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “AI_PROVIDER”

CONNECTION_TYPE_AMAZON_KINESIS = 'AMAZON_KINESIS'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “AMAZON_KINESIS”

CONNECTION_TYPE_AMAZON_REDSHIFT = 'AMAZON_REDSHIFT'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “AMAZON_REDSHIFT”

CONNECTION_TYPE_AMAZON_S3 = 'AMAZON_S3'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “AMAZON_S3”

CONNECTION_TYPE_AZURE_DATA_LAKE_STORAGE = 'AZURE_DATA_LAKE_STORAGE'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “AZURE_DATA_LAKE_STORAGE”

CONNECTION_TYPE_AZURE_SYNAPSE_ANALYTICS = 'AZURE_SYNAPSE_ANALYTICS'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “AZURE_SYNAPSE_ANALYTICS”

CONNECTION_TYPE_DATABRICKS = 'DATABRICKS'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “DATABRICKS”

CONNECTION_TYPE_DATABRICKS_ENGINE = 'DATABRICKS_ENGINE'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “DATABRICKS_ENGINE”

CONNECTION_TYPE_DB2 = 'DB2'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “DB2”

CONNECTION_TYPE_ELASTICSEARCH = 'ELASTICSEARCH'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “ELASTICSEARCH”

CONNECTION_TYPE_GENERIC = 'GENERIC'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “GENERIC”

CONNECTION_TYPE_GOLDENGATE = 'GOLDENGATE'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “GOLDENGATE”

CONNECTION_TYPE_GOOGLE_BIGQUERY = 'GOOGLE_BIGQUERY'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “GOOGLE_BIGQUERY”

CONNECTION_TYPE_GOOGLE_CLOUD_STORAGE = 'GOOGLE_CLOUD_STORAGE'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “GOOGLE_CLOUD_STORAGE”

CONNECTION_TYPE_GOOGLE_PUBSUB = 'GOOGLE_PUBSUB'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “GOOGLE_PUBSUB”

CONNECTION_TYPE_HDFS = 'HDFS'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “HDFS”

CONNECTION_TYPE_ICEBERG = 'ICEBERG'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “ICEBERG”

CONNECTION_TYPE_JAVA_MESSAGE_SERVICE = 'JAVA_MESSAGE_SERVICE'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “JAVA_MESSAGE_SERVICE”

CONNECTION_TYPE_KAFKA = 'KAFKA'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “KAFKA”

CONNECTION_TYPE_KAFKA_SCHEMA_REGISTRY = 'KAFKA_SCHEMA_REGISTRY'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “KAFKA_SCHEMA_REGISTRY”

CONNECTION_TYPE_MICROSOFT_FABRIC = 'MICROSOFT_FABRIC'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “MICROSOFT_FABRIC”

CONNECTION_TYPE_MICROSOFT_SQLSERVER = 'MICROSOFT_SQLSERVER'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “MICROSOFT_SQLSERVER”

CONNECTION_TYPE_MONGODB = 'MONGODB'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “MONGODB”

CONNECTION_TYPE_MYSQL = 'MYSQL'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “MYSQL”

CONNECTION_TYPE_OCI_OBJECT_STORAGE = 'OCI_OBJECT_STORAGE'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “OCI_OBJECT_STORAGE”

CONNECTION_TYPE_ORACLE = 'ORACLE'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “ORACLE”

CONNECTION_TYPE_ORACLE_AI_DATA_PLATFORM = 'ORACLE_AI_DATA_PLATFORM'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “ORACLE_AI_DATA_PLATFORM”

CONNECTION_TYPE_ORACLE_AI_DATA_PLATFORM_ENGINE = 'ORACLE_AI_DATA_PLATFORM_ENGINE'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “ORACLE_AI_DATA_PLATFORM_ENGINE”

CONNECTION_TYPE_ORACLE_NOSQL = 'ORACLE_NOSQL'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “ORACLE_NOSQL”

CONNECTION_TYPE_POSTGRESQL = 'POSTGRESQL'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “POSTGRESQL”

CONNECTION_TYPE_REDIS = 'REDIS'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “REDIS”

CONNECTION_TYPE_SNOWFLAKE = 'SNOWFLAKE'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “SNOWFLAKE”

CONNECTION_TYPE_SPARK = 'SPARK'

A constant which can be used with the connection_type property of a UpdateConnectionDetails. This constant has a value of “SPARK”

ROUTING_METHOD_DEDICATED_ENDPOINT = 'DEDICATED_ENDPOINT'

A constant which can be used with the routing_method property of a UpdateConnectionDetails. This constant has a value of “DEDICATED_ENDPOINT”

ROUTING_METHOD_SHARED_DEPLOYMENT_ENDPOINT = 'SHARED_DEPLOYMENT_ENDPOINT'

A constant which can be used with the routing_method property of a UpdateConnectionDetails. This constant has a value of “SHARED_DEPLOYMENT_ENDPOINT”

ROUTING_METHOD_SHARED_SERVICE_ENDPOINT = 'SHARED_SERVICE_ENDPOINT'

A constant which can be used with the routing_method property of a UpdateConnectionDetails. This constant has a value of “SHARED_SERVICE_ENDPOINT”

__init__(**kwargs)

Initializes a new UpdateKafkaConnectionDetails object with values from keyword arguments. The default value of the connection_type attribute of this class is KAFKA 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 UpdateKafkaConnectionDetails. 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_AI_DATA_PLATFORM_ENGINE”, “ORACLE_NOSQL”, “MONGODB”, “AMAZON_KINESIS”, “AMAZON_REDSHIFT”, “DB2”, “REDIS”, “ELASTICSEARCH”, “GENERIC”, “GOOGLE_CLOUD_STORAGE”, “GOOGLE_BIGQUERY”, “DATABRICKS”, “DATABRICKS_ENGINE”, “GOOGLE_PUBSUB”, “MICROSOFT_FABRIC”, “SPARK”, “ICEBERG”, “AI_PROVIDER”, “AI_MODEL”

  • display_name (str) – The value to assign to the display_name property of this UpdateKafkaConnectionDetails.

  • description (str) – The value to assign to the description property of this UpdateKafkaConnectionDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateKafkaConnectionDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateKafkaConnectionDetails.

  • vault_id (str) – The value to assign to the vault_id property of this UpdateKafkaConnectionDetails.

  • key_id (str) – The value to assign to the key_id property of this UpdateKafkaConnectionDetails.

  • nsg_ids (list[str]) – The value to assign to the nsg_ids property of this UpdateKafkaConnectionDetails.

  • subnet_id (str) – The value to assign to the subnet_id property of this UpdateKafkaConnectionDetails.

  • routing_method (str) – The value to assign to the routing_method property of this UpdateKafkaConnectionDetails. 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 UpdateKafkaConnectionDetails.

  • security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this UpdateKafkaConnectionDetails.

  • stream_pool_id (str) – The value to assign to the stream_pool_id property of this UpdateKafkaConnectionDetails.

  • cluster_id (str) – The value to assign to the cluster_id property of this UpdateKafkaConnectionDetails.

  • bootstrap_servers (list[oci.golden_gate.models.KafkaBootstrapServer]) – The value to assign to the bootstrap_servers property of this UpdateKafkaConnectionDetails.

  • security_protocol (str) – The value to assign to the security_protocol property of this UpdateKafkaConnectionDetails.

  • username (str) – The value to assign to the username property of this UpdateKafkaConnectionDetails.

  • password (str) – The value to assign to the password property of this UpdateKafkaConnectionDetails.

  • password_secret_id (str) – The value to assign to the password_secret_id property of this UpdateKafkaConnectionDetails.

  • trust_store (str) – The value to assign to the trust_store property of this UpdateKafkaConnectionDetails.

  • trust_store_secret_id (str) – The value to assign to the trust_store_secret_id property of this UpdateKafkaConnectionDetails.

  • trust_store_password (str) – The value to assign to the trust_store_password property of this UpdateKafkaConnectionDetails.

  • trust_store_password_secret_id (str) – The value to assign to the trust_store_password_secret_id property of this UpdateKafkaConnectionDetails.

  • key_store (str) – The value to assign to the key_store property of this UpdateKafkaConnectionDetails.

  • key_store_secret_id (str) – The value to assign to the key_store_secret_id property of this UpdateKafkaConnectionDetails.

  • key_store_password (str) – The value to assign to the key_store_password property of this UpdateKafkaConnectionDetails.

  • key_store_password_secret_id (str) – The value to assign to the key_store_password_secret_id property of this UpdateKafkaConnectionDetails.

  • ssl_key_password (str) – The value to assign to the ssl_key_password property of this UpdateKafkaConnectionDetails.

  • ssl_key_password_secret_id (str) – The value to assign to the ssl_key_password_secret_id property of this UpdateKafkaConnectionDetails.

  • consumer_properties (str) – The value to assign to the consumer_properties property of this UpdateKafkaConnectionDetails.

  • producer_properties (str) – The value to assign to the producer_properties property of this UpdateKafkaConnectionDetails.

  • should_use_resource_principal (bool) – The value to assign to the should_use_resource_principal property of this UpdateKafkaConnectionDetails.

property bootstrap_servers

Gets the bootstrap_servers of this UpdateKafkaConnectionDetails. Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka: list of KafkaBootstrapServer objects specified by host/port. Used for establishing the initial connection to the Kafka cluster. Example: “server1.example.com:9092,server2.example.com:9092”

Returns

The bootstrap_servers of this UpdateKafkaConnectionDetails.

Return type

list[oci.golden_gate.models.KafkaBootstrapServer]

property cluster_id

Gets the cluster_id of this UpdateKafkaConnectionDetails. The OCID of the Kafka cluster being referenced from OCI Streaming with Apache Kafka.

Returns

The cluster_id of this UpdateKafkaConnectionDetails.

Return type

str

property 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_AI_DATA_PLATFORM_ENGINE”, “ORACLE_NOSQL”, “MONGODB”, “AMAZON_KINESIS”, “AMAZON_REDSHIFT”, “DB2”, “REDIS”, “ELASTICSEARCH”, “GENERIC”, “GOOGLE_CLOUD_STORAGE”, “GOOGLE_BIGQUERY”, “DATABRICKS”, “DATABRICKS_ENGINE”, “GOOGLE_PUBSUB”, “MICROSOFT_FABRIC”, “SPARK”, “ICEBERG”, “AI_PROVIDER”, “AI_MODEL”

Returns

The connection_type of this UpdateConnectionDetails.

Return type

str

property consumer_properties

Gets the consumer_properties of this UpdateKafkaConnectionDetails. The base64 encoded content of the consumer.properties file.

Returns

The consumer_properties of this UpdateKafkaConnectionDetails.

Return type

str

property 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))

property description

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

Returns

The description of this UpdateConnectionDetails.

Return type

str

property display_name

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

Returns

The display_name of this UpdateConnectionDetails.

Return type

str

property 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

property 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.

property 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

property key_store

Gets the key_store of this UpdateKafkaConnectionDetails. The base64 encoded content of the KeyStore file. Deprecated: This field is deprecated and replaced by “keyStoreSecretId”. 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 key_store of this UpdateKafkaConnectionDetails.

Return type

str

property key_store_password

Gets the key_store_password of this UpdateKafkaConnectionDetails. The KeyStore password. Deprecated: This field is deprecated and replaced by “keyStorePasswordSecretId”. 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 key_store_password of this UpdateKafkaConnectionDetails.

Return type

str

property key_store_password_secret_id

Gets the key_store_password_secret_id of this UpdateKafkaConnectionDetails. The OCID of the Secret where the kafka KeyStore password is stored. Note: When provided, ‘keyStorePassword’ field must not be provided.

Returns

The key_store_password_secret_id of this UpdateKafkaConnectionDetails.

Return type

str

property key_store_secret_id

Gets the key_store_secret_id of this UpdateKafkaConnectionDetails. The OCID of the Secret where the content of the KeyStore file is stored. Note: When provided, ‘keyStore’ field must not be provided.

Returns

The key_store_secret_id of this UpdateKafkaConnectionDetails.

Return type

str

property 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]

property password

Gets the password of this UpdateKafkaConnectionDetails. 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 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 UpdateKafkaConnectionDetails.

Return type

str

property password_secret_id

Gets the password_secret_id of this UpdateKafkaConnectionDetails. 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 UpdateKafkaConnectionDetails.

Return type

str

property producer_properties

Gets the producer_properties of this UpdateKafkaConnectionDetails. The base64 encoded content of the producer.properties file.

Returns

The producer_properties of this UpdateKafkaConnectionDetails.

Return type

str

property 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

property 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))

property security_protocol

Gets the security_protocol of this UpdateKafkaConnectionDetails. Security Type for Kafka.

Returns

The security_protocol of this UpdateKafkaConnectionDetails.

Return type

str

property should_use_resource_principal

Gets the should_use_resource_principal of this UpdateKafkaConnectionDetails. Specifies that the user intends to authenticate to the instance using a resource principal. Applicable only for OCI Streaming connections. Only available from 23.9.0.0.0 GoldenGate versions. Note: When specified, ‘username’/’password’/’passwordSecretId’ fields must not be provided. Default: false

Returns

The should_use_resource_principal of this UpdateKafkaConnectionDetails.

Return type

bool

property ssl_key_password

Gets the ssl_key_password of this UpdateKafkaConnectionDetails. The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided. Deprecated: This field is deprecated and replaced by “sslKeyPasswordSecretId”. 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_key_password of this UpdateKafkaConnectionDetails.

Return type

str

property ssl_key_password_secret_id

Gets the ssl_key_password_secret_id of this UpdateKafkaConnectionDetails. The OCID of the Secret where the kafka Ssl Key password is stored. Note: When provided, ‘sslKeyPassword’ field must not be provided.

Returns

The ssl_key_password_secret_id of this UpdateKafkaConnectionDetails.

Return type

str

property stream_pool_id

Gets the stream_pool_id of this UpdateKafkaConnectionDetails. The OCID of the stream pool being referenced.

Returns

The stream_pool_id of this UpdateKafkaConnectionDetails.

Return type

str

property 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

property trust_store

Gets the trust_store of this UpdateKafkaConnectionDetails. The base64 encoded content of the TrustStore file. Deprecated: This field is deprecated and replaced by “trustStoreSecretId”. 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 trust_store of this UpdateKafkaConnectionDetails.

Return type

str

property trust_store_password

Gets the trust_store_password of this UpdateKafkaConnectionDetails. The TrustStore password. Deprecated: This field is deprecated and replaced by “trustStorePasswordSecretId”. 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 trust_store_password of this UpdateKafkaConnectionDetails.

Return type

str

property trust_store_password_secret_id

Gets the trust_store_password_secret_id of this UpdateKafkaConnectionDetails. The OCID of the Secret where the kafka TrustStore password is stored. Note: When provided, ‘trustStorePassword’ field must not be provided.

Returns

The trust_store_password_secret_id of this UpdateKafkaConnectionDetails.

Return type

str

property trust_store_secret_id

Gets the trust_store_secret_id of this UpdateKafkaConnectionDetails. The OCID of the Secret where the content of the TrustStore file is stored. Note: When provided, ‘trustStore’ field must not be provided.

Returns

The trust_store_secret_id of this UpdateKafkaConnectionDetails.

Return type

str

property username

Gets the username of this UpdateKafkaConnectionDetails. 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 UpdateKafkaConnectionDetails.

Return type

str

property 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