Skip to content

databasemigration.oracle.com/v1beta1

Back to API Reference

APIVersion: databasemigration.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 databasemigration.oracle.com/v1beta1.

Resources

Kind Scope Sample Packages
Connection Namespaced Sample -

Connection

Manage OCI Database Migration connections.

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

Spec

ConnectionSpec defines the desired state of Connection.

Field Description Type Required Default Enum
additionalAttributes An array of name-value pair attribute entries. list[object] No - -
compartmentId The OCID of the compartment. string Yes - -
connectionString Connect descriptor or Easy Connect Naming method used to connect to a database. string No - -
connectionType - string No - -
databaseId The OCID of the database being referenced. string No - -
databaseName The name of the database being referenced. string No - -
dbSystemId The OCID of the database system being referenced. 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 - -
description A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
displayName A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. string Yes - -
freeformTags Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: map[string, string] No - -
host The IP Address of the host. string No - -
jsonData - string No - -
keyId The OCID of the key used in cryptographic operations. string Yes - -
nsgIds An array of Network Security Group OCIDs used to define network access for Connections. list[string] No - -
password The password (credential) used when creating or updating this resource. string Yes - -
port The port to be used for the connection. integer No - -
replicationPassword The password (credential) used when creating or updating this resource. string No - -
replicationUsername The username (credential) used when creating or updating this resource. string No - -
securityProtocol Security Type for MySQL. string No - -
sshHost Name of the host the SSH key is valid for. string No - -
sshKey Private SSH key string. string No - -
sshSudoLocation Sudo location string No - -
sshUser The username (credential) used when creating or updating this resource. string No - -
sslCa Database Certificate - The base64 encoded content of mysql.pem file containing the server public key (for 1 and 2-way SSL). string No - -
sslCert Client Certificate - The base64 encoded content of client-cert.pem file containing the client public key (for 2-way SSL). string No - -
sslCrl Certificates revoked by certificate authorities (CA). Server certificate must not be on this list (for 1 and 2-way SSL). Note: This is an optional and that too only applicable if TLS/MTLS option is selected. string No - -
sslKey Client Key - The client-key.pem containing the client private key (for 2-way SSL). string No - -
sslMode SSL modes for MySQL. string No - -
subnetId OCI resource ID. string No - -
technologyType The type of MySQL source or target connection. Example: OCI_MYSQL represents OCI MySQL HeatWave Database Service string No - -
username The username (credential) used when creating or updating this resource. string Yes - -
vaultId OCI resource ID. string Yes - -
wallet The wallet contents used to make connections to a database. This attribute is expected to be base64 encoded. string No - -

Spec.additionalAttributes[]

Back to Connection spec

ConnectionAdditionalAttribute defines nested fields for Connection.AdditionalAttribute.

Field Description Type Required Default Enum
name The name of the property entry. string Yes - -
value The value of the property entry. string Yes - -

Status

ConnectionStatus defines the observed state of Connection.

Field Description Type Required Default Enum
additionalAttributes An array of name-value pair attribute entries. list[object] No - -
compartmentId The OCID of the compartment. string No - -
connectionString Connect descriptor or Easy Connect Naming method used to connect to a database. string No - -
connectionType - string No - -
databaseId The OCID of the database being referenced. string No - -
databaseName The name of the database being referenced. string No - -
dbSystemId The OCID of the database system being referenced. 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 - -
description A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
displayName A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
freeformTags Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: map[string, string] No - -
host The IP Address of the host. string No - -
id The OCID of the connection being referenced. string No - -
ingressIps List of ingress IP addresses from where to connect to this connection's privateIp. list[object] No - -
jsonData - string No - -
keyId The OCID of the key used in cryptographic operations. string No - -
lifecycleDetails The message describing the current state of the connection's lifecycle in detail. For example, can be used to provide actionable information for a connection in a Failed state. string No - -
lifecycleState The Connection's current lifecycle state. string No - -
nsgIds An array of Network Security Group OCIDs used to define network access for Connections. list[string] No - -
port The port to be used for the connection. integer No - -
privateEndpointId The OCID of the resource being referenced. string No - -
replicationUsername The username (credential) used when creating or updating this resource. string No - -
secretId The OCID of the resource being referenced. string No - -
securityProtocol Security Protocol to be used for the connection. string No - -
sshHost Name of the host the SSH key is valid for. string No - -
sshSudoLocation Sudo location string No - -
sshUser The username (credential) used when creating or updating this resource. string No - -
sslMode SSL mode to be used for the connection. string No - -
status - object Yes - -
subnetId OCI resource ID. string No - -
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 - -
technologyType The type of MySQL source or target connection. Example: OCI_MYSQL represents OCI MySQL HeatWave Database Service string No - -
timeCreated The time when this resource was created. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z. string No - -
timeUpdated The time when this resource was updated. An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z. string No - -
username The username (credential) used when creating or updating this resource. string No - -
vaultId OCI resource ID. string No - -

Status.additionalAttributes[]

Back to Connection status

ConnectionAdditionalAttribute defines nested fields for Connection.AdditionalAttribute.

Field Description Type Required Default Enum
name The name of the property entry. string Yes - -
value The value of the property entry. string Yes - -

Status.ingressIps[]

Back to Connection status

ConnectionIngressIp defines nested fields for Connection.IngressIp.

Field Description Type Required Default Enum
ingressIp A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet. string No - -

Status.status

Back to Connection 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 Connection 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 Connection 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 Connection status

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