Database Tools: DatabaseToolsConnection¶
Manage OCI Database Tools connections. This page is generated from checked-in package metadata, CRD schemas, and sample manifests.
Resource Snapshot¶
| Field | Value |
|---|---|
| Service | databasetools |
| Resource | DatabaseToolsConnection |
| API Version | databasetools.oracle.com/v1beta1 |
| Package | Database Tools |
| Support Status | Preview |
| Latest Released Version | v2.1.0-alpha |
| Install Namespace | oci-service-operator-databasetools-system |
Quick Links¶
- Resource Guide Index
- Setup Guide
- Package Page
- API Reference
- Spec Reference
- Status Reference
- Rendered Sample (
config/samples/databasetools_v1beta1_databasetoolsconnection.yaml)
Spec Fields¶
This summary shows the top-level spec fields. Use the full API reference for nested fields, defaults, and enum values.
| Field | Description | Type | Required |
|---|---|---|---|
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 |
Status Fields¶
This summary shows the top-level status fields. Use the full API reference for nested fields, defaults, and enum values.
| Field | Description | Type | Required |
|---|---|---|---|
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 |
Sample Manifest¶
This example is generated from the checked-in sample manifest at config/samples/databasetools_v1beta1_databasetoolsconnection.yaml. Replace placeholder values before applying it.
#
# Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
#
apiVersion: databasetools.oracle.com/v1beta1
kind: DatabaseToolsConnection
metadata:
name: databasetoolsconnection-sample
spec: {}