Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateKafkaConnectionDetails

The information about a new Kafka Connection.

Properties

Optional bootstrapServers

bootstrapServers: Array<KafkaBootstrapServer>

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: {@code "server1.example.com:9092,server2.example.com:9092"}

Optional clusterId

clusterId: undefined | string

The OCID of the Kafka cluster being referenced from OCI Streaming with Apache Kafka.

Optional clusterPlacementGroupId

clusterPlacementGroupId: undefined | string

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.

compartmentId

compartmentId: string

The OCID of the compartment being referenced.

Const connectionType

connectionType: string = "KAFKA"

Optional consumerProperties

consumerProperties: undefined | string

The base64 encoded content of the consumer.properties file.

Optional definedTags

definedTags: undefined | object

Tags defined for this resource. Each key is predefined and scoped to a namespace.

Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}}

Optional description

description: undefined | string

Metadata about this specific object.

displayName

displayName: string

An object's Display Name.

Optional doesUseSecretIds

doesUseSecretIds: undefined | false | true

Indicates that sensitive attributes are provided via Secrets.

Optional freeformTags

freeformTags: undefined | object

A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.

Example: {@code {\"bar-key\": \"value\"}}

Optional keyId

keyId: undefined | string

Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.

Optional keyStore

keyStore: undefined | string

The base64 encoded content of the KeyStore file. Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This field will be removed after February 15 2026.

Optional keyStorePassword

keyStorePassword: undefined | string

The KeyStore password. Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This field will be removed after February 15 2026.

Optional keyStorePasswordSecretId

keyStorePasswordSecretId: undefined | string

The OCID of the Secret where the kafka KeyStore password is stored. Note: When provided, 'keyStorePassword' field must not be provided.

Optional keyStoreSecretId

keyStoreSecretId: undefined | string

The OCID of the Secret where the content of the KeyStore file is stored. Note: When provided, 'keyStore' field must not be provided.

Optional locks

Locks associated with this resource.

Optional nsgIds

nsgIds: Array<string>

An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

Optional password

password: undefined | string

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 field will be removed after February 15 2026.

Optional passwordSecretId

passwordSecretId: undefined | string

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.

Optional producerProperties

producerProperties: undefined | string

The base64 encoded content of the producer.properties file.

Optional routingMethod

routingMethod: model.RoutingMethod

Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.

Optional securityAttributes

securityAttributes: undefined | object

Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"enforce\"}}}}

Optional securityProtocol

securityProtocol: undefined | string

Security Type for Kafka.

Optional shouldUseResourcePrincipal

shouldUseResourcePrincipal: undefined | false | true

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

Optional sslKeyPassword

sslKeyPassword: undefined | string

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 field will be removed after February 15 2026.

Optional sslKeyPasswordSecretId

sslKeyPasswordSecretId: undefined | string

The OCID of the Secret where the kafka Ssl Key password is stored. Note: When provided, 'sslKeyPassword' field must not be provided.

Optional streamPoolId

streamPoolId: undefined | string

The OCID of the stream pool being referenced.

Optional subnetId

subnetId: undefined | string

The OCID of the target subnet of the dedicated connection.

Optional subscriptionId

subscriptionId: undefined | string

The OCID of the subscription with which resource needs to be associated with.

technologyType

technologyType: string

The Kafka technology type.

Optional trustStore

trustStore: undefined | string

The base64 encoded content of the TrustStore file. Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This field will be removed after February 15 2026.

Optional trustStorePassword

trustStorePassword: undefined | string

The TrustStore password. Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This field will be removed after February 15 2026.

Optional trustStorePasswordSecretId

trustStorePasswordSecretId: undefined | string

The OCID of the Secret where the kafka TrustStore password is stored. Note: When provided, 'trustStorePassword' field must not be provided.

Optional trustStoreSecretId

trustStoreSecretId: undefined | string

The OCID of the Secret where the content of the TrustStore file is stored. Note: When provided, 'trustStore' field must not be provided.

Optional username

username: undefined | string

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.

Optional vaultId

vaultId: undefined | string

Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.

Methods

getDeserializedJsonObj

getJsonObj