Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace UpdateKafkaConnectionDetails

The information to update a 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"}

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.

Optional displayName

displayName: undefined | string

An object's Display Name.

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.

Optional keyStorePassword

keyStorePassword: undefined | string

The KeyStore password.

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.

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 securityProtocol

securityProtocol: undefined | string

Security Type for Kafka.

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.

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 trustStore

trustStore: undefined | string

The base64 encoded content of the TrustStore file.

Optional trustStorePassword

trustStorePassword: undefined | string

The TrustStore password.

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