CreateKafkaSchemaRegistryConnectionDetails

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

Bases: CreateConnectionDetails

The information about a new Kafka (e.g. Confluent) Schema Registry Connection.

Attributes:

CONNECTION_TYPE_AI_MODEL

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

CONNECTION_TYPE_AI_PROVIDER

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

CONNECTION_TYPE_AMAZON_KINESIS

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

CONNECTION_TYPE_AMAZON_REDSHIFT

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

CONNECTION_TYPE_AMAZON_S3

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

CONNECTION_TYPE_AZURE_DATA_LAKE_STORAGE

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

CONNECTION_TYPE_AZURE_SYNAPSE_ANALYTICS

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

CONNECTION_TYPE_DATABRICKS

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

CONNECTION_TYPE_DATABRICKS_ENGINE

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

CONNECTION_TYPE_DB2

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

CONNECTION_TYPE_ELASTICSEARCH

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

CONNECTION_TYPE_GENERIC

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

CONNECTION_TYPE_GOLDENGATE

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

CONNECTION_TYPE_GOOGLE_BIGQUERY

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

CONNECTION_TYPE_GOOGLE_CLOUD_STORAGE

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

CONNECTION_TYPE_GOOGLE_PUBSUB

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

CONNECTION_TYPE_HDFS

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

CONNECTION_TYPE_ICEBERG

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

CONNECTION_TYPE_JAVA_MESSAGE_SERVICE

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

CONNECTION_TYPE_KAFKA

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

CONNECTION_TYPE_KAFKA_SCHEMA_REGISTRY

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

CONNECTION_TYPE_MICROSOFT_FABRIC

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

CONNECTION_TYPE_MICROSOFT_SQLSERVER

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

CONNECTION_TYPE_MONGODB

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

CONNECTION_TYPE_MYSQL

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

CONNECTION_TYPE_OCI_OBJECT_STORAGE

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

CONNECTION_TYPE_ORACLE

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

CONNECTION_TYPE_ORACLE_AI_DATA_PLATFORM

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

CONNECTION_TYPE_ORACLE_AI_DATA_PLATFORM_ENGINE

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

CONNECTION_TYPE_ORACLE_NOSQL

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

CONNECTION_TYPE_POSTGRESQL

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

CONNECTION_TYPE_REDIS

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

CONNECTION_TYPE_SNOWFLAKE

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

CONNECTION_TYPE_SPARK

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

ROUTING_METHOD_DEDICATED_ENDPOINT

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

ROUTING_METHOD_SHARED_DEPLOYMENT_ENDPOINT

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

ROUTING_METHOD_SHARED_SERVICE_ENDPOINT

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

authentication_type

[Required] Gets the authentication_type of this CreateKafkaSchemaRegistryConnectionDetails.

cluster_placement_group_id

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

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.

key_id

Gets the key_id of this CreateConnectionDetails.

key_store

Gets the key_store of this CreateKafkaSchemaRegistryConnectionDetails.

key_store_password

Gets the key_store_password of this CreateKafkaSchemaRegistryConnectionDetails.

key_store_password_secret_id

Gets the key_store_password_secret_id of this CreateKafkaSchemaRegistryConnectionDetails.

key_store_secret_id

Gets the key_store_secret_id of this CreateKafkaSchemaRegistryConnectionDetails.

locks

Gets the locks of this CreateConnectionDetails.

nsg_ids

Gets the nsg_ids of this CreateConnectionDetails.

password

Gets the password of this CreateKafkaSchemaRegistryConnectionDetails.

password_secret_id

Gets the password_secret_id of this CreateKafkaSchemaRegistryConnectionDetails.

routing_method

Gets the routing_method of this CreateConnectionDetails.

security_attributes

Gets the security_attributes of this CreateConnectionDetails.

ssl_key_password

Gets the ssl_key_password of this CreateKafkaSchemaRegistryConnectionDetails.

ssl_key_password_secret_id

Gets the ssl_key_password_secret_id of this CreateKafkaSchemaRegistryConnectionDetails.

subnet_id

Gets the subnet_id of this CreateConnectionDetails.

subscription_id

Gets the subscription_id of this CreateConnectionDetails.

technology_type

[Required] Gets the technology_type of this CreateKafkaSchemaRegistryConnectionDetails.

trust_store

Gets the trust_store of this CreateKafkaSchemaRegistryConnectionDetails.

trust_store_password

Gets the trust_store_password of this CreateKafkaSchemaRegistryConnectionDetails.

trust_store_password_secret_id

Gets the trust_store_password_secret_id of this CreateKafkaSchemaRegistryConnectionDetails.

trust_store_secret_id

Gets the trust_store_secret_id of this CreateKafkaSchemaRegistryConnectionDetails.

url

[Required] Gets the url of this CreateKafkaSchemaRegistryConnectionDetails.

username

Gets the username of this CreateKafkaSchemaRegistryConnectionDetails.

vault_id

Gets the vault_id of this CreateConnectionDetails.

Methods:

__init__(**kwargs)

Initializes a new CreateKafkaSchemaRegistryConnectionDetails 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 CreateConnectionDetails. 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 CreateConnectionDetails. 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 CreateConnectionDetails. 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 CreateConnectionDetails. 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 CreateConnectionDetails. 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 CreateConnectionDetails. 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 CreateConnectionDetails. 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 CreateConnectionDetails. 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 CreateConnectionDetails. 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 CreateConnectionDetails. This constant has a value of “DB2”

CONNECTION_TYPE_ELASTICSEARCH = 'ELASTICSEARCH'

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

CONNECTION_TYPE_GENERIC = 'GENERIC'

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

CONNECTION_TYPE_GOLDENGATE = 'GOLDENGATE'

A constant which can be used with the connection_type property of a CreateConnectionDetails. 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 CreateConnectionDetails. 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 CreateConnectionDetails. 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 CreateConnectionDetails. 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 CreateConnectionDetails. This constant has a value of “HDFS”

CONNECTION_TYPE_ICEBERG = 'ICEBERG'

A constant which can be used with the connection_type property of a CreateConnectionDetails. 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 CreateConnectionDetails. 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 CreateConnectionDetails. 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 CreateConnectionDetails. 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 CreateConnectionDetails. 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 CreateConnectionDetails. 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 CreateConnectionDetails. This constant has a value of “MONGODB”

CONNECTION_TYPE_MYSQL = 'MYSQL'

A constant which can be used with the connection_type property of a CreateConnectionDetails. 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 CreateConnectionDetails. 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 CreateConnectionDetails. 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 CreateConnectionDetails. 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 CreateConnectionDetails. 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 CreateConnectionDetails. 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 CreateConnectionDetails. This constant has a value of “POSTGRESQL”

CONNECTION_TYPE_REDIS = 'REDIS'

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

CONNECTION_TYPE_SNOWFLAKE = 'SNOWFLAKE'

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

CONNECTION_TYPE_SPARK = 'SPARK'

A constant which can be used with the connection_type property of a CreateConnectionDetails. 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 CreateConnectionDetails. 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 CreateConnectionDetails. 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 CreateConnectionDetails. This constant has a value of “SHARED_SERVICE_ENDPOINT”

__init__(**kwargs)

Initializes a new CreateKafkaSchemaRegistryConnectionDetails object with values from keyword arguments. The default value of the connection_type attribute of this class is KAFKA_SCHEMA_REGISTRY 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 CreateKafkaSchemaRegistryConnectionDetails. 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 CreateKafkaSchemaRegistryConnectionDetails.

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

  • compartment_id (str) – The value to assign to the compartment_id property of this CreateKafkaSchemaRegistryConnectionDetails.

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

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

  • locks (list[oci.golden_gate.models.AddResourceLockDetails]) – The value to assign to the locks property of this CreateKafkaSchemaRegistryConnectionDetails.

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

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

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

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

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

  • subscription_id (str) – The value to assign to the subscription_id property of this CreateKafkaSchemaRegistryConnectionDetails.

  • cluster_placement_group_id (str) – The value to assign to the cluster_placement_group_id property of this CreateKafkaSchemaRegistryConnectionDetails.

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

  • technology_type (str) – The value to assign to the technology_type property of this CreateKafkaSchemaRegistryConnectionDetails.

  • url (str) – The value to assign to the url property of this CreateKafkaSchemaRegistryConnectionDetails.

  • authentication_type (str) – The value to assign to the authentication_type property of this CreateKafkaSchemaRegistryConnectionDetails.

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

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

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

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

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

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

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

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

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

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

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

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

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

property authentication_type

[Required] Gets the authentication_type of this CreateKafkaSchemaRegistryConnectionDetails. Used authentication mechanism to access Schema Registry.

Returns

The authentication_type of this CreateKafkaSchemaRegistryConnectionDetails.

Return type

str

property 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

property 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

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

Return type

str

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

property description

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

Returns

The description of this CreateConnectionDetails.

Return type

str

property 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

property does_use_secret_ids

Gets the does_use_secret_ids of this CreateConnectionDetails. 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 CreateConnectionDetails.

Return type

bool

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

property key_id

Gets the key_id of this CreateConnectionDetails. 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 CreateConnectionDetails.

Return type

str

property key_store

Gets the key_store of this CreateKafkaSchemaRegistryConnectionDetails. 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 CreateKafkaSchemaRegistryConnectionDetails.

Return type

str

property key_store_password

Gets the key_store_password of this CreateKafkaSchemaRegistryConnectionDetails. 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 CreateKafkaSchemaRegistryConnectionDetails.

Return type

str

property key_store_password_secret_id

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

Returns

The key_store_password_secret_id of this CreateKafkaSchemaRegistryConnectionDetails.

Return type

str

property key_store_secret_id

Gets the key_store_secret_id of this CreateKafkaSchemaRegistryConnectionDetails. The OCID of the Secret that stores the content of the KeyStore file. Note: When provided, ‘keyStore’ field must not be provided.

Returns

The key_store_secret_id of this CreateKafkaSchemaRegistryConnectionDetails.

Return type

str

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

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

property password

Gets the password of this CreateKafkaSchemaRegistryConnectionDetails. The password to access Schema Registry using basic authentication. This value is injected into ‘schema.registry.basic.auth.user.info=user:password’ configuration property. 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 CreateKafkaSchemaRegistryConnectionDetails.

Return type

str

property password_secret_id

Gets the password_secret_id of this CreateKafkaSchemaRegistryConnectionDetails. The OCID of the Secret where the Kafka Schema Registry password is stored, The password to access Schema Registry using basic authentication. This value is injected into ‘schema.registry.basic.auth.user.info=user:password’ configuration property. Note: When provided, ‘password’ field must not be provided.

Returns

The password_secret_id of this CreateKafkaSchemaRegistryConnectionDetails.

Return type

str

property routing_method

Gets the routing_method of this CreateConnectionDetails. 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 CreateConnectionDetails.

Return type

str

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

property ssl_key_password

Gets the ssl_key_password of this CreateKafkaSchemaRegistryConnectionDetails. The password for the cert inside 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 CreateKafkaSchemaRegistryConnectionDetails.

Return type

str

property ssl_key_password_secret_id

Gets the ssl_key_password_secret_id of this CreateKafkaSchemaRegistryConnectionDetails. The OCID of the Secret that stores the password for the cert inside the KeyStore. In case it differs from the KeyStore password, it should be provided. Note: When provided, ‘sslKeyPassword’ field must not be provided.

Returns

The ssl_key_password_secret_id of this CreateKafkaSchemaRegistryConnectionDetails.

Return type

str

property 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

property 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

property technology_type

[Required] Gets the technology_type of this CreateKafkaSchemaRegistryConnectionDetails. The Kafka (e.g. Confluent) Schema Registry technology type.

Returns

The technology_type of this CreateKafkaSchemaRegistryConnectionDetails.

Return type

str

property trust_store

Gets the trust_store of this CreateKafkaSchemaRegistryConnectionDetails. 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 CreateKafkaSchemaRegistryConnectionDetails.

Return type

str

property trust_store_password

Gets the trust_store_password of this CreateKafkaSchemaRegistryConnectionDetails. 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 CreateKafkaSchemaRegistryConnectionDetails.

Return type

str

property trust_store_password_secret_id

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

Returns

The trust_store_password_secret_id of this CreateKafkaSchemaRegistryConnectionDetails.

Return type

str

property trust_store_secret_id

Gets the trust_store_secret_id of this CreateKafkaSchemaRegistryConnectionDetails. The OCID of the Secret that stores the content of the TrustStore file. Note: When provided, ‘trustStore’ field must not be provided.

Returns

The trust_store_secret_id of this CreateKafkaSchemaRegistryConnectionDetails.

Return type

str

property url

[Required] Gets the url of this CreateKafkaSchemaRegistryConnectionDetails. Kafka Schema Registry URL. e.g.: ‘https://server1.us.oracle.com:8081’

Returns

The url of this CreateKafkaSchemaRegistryConnectionDetails.

Return type

str

property username

Gets the username of this CreateKafkaSchemaRegistryConnectionDetails. The username to access Schema Registry using basic authentication. This value is injected into ‘schema.registry.basic.auth.user.info=user:password’ configuration property.

Returns

The username of this CreateKafkaSchemaRegistryConnectionDetails.

Return type

str

property vault_id

Gets the vault_id of this CreateConnectionDetails. 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 CreateConnectionDetails.

Return type

str