"update-kafka-schema-registry-connection"
*****************************************

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Example using required parameter


Description
===========

Updates the Connection.


Usage
=====

   oci goldengate connection update-kafka-schema-registry-connection [OPTIONS]


Required Parameters
===================

--connection-id [text]

The OCID of a Connection.


Optional Parameters
===================

--authentication-type [text]

Used authentication mechanism to access Schema Registry.

--defined-tags [complex type]

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

Example:

   {"foo-namespace": {"bar-key": "value"}}

This is a complex type whose value must be valid JSON. The value can
be provided as a string on the command line or passed in as a file
using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--description [text]

Metadata about this specific object.

--display-name [text]

An object’s Display Name.

--does-use-secret-ids [boolean]

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.

--force

Perform update without prompting for confirmation.

--freeform-tags [complex type]

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

Example:

   {"bar-key": "value"}

This is a complex type whose value must be valid JSON. The value can
be provided as a string on the command line or passed in as a file
using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--from-json [text]

Provide input to this command as a JSON document from a file using the
file://path-to/file syntax.

The "--generate-full-command-json-input" option can be used to
generate a sample json file to be used with this command option. The
key names are pre-populated and match the command option names
(converted to camelCase format, e.g. compartment-id –> compartmentId),
while the values of the keys need to be populated by the user before
using the sample file as an input to this command. For any command
option that accepts multiple values, the value of the key can be a
JSON array.

Options can still be provided on the command line. If an option exists
in both the JSON document and the command line then the command line
specified value will be used.

For examples on usage of this option, please see our “using CLI with
advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--if-match [text]

For optimistic concurrency control. In the PUT or DELETE call for a
resource, set the *if-match* parameter to the value of the etag from a
previous GET or POST response for that resource.  The resource is
updated or deleted only if the etag you provide matches the resource’s
current etag value.

--is-lock-override [boolean]

Whether to override locks (if any exist).

--key-id [text]

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.

--key-store [text]

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

--key-store-password [text]

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

--key-store-password-secret-id [text]

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

--key-store-secret-id [text]

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

--max-wait-seconds [integer]

The maximum time to wait for the work request to reach the state
defined by "--wait-for-state". Defaults to 1200 seconds.

--nsg-ids [complex type]

An array of Network Security Group OCIDs used to define network access
for either Deployments or Connections. This is a complex type whose
value must be valid JSON. The value can be provided as a string on the
command line or passed in as a file using the file://path/to/file
syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--password [text]

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

--password-secret-id [text]

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.

--private-ip [text]

This property is not available when creating connections. For existing
deprecated connections having this value set, the value cannot be
updated; set it to empty.

For deprecated connections created with this field in the past, either
the private IP had to be specified in the connectionString or host
field, or the host name had to be resolvable in the target VCN.

--routing-method [text]

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

Accepted values are:

   DEDICATED_ENDPOINT, SHARED_DEPLOYMENT_ENDPOINT, SHARED_SERVICE_ENDPOINT

--security-attributes [complex type]

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"}}}

This is a complex type whose value must be valid JSON. The value can
be provided as a string on the command line or passed in as a file
using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--ssl-key-password [text]

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

--ssl-key-password-secret-id [text]

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.

--subnet-id [text]

The OCID of the target subnet of the dedicated connection.

--trust-store [text]

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

--trust-store-password [text]

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

--trust-store-password-secret-id [text]

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

--trust-store-secret-id [text]

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

--url [text]

Kafka Schema Registry URL. e.g.: ‘https://server1.us.oracle.com:8081’

--username [text]

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

--vault-id [text]

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.

--wait-for-state [text]

This operation asynchronously creates, modifies or deletes a resource
and uses a work request to track the progress of the operation.
Specify this option to perform the action and then wait until the work
request reaches a certain state. Multiple states can be specified,
returning on the first state. For example, "--wait-for-state" ACCEPTED
"--wait-for-state" CANCELED would return on whichever lifecycle state
is reached first. If timeout is reached, a return code of 2 is
returned. For any other error, a return code of 1 is returned.

Accepted values are:

   ACCEPTED, CANCELED, FAILED, IN_PROGRESS, SUCCEEDED

--wait-interval-seconds [integer]

Check every "--wait-interval-seconds" to see whether the work request
has reached the state defined by "--wait-for-state". Defaults to 30
seconds.


Global Parameters
=================

Use "oci --help" for help on global parameters.

"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
defaults-file", "--enable-dual-stack", "--enable-propagation", "--
endpoint", "--federation-endpoint", "--generate-full-command-json-
input", "--generate-param-json-input", "--help", "--latest-version", "
--max-retries", "--no-retry", "--opc-client-request-id", "--opc-
request-id", "--output", "--profile", "--proxy", "--query", "--raw-
output", "--read-timeout", "--realm-specific-endpoint", "--region", "
--release-info", "--request-id", "--version", "-?", "-d", "-h", "-i",
"-v"


Example using required parameter
================================

Copy the following CLI commands into a file named example.sh. Run the
command by typing “bash example.sh” and replacing the example
parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-
like shell. You need to set up the OCI configuration and appropriate
security policies before trying the examples.

       export connection_id=<substitute-value-of-connection_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/goldengate/connection/update-kafka-schema-registry-connection.html#cmdoption-connection-id

       oci goldengate connection update-kafka-schema-registry-connection --connection-id $connection_id
