Skip to content

databasetools.oracle.com/v1beta1

Back to API Reference

APIVersion: databasetools.oracle.com/v1beta1

This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.

Packages

No customer-visible package currently exposes databasetools.oracle.com/v1beta1.

Resources

Kind Scope Sample Packages
DatabaseToolsConnection Namespaced Sample -

DatabaseToolsConnection

Manage OCI Database Tools connections.

  • Plural: databasetoolsconnections
  • Scope: Namespaced
  • APIVersion: databasetools.oracle.com/v1beta1
  • Sample: Sample (config/samples/databasetools_v1beta1_databasetoolsconnection.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

DatabaseToolsConnectionSpec defines the desired state of DatabaseToolsConnection.

Field Description Type Required Default Enum
advancedProperties The advanced connection properties key-value pair. map[string, string] No - -
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the Database Tools connection. string Yes - -
connectionString The connection string used to connect to the PostgreSQL Server. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. string Yes - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -
jsonData - string No - -
keyStores The CA certificate to verify the server's certificate and the client private key and associated certificate required for client authentication. list[object] No - -
locks Locks associated with this resource. list[object] No - -
privateEndpointId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools private endpoint used to access the database in the customer VCN. string No - -
proxyClient DatabaseToolsConnectionProxyClient defines nested fields for DatabaseToolsConnection.ProxyClient. object No - -
relatedResource DatabaseToolsConnectionRelatedResource defines nested fields for DatabaseToolsConnection.RelatedResource. object No - -
runtimeIdentity Specifies the identity used by the Database Tools service to issue requests to other OCI services (e.g., Secrets in Vault). string No - -
runtimeSupport Specifies whether this connection is supported by the Database Tools Runtime. string No - -
type - string No - -
url The JDBC URL used to connect to the Generic JDBC database system. string No - -
userName The database user name. string No - -
userPassword DatabaseToolsConnectionUserPassword defines nested fields for DatabaseToolsConnection.UserPassword. object No - -

Spec.keyStores[]

Back to DatabaseToolsConnection spec

DatabaseToolsConnectionKeyStore defines nested fields for DatabaseToolsConnection.KeyStore.

Field Description Type Required Default Enum
keyStoreContent DatabaseToolsConnectionKeyStoreKeyStoreContent defines nested fields for DatabaseToolsConnection.KeyStore.KeyStoreContent. object No - -
keyStorePassword DatabaseToolsConnectionKeyStoreKeyStorePassword defines nested fields for DatabaseToolsConnection.KeyStore.KeyStorePassword. object No - -
keyStoreType The key store type. string No - -

Spec.keyStores[].keyStoreContent

Back to DatabaseToolsConnection spec

DatabaseToolsConnectionKeyStoreKeyStoreContent defines nested fields for DatabaseToolsConnection.KeyStore.KeyStoreContent.

Field Description Type Required Default Enum
jsonData - string No - -
secretId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the key store. string No - -
valueType - string No - -

Spec.keyStores[].keyStorePassword

Back to DatabaseToolsConnection spec

DatabaseToolsConnectionKeyStoreKeyStorePassword defines nested fields for DatabaseToolsConnection.KeyStore.KeyStorePassword.

Field Description Type Required Default Enum
jsonData - string No - -
secretId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the key store password. string No - -
valueType - string No - -

Spec.locks[]

Back to DatabaseToolsConnection spec

DatabaseToolsConnectionLock defines nested fields for DatabaseToolsConnection.Lock.

Field Description Type Required Default Enum
message A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. string No - -
relatedResourceId The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. string No - -
timeCreated When the lock was created. string No - -
type Type of the lock. string Yes - -

Spec.proxyClient

Back to DatabaseToolsConnection spec

DatabaseToolsConnectionProxyClient defines nested fields for DatabaseToolsConnection.ProxyClient.

Field Description Type Required Default Enum
jsonData - string No - -
proxyAuthenticationType - string No - -
roles A list of database roles for the client. These roles are enabled if the proxy is authorized to use the roles on behalf of the client. list[string] No - -
userName The user name. string No - -
userPassword DatabaseToolsConnectionProxyClientUserPassword defines nested fields for DatabaseToolsConnection.ProxyClient.UserPassword. object No - -

Spec.proxyClient.userPassword

Back to DatabaseToolsConnection spec

DatabaseToolsConnectionProxyClientUserPassword defines nested fields for DatabaseToolsConnection.ProxyClient.UserPassword.

Field Description Type Required Default Enum
jsonData - string No - -
secretId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. string No - -
valueType - string No - -

Spec.relatedResource

Back to DatabaseToolsConnection spec

DatabaseToolsConnectionRelatedResource defines nested fields for DatabaseToolsConnection.RelatedResource.

Field Description Type Required Default Enum
entityType The resource entity type. string Yes - -
identifier The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related resource. string Yes - -

Spec.userPassword

Back to DatabaseToolsConnection spec

DatabaseToolsConnectionUserPassword defines nested fields for DatabaseToolsConnection.UserPassword.

Field Description Type Required Default Enum
jsonData - string No - -
secretId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. string No - -
valueType - string No - -

Status

DatabaseToolsConnectionStatus defines the observed state of DatabaseToolsConnection.

Field Description Type Required Default Enum
advancedProperties The advanced connection properties key-value pair (for example, oracle.net.ssl_server_dn_match). map[string, string] No - -
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the Database Tools connection. string No - -
connectionString The connect descriptor or Easy Connect Naming method used to connect to the database. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools connection. string No - -
jsonData - string No - -
keyStores The Oracle wallet or Java Keystores containing trusted certificates for authenticating the server's public certificate and the client private key and associated certificates required for client authentication. list[object] No - -
lifecycleDetails A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state. string No - -
lifecycleState The current state of the Database Tools connection. string No - -
locks Locks associated with this resource. list[object] No - -
privateEndpointId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools private endpoint used to access the database in the customer VCN. string No - -
proxyClient DatabaseToolsConnectionProxyClient defines nested fields for DatabaseToolsConnection.ProxyClient. object No - -
relatedResource DatabaseToolsConnectionRelatedResource defines nested fields for DatabaseToolsConnection.RelatedResource. object No - -
runtimeEndpoint Specifies the Database Tools Runtime endpoint. string No - -
runtimeIdentity Specifies the identity used by the Database Tools service to issue requests to other OCI services (e.g., Secrets in Vault). string No - -
runtimeSupport Specifies whether this connection is supported by the Database Tools Runtime. string No - -
status - object Yes - -
systemTags Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeCreated The time the Database Tools connection was created. An RFC3339 formatted datetime string. string No - -
timeUpdated The time the Database Tools connection was updated. An RFC3339 formatted datetime string. string No - -
type - string No - -
url The JDBC URL used to connect to the Generic JDBC database system. string No - -
userName The database user name. string No - -
userPassword DatabaseToolsConnectionUserPassword defines nested fields for DatabaseToolsConnection.UserPassword. object No - -

Status.keyStores[]

Back to DatabaseToolsConnection status

DatabaseToolsConnectionKeyStore defines nested fields for DatabaseToolsConnection.KeyStore.

Field Description Type Required Default Enum
keyStoreContent DatabaseToolsConnectionKeyStoreKeyStoreContent defines nested fields for DatabaseToolsConnection.KeyStore.KeyStoreContent. object No - -
keyStorePassword DatabaseToolsConnectionKeyStoreKeyStorePassword defines nested fields for DatabaseToolsConnection.KeyStore.KeyStorePassword. object No - -
keyStoreType The key store type. string No - -

Status.keyStores[].keyStoreContent

Back to DatabaseToolsConnection status

DatabaseToolsConnectionKeyStoreKeyStoreContent defines nested fields for DatabaseToolsConnection.KeyStore.KeyStoreContent.

Field Description Type Required Default Enum
jsonData - string No - -
secretId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the key store. string No - -
valueType - string No - -

Status.keyStores[].keyStorePassword

Back to DatabaseToolsConnection status

DatabaseToolsConnectionKeyStoreKeyStorePassword defines nested fields for DatabaseToolsConnection.KeyStore.KeyStorePassword.

Field Description Type Required Default Enum
jsonData - string No - -
secretId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the key store password. string No - -
valueType - string No - -

Status.locks[]

Back to DatabaseToolsConnection status

DatabaseToolsConnectionLock defines nested fields for DatabaseToolsConnection.Lock.

Field Description Type Required Default Enum
message A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. string No - -
relatedResourceId The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. string No - -
timeCreated When the lock was created. string No - -
type Type of the lock. string Yes - -

Status.proxyClient

Back to DatabaseToolsConnection status

DatabaseToolsConnectionProxyClient defines nested fields for DatabaseToolsConnection.ProxyClient.

Field Description Type Required Default Enum
jsonData - string No - -
proxyAuthenticationType - string No - -
roles A list of database roles for the client. These roles are enabled if the proxy is authorized to use the roles on behalf of the client. list[string] No - -
userName The user name. string No - -
userPassword DatabaseToolsConnectionProxyClientUserPassword defines nested fields for DatabaseToolsConnection.ProxyClient.UserPassword. object No - -

Status.proxyClient.userPassword

Back to DatabaseToolsConnection status

DatabaseToolsConnectionProxyClientUserPassword defines nested fields for DatabaseToolsConnection.ProxyClient.UserPassword.

Field Description Type Required Default Enum
jsonData - string No - -
secretId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. string No - -
valueType - string No - -

Status.relatedResource

Back to DatabaseToolsConnection status

DatabaseToolsConnectionRelatedResource defines nested fields for DatabaseToolsConnection.RelatedResource.

Field Description Type Required Default Enum
entityType The resource entity type. string Yes - -
identifier The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related resource. string Yes - -

Status.status

Back to DatabaseToolsConnection status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to DatabaseToolsConnection status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to DatabaseToolsConnection status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to DatabaseToolsConnection status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

Status.userPassword

Back to DatabaseToolsConnection status

DatabaseToolsConnectionUserPassword defines nested fields for DatabaseToolsConnection.UserPassword.

Field Description Type Required Default Enum
jsonData - string No - -
secretId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. string No - -
valueType - string No - -