Data Source: oci_database_migration_migration

This data source provides details about a specific Migration resource in Oracle Cloud Infrastructure Database Migration service.

Display Migration details.

Example Usage

data "oci_database_migration_migration" "test_migration" {
	#Required
	migration_id = oci_database_migration_migration.test_migration.id
}

Argument Reference

The following arguments are supported:

migration_id - (Required) The OCID of the migration

Attributes Reference

The following attributes are exported:

advisor_settings - Optional Pre-Migration advisor settings.
- is_ignore_errors - True to not interrupt migration execution due to Pre-Migration Advisor errors. Default is false.
- is_skip_advisor - True to skip the Pre-Migration Advisor execution. Default is false.
agent_id - The OCID of the registered on-premises ODMS Agent. Only valid for Offline Migrations.
compartment_id - OCID of the compartment
credentials_secret_id - OCID of the Secret in the Oracle Cloud Infrastructure vault containing the Migration credentials. Used to store GoldenGate administrator user credentials.
data_transfer_medium_details - Data Transfer Medium details for the Migration.
- database_link_details - Optional details for creating a network database link from Oracle Cloud Infrastructure database to on-premise database.
  - name - Name of database link from Oracle Cloud Infrastructure database to on-premise database. ODMS will create link, if the link does not already exist.
  - wallet_bucket - In lieu of a network database link, Oracle Cloud Infrastructure Object Storage bucket will be used to store Data Pump dump files for the migration. Additionally, it can be specified alongside a database link data transfer medium.
    - bucket - Bucket name.
    - namespace - Namespace name of the object store bucket.
- object_storage_details - In lieu of a network database link, Oracle Cloud Infrastructure Object Storage bucket will be used to store Data Pump dump files for the migration. Additionally, it can be specified alongside a database link data transfer medium.
  - bucket - Bucket name.
  - namespace - Namespace name of the object store bucket.
data_transfer_medium_details_v2 - Optional additional properties for dump transfer in source or target host.
- access_key_id - AWS access key credentials identifier Details: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys
- name - Name of database link from Oracle Cloud Infrastructure database to on-premise database. ODMS will create link, if the link does not already exist.
- object_storage_bucket - In lieu of a network database link, Oracle Cloud Infrastructure Object Storage bucket will be used to store Data Pump dump files for the migration. Additionally, it can be specified alongside a database link data transfer medium.
  - bucket - Bucket name.
  - namespace - Namespace name of the object store bucket.
- region - AWS region code where the S3 bucket is located. Region code should match the documented available regions: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions
- secret_access_key - AWS secret access key credentials Details: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys
- type - Type of the data transfer medium to use for the datapump
datapump_settings - Optional settings for Data Pump Export and Import jobs
- data_pump_parameters - Optional parameters for Data Pump Export and Import. Refer to Configuring Optional Initial Load Advanced Settings
  - estimate - Estimate size of dumps that will be generated.
  - exclude_parameters - Exclude paratemers for Export and Import.
  - export_parallelism_degree - Maximum number of worker processes that can be used for a Data Pump Export job.
  - import_parallelism_degree - Maximum number of worker processes that can be used for a Data Pump Import job. For an Autonomous Database, ODMS will automatically query its CPU core count and set this property.
  - is_cluster - Set to false to force Data Pump worker processes to run on one instance.
  - table_exists_action - IMPORT: Specifies the action to be performed when data is loaded into a preexisting table.
- export_directory_object - Directory object details, used to define either import or export directory objects in Data Pump Settings.
  - name - Name of directory object in database
  - path - Absolute path of directory on database server
- import_directory_object - Directory object details, used to define either import or export directory objects in Data Pump Settings.
  - name - Name of directory object in database
  - path - Absolute path of directory on database server
- job_mode - Data Pump job mode. Refer to Data Pump Export Modes
- metadata_remaps - Defines remapping to be applied to objects as they are processed. Refer to METADATA_REMAP Procedure
  - new_value - Specifies the new value that oldValue should be translated into.
  - old_value - Specifies the value which needs to be reset.
  - type - Type of remap. Refer to METADATA_REMAP Procedure
defined_tags - Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
display_name - Migration Display Name
dump_transfer_details - Optional additional properties for dump transfer.
- shared_storage_mount_target_id - Optional OCID of the shared storage mount target.
- source - Optional additional properties for dump transfer in source or target host. Default kind is CURL
  - kind - Type of dump transfer to use during migration in source or target host. Default kind is CURL
  - oci_home - Path to the Oracle Cloud Infrastructure CLI installation in the node.
  - wallet_location - Directory path to Oracle Cloud Infrastructure SSL wallet location on Db server node.
- target - Optional additional properties for dump transfer in source or target host. Default kind is CURL
  - kind - Type of dump transfer to use during migration in source or target host. Default kind is CURL
  - oci_home - Path to the Oracle Cloud Infrastructure CLI installation in the node.
  - wallet_location - Directory path to Oracle Cloud Infrastructure SSL wallet location on Db server node.
exclude_objects - Database objects to exclude from migration. If ‘includeObjects’ are specified, only exclude object types can be specified with general wildcards (.*) for owner and objectName.
- is_omit_excluded_table_from_replication - Whether an excluded table should be omitted from replication. Only valid for database objects that have are of type TABLE and that are included in the exludeObjects.
- object - Name of the object (regular expression is allowed)
- owner - Owner of the object (regular expression is allowed)
- type - Type of object to exclude. If not specified, matching owners and object names of type TABLE would be excluded.
executing_job_id - OCID of the current ODMS Job in execution for the Migration, if any.
freeform_tags - Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
golden_gate_details - Details about Oracle GoldenGate Microservices.
- hub - Details about Oracle GoldenGate Microservices.
  - compute_id - OCID of GoldenGate compute instance.
  - rest_admin_credentials - Database Administrator Credentials details.
    - username - Administrator username
  - source_container_db_admin_credentials - Database Administrator Credentials details.
    - username - Administrator username
  - source_db_admin_credentials - Database Administrator Credentials details.
    - username - Administrator username
  - source_microservices_deployment_name - Name of GoldenGate deployment to operate on source database
  - target_db_admin_credentials - Database Administrator Credentials details.
    - username - Administrator username
  - target_microservices_deployment_name - Name of GoldenGate deployment to operate on target database
  - url - Oracle GoldenGate hub’s REST endpoint. Refer to https://docs.oracle.com/en/middleware/goldengate/core/19.1/securing/network.html#GUID-A709DA55-111D-455E-8942-C9BDD1E38CAA
- settings - Optional settings for Oracle GoldenGate processes
  - acceptable_lag - ODMS will monitor GoldenGate end-to-end latency until the lag time is lower than the specified value in seconds.
  - extract - Parameters for Extract processes.
    - long_trans_duration - 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.
    - performance_profile - Extract performance.
  - replicat - Parameters for Replicat processes.
    - map_parallelism - Number of threads used to read trail files (valid for Parallel Replicat)
    - max_apply_parallelism - Defines the range in which Replicat automatically adjusts its apply parallelism (valid for Parallel Replicat)
    - min_apply_parallelism - Defines the range in which Replicat automatically adjusts its apply parallelism (valid for Parallel Replicat)
golden_gate_service_details - Details about Oracle GoldenGate GGS Deployment.
- ggs_deployment - Details about Oracle GoldenGate GGS Deployment.
  - deployment_id - OCID of a GoldenGate Deployment
  - ggs_admin_credentials_secret_id - OCID of a VaultSecret containing the Admin Credentials for the GGS Deployment
- settings - Optional settings for Oracle GoldenGate processes
  - acceptable_lag - ODMS will monitor GoldenGate end-to-end latency until the lag time is lower than the specified value in seconds.
  - extract - Parameters for Extract processes.
    - long_trans_duration - 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.
    - performance_profile - Extract performance.
  - replicat - Parameters for Replicat processes.
    - map_parallelism - Number of threads used to read trail files (valid for Parallel Replicat)
    - max_apply_parallelism - Defines the range in which Replicat automatically adjusts its apply parallelism (valid for Parallel Replicat)
    - min_apply_parallelism - Defines the range in which Replicat automatically adjusts its apply parallelism (valid for Parallel Replicat)
    - performance_profile - Extract performance.
id - The OCID of the resource
include_objects - Database objects to include from migration.
- is_omit_excluded_table_from_replication - Whether an excluded table should be omitted from replication. Only valid for database objects that have are of type TABLE and that are included in the exludeObjects.
- object - Name of the object (regular expression is allowed)
- owner - Owner of the object (regular expression is allowed)
- type - Type of object to exclude. If not specified, matching owners and object names of type TABLE would be excluded.
lifecycle_details - Additional status related to the execution and current state of the Migration.
source_container_database_connection_id - The OCID of the Source Container Database Connection.
source_database_connection_id - The OCID of the Source Database Connection.
state - The current state of the Migration resource.
system_tags - Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
target_database_connection_id - The OCID of the Target Database Connection.
time_created - The time the Migration was created. An RFC3339 formatted datetime string.
time_last_migration - The time of last Migration. An RFC3339 formatted datetime string.
time_updated - The time of the last Migration details update. An RFC3339 formatted datetime string.
type - Migration type.
vault_details - Oracle Cloud Infrastructure Vault details to store migration and connection credentials secrets
- compartment_id - OCID of the compartment where the secret containing the credentials will be created.
- key_id - OCID of the vault encryption key
- vault_id - OCID of the vault
wait_after - Name of a migration phase. The Job will wait after executing this phase until the Resume Job endpoint is called.