"default"
*********

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Example using required parameter


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

Update a Database Tools database API gateway config pool resource


Usage
=====

   oci dbtools-runtime database-api-gateway-config-pool update default [OPTIONS]


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

--database-api-gateway-config-id [text]

The OCID of a Database Tools database API gateway config.

--pool-key [text]

The key of the pool config.


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

--advanced-properties [complex type]

Advanced pool properties. 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.

--database-actions-status [text]

Specifies to enable the Database Actions feature.

Accepted values are:

   DISABLED, ENABLED

--database-tools-connection-id [text]

The OCID of the related Database Tools connection. Specifies the OCI
database tools connection ocid to build the connection pool from.

--display-name [text]

A user-friendly name. Does not have to be unique, and it’s changeable.
Avoid entering confidential information.

--force

Perform update without prompting for confirmation.

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

If-Match is most often used with state-changing methods (e.g., POST,
PUT, DELETE) to prevent accidental overwrites when multiple user
agentss might be acting in parallel on the same resource (i.e., to
prevent the “lost update” problem). In general, it can be used with
any method that involves the selection or modification of a
representation to abort the request if the selected representation’s
current entity tag is not a member within the If-Match field value.
When specified on an action-specific subresource, the ETag value of
the resource on which the action is requested should be provided.

--initial-pool-size [integer]

Specifies the initial size for the number of database connections that
will be created for the pool.

--jwt-profile-audience [text]

Specifies the expected audience for the JWT token. This value is used
to validate the aud claim in the JWT token.

--jwt-profile-issuer [text]

Specifies the issuer of the JWT token. This value is used to validate
the iss claim in the JWT token.

--jwt-profile-jwk-url [text]

Specifies the URL of the JSON Web Key (JWK) that is used to verify the
signature of the JWT token.

--jwt-profile-role-claim-name [text]

Specifies the JSON pointer to the claim in the JWT token that contains
the roles of the users.

--max-pool-size [integer]

Specifies the maximum number of database connections allowed for the
pool.

--min-pool-size [integer]

Specifies the minimum number of database connections allowed for the
pool.

--pool-route-value [text]

The pool route value provided in requests to target this pool.

--rest-enabled-sql-status [text]

Specifies whether the REST-Enabled SQL service is active.

Accepted values are:

   DISABLED, ENABLED


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", "--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 database_api_gateway_config_id=<substitute-value-of-database_api_gateway_config_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dbtools-runtime/database-api-gateway-config-pool/update/default.html#cmdoption-database-api-gateway-config-id
       export pool_key=<substitute-value-of-pool_key> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dbtools-runtime/database-api-gateway-config-pool/update/default.html#cmdoption-pool-key

       oci dbtools-runtime database-api-gateway-config-pool update default --database-api-gateway-config-id $database_api_gateway_config_id --pool-key $pool_key
