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
Assessment
Manage OCI Database Migration assessments.
Plural: assessmentsScope: NamespacedAPIVersion: databasemigration.oracle.com/v1beta1Sample: Sample (config/samples/databasemigration_v1beta1_assessment.yaml)Packages: Not currently exposed by a customer-visible package.
Spec
AssessmentSpec defines the desired state of Assessment.
| Field |
Description |
Type |
Required |
Default |
Enum |
acceptableDowntime |
Time allowed for the application downtime. |
string |
Yes |
- |
- |
bulkIncludeExcludeData |
Specifies the database objects to be excluded from the migration in bulk. The definition accepts input in a CSV format, newline separated for each entry. More details can be found in the documentation. |
string |
No |
- |
- |
compartmentId |
The OCID of the resource being referenced. |
string |
Yes |
- |
- |
creationType |
The type of assessment creation. |
string |
No |
- |
- |
databaseCombination |
- |
string |
No |
- |
- |
databaseDataSize |
The size of a source database. |
string |
Yes |
- |
- |
ddlExpectation |
DDL expectation values. |
string |
Yes |
- |
- |
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 |
- |
- |
excludeObjects |
Database objects to exclude from migration, cannot be specified alongside 'includeObjects' |
list[object] |
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 |
- |
- |
includeObjects |
Database objects to include from migration, cannot be specified alongside 'excludeObjects' |
list[object] |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
networkSpeedMegabitPerSecond |
A network speed in Megabits per second. |
string |
Yes |
- |
- |
sourceDatabaseConnection |
AssessmentSourceDatabaseConnection defines nested fields for Assessment.SourceDatabaseConnection. |
object |
Yes |
- |
- |
targetDatabaseConnection |
AssessmentTargetDatabaseConnection defines nested fields for Assessment.TargetDatabaseConnection. |
object |
Yes |
- |
- |
Spec.excludeObjects[]
Back to Assessment spec
AssessmentExcludeObject defines nested fields for Assessment.ExcludeObject.
| Field |
Description |
Type |
Required |
Default |
Enum |
isOmitExcludedTableFromReplication |
Whether an excluded table should be omitted from replication. Only valid for database objects that have are of type TABLE and object status EXCLUDE. |
boolean |
No |
- |
- |
objectName |
Name of the object (regular expression is allowed) |
string |
Yes |
- |
- |
owner |
Owner of the object (regular expression is allowed) |
string |
Yes |
- |
- |
type |
Type of object to exclude. If not specified, matching owners and object names of type TABLE would be excluded. |
string |
No |
- |
- |
Spec.includeObjects[]
Back to Assessment spec
AssessmentIncludeObject defines nested fields for Assessment.IncludeObject.
| Field |
Description |
Type |
Required |
Default |
Enum |
isOmitExcludedTableFromReplication |
Whether an excluded table should be omitted from replication. Only valid for database objects that have are of type TABLE and object status EXCLUDE. |
boolean |
No |
- |
- |
objectName |
Name of the object (regular expression is allowed) |
string |
Yes |
- |
- |
owner |
Owner of the object (regular expression is allowed) |
string |
Yes |
- |
- |
type |
Type of object to exclude. If not specified, matching owners and object names of type TABLE would be excluded. |
string |
No |
- |
- |
Spec.sourceDatabaseConnection
Back to Assessment spec
AssessmentSourceDatabaseConnection defines nested fields for Assessment.SourceDatabaseConnection.
| Field |
Description |
Type |
Required |
Default |
Enum |
id |
The OCID of the resource being referenced. |
string |
Yes |
- |
- |
Spec.targetDatabaseConnection
Back to Assessment spec
AssessmentTargetDatabaseConnection defines nested fields for Assessment.TargetDatabaseConnection.
| Field |
Description |
Type |
Required |
Default |
Enum |
connectionType |
Defines the type of connection. For example, ORACLE. |
string |
No |
- |
- |
databaseVersion |
The database version |
string |
No |
- |
- |
id |
The OCID of the resource being referenced. |
string |
No |
- |
- |
technologySubType |
Technology sub-type e.g. ADW_SHARED, ADW_DEDICATED, ATP_SHARED, ATP_DEDICATED |
string |
No |
- |
- |
technologyType |
The technology type. |
string |
No |
- |
- |
Status
AssessmentStatus defines the observed state of Assessment.
| Field |
Description |
Type |
Required |
Default |
Enum |
acceptableDowntime |
Time allowed for the application downtime. |
string |
No |
- |
- |
assessmentMigrationType |
The migration type of the migration to be performed. |
string |
No |
- |
- |
compartmentId |
The OCID of the resource being referenced. |
string |
No |
- |
- |
creationType |
The type of assessment creation. |
string |
No |
- |
- |
databaseCombination |
- |
string |
No |
- |
- |
databaseDataSize |
The size of a source database. |
string |
No |
- |
- |
ddlExpectation |
DDL expectation values. |
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 |
- |
- |
id |
The OCID of the resource being referenced. |
string |
No |
- |
- |
isCdbSupported |
True if CDB should be defined, false otherwise. |
boolean |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
lifecycleState |
The current state of the Assessment resource. |
string |
No |
- |
- |
migrationId |
The OCID of the resource being referenced. |
string |
No |
- |
- |
networkSpeedMegabitPerSecond |
A network speed in Megabits per second. |
string |
No |
- |
- |
sourceDatabaseConnection |
AssessmentSourceDatabaseConnection defines nested fields for Assessment.SourceDatabaseConnection. |
object |
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 |
- |
- |
targetDatabaseConnection |
AssessmentTargetDatabaseConnection defines nested fields for Assessment.TargetDatabaseConnection. |
object |
No |
- |
- |
timeCreated |
An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z. |
string |
No |
- |
- |
timeUpdated |
An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z. |
string |
No |
- |
- |
Status.sourceDatabaseConnection
Back to Assessment status
AssessmentSourceDatabaseConnection defines nested fields for Assessment.SourceDatabaseConnection.
| Field |
Description |
Type |
Required |
Default |
Enum |
id |
The OCID of the resource being referenced. |
string |
Yes |
- |
- |
Status.status
Back to Assessment 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 Assessment 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 Assessment 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 Assessment 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.targetDatabaseConnection
Back to Assessment status
AssessmentTargetDatabaseConnection defines nested fields for Assessment.TargetDatabaseConnection.
| Field |
Description |
Type |
Required |
Default |
Enum |
connectionType |
Defines the type of connection. For example, ORACLE. |
string |
No |
- |
- |
databaseVersion |
The database version |
string |
No |
- |
- |
id |
The OCID of the resource being referenced. |
string |
No |
- |
- |
technologySubType |
Technology sub-type e.g. ADW_SHARED, ADW_DEDICATED, ATP_SHARED, ATP_DEDICATED |
string |
No |
- |
- |
technologyType |
The technology type. |
string |
No |
- |
- |
Connection
Manage OCI Database Migration connections.
Plural: connectionsScope: NamespacedAPIVersion: databasemigration.oracle.com/v1beta1Sample: 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 |
- |
- |
Migration
Manage OCI Database Migration migrations.
Plural: migrationsScope: NamespacedAPIVersion: databasemigration.oracle.com/v1beta1Sample: Sample (config/samples/databasemigration_v1beta1_migration.yaml)Packages: Not currently exposed by a customer-visible package.
Spec
MigrationSpec defines the desired state of Migration.
| Field |
Description |
Type |
Required |
Default |
Enum |
advancedParameters |
List of Migration Parameter objects. |
list[object] |
No |
- |
- |
advisorSettings |
MigrationAdvisorSettings defines nested fields for Migration.AdvisorSettings. |
object |
No |
- |
- |
assessmentId |
The OCID of the resource being referenced. |
string |
No |
- |
- |
bulkIncludeExcludeData |
Specifies the database objects to be excluded from the migration in bulk. The definition accepts input in a CSV format, newline separated for each entry. More details can be found in the documentation. |
string |
No |
- |
- |
compartmentId |
The OCID of the resource being referenced. |
string |
Yes |
- |
- |
dataTransferMediumDetails |
MigrationDataTransferMediumDetails defines nested fields for Migration.DataTransferMediumDetails. |
object |
No |
- |
- |
databaseCombination |
- |
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 |
- |
- |
excludeObjects |
Database objects to exclude from migration, cannot be specified alongside 'includeObjects' |
list[object] |
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 |
- |
- |
ggsDetails |
MigrationGgsDetails defines nested fields for Migration.GgsDetails. |
object |
No |
- |
- |
hubDetails |
MigrationHubDetails defines nested fields for Migration.HubDetails. |
object |
No |
- |
- |
includeObjects |
Database objects to include from migration, cannot be specified alongside 'excludeObjects' |
list[object] |
No |
- |
- |
initialLoadSettings |
MigrationInitialLoadSettings defines nested fields for Migration.InitialLoadSettings. |
object |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
sourceContainerDatabaseConnectionId |
The OCID of the resource being referenced. |
string |
No |
- |
- |
sourceDatabaseConnectionId |
The OCID of the resource being referenced. |
string |
No |
- |
- |
sourceStandbyDatabaseConnectionId |
The OCID of the resource being referenced. |
string |
No |
- |
- |
targetDatabaseConnectionId |
The OCID of the resource being referenced. |
string |
No |
- |
- |
type |
The type of the migration to be performed. Example: ONLINE if no downtime is preferred for a migration. This method uses Oracle GoldenGate for replication. |
string |
Yes |
- |
- |
Spec.advancedParameters[]
Back to Migration spec
MigrationAdvancedParameter defines nested fields for Migration.AdvancedParameter.
| Field |
Description |
Type |
Required |
Default |
Enum |
dataType |
Parameter data type. |
string |
Yes |
- |
- |
name |
Parameter name. |
string |
Yes |
- |
- |
value |
If a STRING data type then the value should be an array of characters, if a INTEGER data type then the value should be an integer value, if a FLOAT data type then the value should be an float value, if a BOOLEAN data type then the value should be TRUE or FALSE. |
string |
Yes |
- |
- |
Spec.advisorSettings
Back to Migration spec
MigrationAdvisorSettings defines nested fields for Migration.AdvisorSettings.
| Field |
Description |
Type |
Required |
Default |
Enum |
isIgnoreErrors |
True to not interrupt migration execution due to Pre-Migration Advisor errors. Default is false. |
boolean |
No |
- |
- |
isSkipAdvisor |
True to skip the Pre-Migration Advisor execution. Default is false. |
boolean |
No |
- |
- |
Spec.dataTransferMediumDetails
Back to Migration spec
MigrationDataTransferMediumDetails defines nested fields for Migration.DataTransferMediumDetails.
| Field |
Description |
Type |
Required |
Default |
Enum |
jsonData |
- |
string |
No |
- |
- |
objectStorageBucket |
MigrationDataTransferMediumDetailsObjectStorageBucket defines nested fields for Migration.DataTransferMediumDetails.ObjectStorageBucket. |
object |
No |
- |
- |
type |
- |
string |
No |
- |
- |
Spec.dataTransferMediumDetails.objectStorageBucket
Back to Migration spec
MigrationDataTransferMediumDetailsObjectStorageBucket defines nested fields for Migration.DataTransferMediumDetails.ObjectStorageBucket.
| Field |
Description |
Type |
Required |
Default |
Enum |
bucketName |
Bucket name. |
string |
Yes |
- |
- |
namespaceName |
Namespace name of the object store bucket. |
string |
Yes |
- |
- |
Spec.excludeObjects[]
Back to Migration spec
MigrationExcludeObject defines nested fields for Migration.ExcludeObject.
| Field |
Description |
Type |
Required |
Default |
Enum |
objectName |
Name of the object (regular expression is allowed) |
string |
Yes |
- |
- |
schema |
Schema of the object (regular expression is allowed) |
string |
Yes |
- |
- |
type |
Type of object to exclude. If not specified, matching owners and object names of type TABLE would be excluded. |
string |
No |
- |
- |
Spec.ggsDetails
Back to Migration spec
MigrationGgsDetails defines nested fields for Migration.GgsDetails.
| Field |
Description |
Type |
Required |
Default |
Enum |
acceptableLag |
ODMS will monitor GoldenGate end-to-end latency until the lag time is lower than the specified value in seconds. |
integer |
No |
- |
- |
replicat |
MigrationGgsDetailsReplicat defines nested fields for Migration.GgsDetails.Replicat. |
object |
No |
- |
- |
Spec.ggsDetails.replicat
Back to Migration spec
MigrationGgsDetailsReplicat defines nested fields for Migration.GgsDetails.Replicat.
| Field |
Description |
Type |
Required |
Default |
Enum |
performanceProfile |
Replicat performance. |
string |
No |
- |
- |
Spec.hubDetails
Back to Migration spec
MigrationHubDetails defines nested fields for Migration.HubDetails.
| Field |
Description |
Type |
Required |
Default |
Enum |
acceptableLag |
ODMS will monitor GoldenGate end-to-end latency until the lag time is lower than the specified value in seconds. |
integer |
No |
- |
- |
computeId |
The OCID of the resource being referenced. |
string |
No |
- |
- |
extract |
MigrationHubDetailsExtract defines nested fields for Migration.HubDetails.Extract. |
object |
No |
- |
- |
keyId |
The OCID of the resource being referenced. |
string |
Yes |
- |
- |
replicat |
MigrationHubDetailsReplicat defines nested fields for Migration.HubDetails.Replicat. |
object |
No |
- |
- |
restAdminCredentials |
MigrationHubDetailsRestAdminCredentials defines nested fields for Migration.HubDetails.RestAdminCredentials. |
object |
Yes |
- |
- |
url |
Endpoint URL. |
string |
Yes |
- |
- |
vaultId |
The OCID of the resource being referenced. |
string |
Yes |
- |
- |
Back to Migration spec
MigrationHubDetailsExtract defines nested fields for Migration.HubDetails.Extract.
| Field |
Description |
Type |
Required |
Default |
Enum |
longTransDuration |
Length of time (in seconds) that a transaction can be open before Extract generates a warning message that the transaction is long-running. If not specified, Extract will not generate a warning on long-running transactions. |
integer |
No |
- |
- |
performanceProfile |
Extract performance. |
string |
No |
- |
- |
Spec.hubDetails.replicat
Back to Migration spec
MigrationHubDetailsReplicat defines nested fields for Migration.HubDetails.Replicat.
| Field |
Description |
Type |
Required |
Default |
Enum |
performanceProfile |
Replicat performance. |
string |
No |
- |
- |
Spec.hubDetails.restAdminCredentials
Back to Migration spec
MigrationHubDetailsRestAdminCredentials defines nested fields for Migration.HubDetails.RestAdminCredentials.
| Field |
Description |
Type |
Required |
Default |
Enum |
password |
Administrator password |
string |
Yes |
- |
- |
username |
Administrator username |
string |
Yes |
- |
- |
Spec.includeObjects[]
Back to Migration spec
MigrationIncludeObject defines nested fields for Migration.IncludeObject.
| Field |
Description |
Type |
Required |
Default |
Enum |
objectName |
Name of the object (regular expression is allowed) |
string |
Yes |
- |
- |
schema |
Schema of the object (regular expression is allowed) |
string |
Yes |
- |
- |
type |
Type of object to exclude. If not specified, matching owners and object names of type TABLE would be excluded. |
string |
No |
- |
- |
Spec.initialLoadSettings
Back to Migration spec
MigrationInitialLoadSettings defines nested fields for Migration.InitialLoadSettings.
| Field |
Description |
Type |
Required |
Default |
Enum |
compatibility |
Apply the specified requirements for compatibility with MySQL Database Service for all tables in the dump output, altering the dump files as necessary. |
list[string] |
No |
- |
- |
handleGrantErrors |
The action taken in the event of errors related to GRANT or REVOKE errors. |
string |
No |
- |
- |
isConsistent |
Enable (true) or disable (false) consistent data dumps by locking the instance for backup during the dump. |
boolean |
No |
- |
- |
isIgnoreExistingObjects |
Import the dump even if it contains objects that already exist in the target schema in the MySQL instance. |
boolean |
No |
- |
- |
isTzUtc |
Include a statement at the start of the dump to set the time zone to UTC. |
boolean |
No |
- |
- |
jobMode |
MySql Job Mode |
string |
Yes |
- |
- |
primaryKeyCompatibility |
Primary key compatibility option |
string |
No |
- |
- |
Status
MigrationStatus defines the observed state of Migration.
| Field |
Description |
Type |
Required |
Default |
Enum |
advancedParameters |
List of Migration Parameter objects. |
list[object] |
No |
- |
- |
advisorSettings |
MigrationAdvisorSettings defines nested fields for Migration.AdvisorSettings. |
object |
No |
- |
- |
assessmentId |
The OCID of the resource being referenced. |
string |
No |
- |
- |
compartmentId |
The OCID of the resource being referenced. |
string |
No |
- |
- |
dataTransferMediumDetails |
MigrationDataTransferMediumDetails defines nested fields for Migration.DataTransferMediumDetails. |
object |
No |
- |
- |
databaseCombination |
- |
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 |
- |
- |
executingJobId |
The OCID of the resource being referenced. |
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 |
- |
- |
ggsDetails |
MigrationGgsDetails defines nested fields for Migration.GgsDetails. |
object |
No |
- |
- |
hubDetails |
MigrationHubDetailsObservedState defines nested fields for Migration.HubDetails. |
object |
No |
- |
- |
id |
The OCID of the resource being referenced. |
string |
No |
- |
- |
initialLoadSettings |
MigrationInitialLoadSettings defines nested fields for Migration.InitialLoadSettings. |
object |
No |
- |
- |
jsonData |
- |
string |
No |
- |
- |
lifecycleDetails |
Additional status related to the execution and current state of the Migration. |
string |
No |
- |
- |
lifecycleState |
The current state of the Migration resource. |
string |
No |
- |
- |
sourceContainerDatabaseConnectionId |
The OCID of the resource being referenced. |
string |
No |
- |
- |
sourceDatabaseConnectionId |
The OCID of the resource being referenced. |
string |
No |
- |
- |
sourceStandbyDatabaseConnectionId |
The OCID of the resource being referenced. |
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 |
- |
- |
targetDatabaseConnectionId |
The OCID of the resource being referenced. |
string |
No |
- |
- |
timeCreated |
An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z. |
string |
No |
- |
- |
timeLastMigration |
An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z. |
string |
No |
- |
- |
timeUpdated |
An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z. |
string |
No |
- |
- |
type |
The type of the migration to be performed. Example: ONLINE if no downtime is preferred for a migration. This method uses Oracle GoldenGate for replication. |
string |
No |
- |
- |
waitAfter |
You can optionally pause a migration after a job phase. This property allows you to optionally specify the phase after which you can pause the migration. |
string |
No |
- |
- |
Status.advancedParameters[]
Back to Migration status
MigrationAdvancedParameter defines nested fields for Migration.AdvancedParameter.
| Field |
Description |
Type |
Required |
Default |
Enum |
dataType |
Parameter data type. |
string |
Yes |
- |
- |
name |
Parameter name. |
string |
Yes |
- |
- |
value |
If a STRING data type then the value should be an array of characters, if a INTEGER data type then the value should be an integer value, if a FLOAT data type then the value should be an float value, if a BOOLEAN data type then the value should be TRUE or FALSE. |
string |
Yes |
- |
- |
Status.advisorSettings
Back to Migration status
MigrationAdvisorSettings defines nested fields for Migration.AdvisorSettings.
| Field |
Description |
Type |
Required |
Default |
Enum |
isIgnoreErrors |
True to not interrupt migration execution due to Pre-Migration Advisor errors. Default is false. |
boolean |
No |
- |
- |
isSkipAdvisor |
True to skip the Pre-Migration Advisor execution. Default is false. |
boolean |
No |
- |
- |
Status.dataTransferMediumDetails
Back to Migration status
MigrationDataTransferMediumDetails defines nested fields for Migration.DataTransferMediumDetails.
| Field |
Description |
Type |
Required |
Default |
Enum |
jsonData |
- |
string |
No |
- |
- |
objectStorageBucket |
MigrationDataTransferMediumDetailsObjectStorageBucket defines nested fields for Migration.DataTransferMediumDetails.ObjectStorageBucket. |
object |
No |
- |
- |
type |
- |
string |
No |
- |
- |
Status.dataTransferMediumDetails.objectStorageBucket
Back to Migration status
MigrationDataTransferMediumDetailsObjectStorageBucket defines nested fields for Migration.DataTransferMediumDetails.ObjectStorageBucket.
| Field |
Description |
Type |
Required |
Default |
Enum |
bucketName |
Bucket name. |
string |
Yes |
- |
- |
namespaceName |
Namespace name of the object store bucket. |
string |
Yes |
- |
- |
Status.ggsDetails
Back to Migration status
MigrationGgsDetails defines nested fields for Migration.GgsDetails.
| Field |
Description |
Type |
Required |
Default |
Enum |
acceptableLag |
ODMS will monitor GoldenGate end-to-end latency until the lag time is lower than the specified value in seconds. |
integer |
No |
- |
- |
replicat |
MigrationGgsDetailsReplicat defines nested fields for Migration.GgsDetails.Replicat. |
object |
No |
- |
- |
Status.ggsDetails.replicat
Back to Migration status
MigrationGgsDetailsReplicat defines nested fields for Migration.GgsDetails.Replicat.
| Field |
Description |
Type |
Required |
Default |
Enum |
performanceProfile |
Replicat performance. |
string |
No |
- |
- |
Status.hubDetails
Back to Migration status
MigrationHubDetailsObservedState defines nested fields for Migration.HubDetails.
| Field |
Description |
Type |
Required |
Default |
Enum |
acceptableLag |
ODMS will monitor GoldenGate end-to-end latency until the lag time is lower than the specified value in seconds. |
integer |
No |
- |
- |
computeId |
The OCID of the resource being referenced. |
string |
No |
- |
- |
extract |
MigrationHubDetailsExtract defines nested fields for Migration.HubDetails.Extract. |
object |
No |
- |
- |
keyId |
The OCID of the resource being referenced. |
string |
No |
- |
- |
replicat |
MigrationHubDetailsReplicat defines nested fields for Migration.HubDetails.Replicat. |
object |
No |
- |
- |
restAdminCredentials |
MigrationHubDetailsRestAdminCredentialsObservedState defines nested fields for Migration.HubDetails.RestAdminCredentials. |
object |
No |
- |
- |
url |
Endpoint URL. |
string |
No |
- |
- |
vaultId |
The OCID of the resource being referenced. |
string |
No |
- |
- |
Back to Migration status
MigrationHubDetailsExtract defines nested fields for Migration.HubDetails.Extract.
| Field |
Description |
Type |
Required |
Default |
Enum |
longTransDuration |
Length of time (in seconds) that a transaction can be open before Extract generates a warning message that the transaction is long-running. If not specified, Extract will not generate a warning on long-running transactions. |
integer |
No |
- |
- |
performanceProfile |
Extract performance. |
string |
No |
- |
- |
Status.hubDetails.replicat
Back to Migration status
MigrationHubDetailsReplicat defines nested fields for Migration.HubDetails.Replicat.
| Field |
Description |
Type |
Required |
Default |
Enum |
performanceProfile |
Replicat performance. |
string |
No |
- |
- |
Status.hubDetails.restAdminCredentials
Back to Migration status
MigrationHubDetailsRestAdminCredentialsObservedState defines nested fields for Migration.HubDetails.RestAdminCredentials.
| Field |
Description |
Type |
Required |
Default |
Enum |
username |
Administrator username |
string |
No |
- |
- |
Status.initialLoadSettings
Back to Migration status
MigrationInitialLoadSettings defines nested fields for Migration.InitialLoadSettings.
| Field |
Description |
Type |
Required |
Default |
Enum |
compatibility |
Apply the specified requirements for compatibility with MySQL Database Service for all tables in the dump output, altering the dump files as necessary. |
list[string] |
No |
- |
- |
handleGrantErrors |
The action taken in the event of errors related to GRANT or REVOKE errors. |
string |
No |
- |
- |
isConsistent |
Enable (true) or disable (false) consistent data dumps by locking the instance for backup during the dump. |
boolean |
No |
- |
- |
isIgnoreExistingObjects |
Import the dump even if it contains objects that already exist in the target schema in the MySQL instance. |
boolean |
No |
- |
- |
isTzUtc |
Include a statement at the start of the dump to set the time zone to UTC. |
boolean |
No |
- |
- |
jobMode |
MySql Job Mode |
string |
Yes |
- |
- |
primaryKeyCompatibility |
Primary key compatibility option |
string |
No |
- |
- |
Status.status
Back to Migration 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 Migration 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 Migration 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 Migration status
| Field |
Description |
Type |
Required |
Default |
Enum |
lastTransitionTime |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
status |
- |
string |
Yes |
- |
- |
type |
- |
string |
Yes |
- |
- |