gcp_datamigration_migration_job

ancestors

Type: UNORDERED_LIST_STRING

cmek_key_name

Type: STRING
Provider name: cmekKeyName
Description: The CMEK (customer-managed encryption key) fully qualified key name used for the migration job. This field supports all migration jobs types except for: * Mysql to Mysql (use the cmek field in the cloudsql connection profile instead). * PostrgeSQL to PostgreSQL (use the cmek field in the cloudsql connection profile instead). * PostgreSQL to AlloyDB (use the kms_key_name field in the alloydb connection profile instead). Each Cloud CMEK key has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]

conversion_workspace

Type: STRUCT
Provider name: conversionWorkspace
Description: The conversion workspace used by the migration.

  • commit_id
    Type: STRING
    Provider name: commitId
    Description: The commit ID of the conversion workspace.
  • name
    Type: STRING
    Provider name: name
    Description: The resource name (URI) of the conversion workspace.

create_time

Type: TIMESTAMP
Provider name: createTime
Description: Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC “Zulu” format, accurate to nanoseconds. Example: “2014-10-02T15:01:23.045123456Z”.

destination

Type: STRING
Provider name: destination
Description: Required. The resource name (URI) of the destination connection profile.

destination_database

Type: STRUCT
Provider name: destinationDatabase
Description: The database engine type and provider of the destination.

  • engine
    Type: STRING
    Provider name: engine
    Description: The database engine.
    Possible values:
    • DATABASE_ENGINE_UNSPECIFIED - The source database engine of the migration job is unknown.
    • MYSQL - The source engine is MySQL.
    • POSTGRESQL - The source engine is PostgreSQL.
    • SQLSERVER - The source engine is SQL Server.
    • ORACLE - The source engine is Oracle.
  • provider
    Type: STRING
    Provider name: provider
    Description: The database provider.
    Possible values:
    • DATABASE_PROVIDER_UNSPECIFIED - Use this value for on-premise source database instances and ORACLE.
    • CLOUDSQL - Cloud SQL is the source instance provider.
    • RDS - Amazon RDS is the source instance provider.
    • AURORA - Amazon Aurora is the source instance provider.
    • ALLOYDB - AlloyDB for PostgreSQL is the source instance provider.
    • AZURE_DATABASE - Microsoft Azure Database for MySQL/PostgreSQL.

dump_flags

Type: STRUCT
Provider name: dumpFlags
Description: The initial dump flags. This field and the “dump_path” field are mutually exclusive.

  • dump_flags
    Type: UNORDERED_LIST_STRUCT
    Provider name: dumpFlags
    Description: The flags for the initial dump.
    • name
      Type: STRING
      Provider name: name
      Description: The name of the flag
    • value
      Type: STRING
      Provider name: value
      Description: The value of the flag.

dump_path

Type: STRING
Provider name: dumpPath
Description: The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). This field and the “dump_flags” field are mutually exclusive.

dump_type

Type: STRING
Provider name: dumpType
Description: Optional. The type of the data dump. Supported for MySQL to CloudSQL for MySQL migrations only.
Possible values:

  • DUMP_TYPE_UNSPECIFIED - If not specified, defaults to LOGICAL
  • LOGICAL - Logical dump.
  • PHYSICAL - Physical file-based dump. Supported for MySQL to CloudSQL for MySQL migrations only.

duration

Type: STRING
Provider name: duration
Description: Output only. The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by ’s’. Example: “3.5s”.

end_time

Type: TIMESTAMP
Provider name: endTime
Description: Output only. If the migration job is completed, the time when it was completed.

error

Type: STRUCT
Provider name: error
Description: Output only. The error details in case of state FAILED.

  • code
    Type: INT32
    Provider name: code
    Description: The status code, which should be an enum value of google.rpc.Code.
  • message
    Type: STRING
    Provider name: message
    Description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

filter

Type: STRING
Provider name: filter
Description: This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace.

gcp_display_name

Type: STRING
Provider name: displayName
Description: The migration job display name.

gcp_source

Type: STRING
Provider name: source
Description: Required. The resource name (URI) of the source connection profile.

labels

Type: UNORDERED_LIST_STRING

name

Type: STRING
Provider name: name
Description: The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.

objects_config

Type: STRUCT
Provider name: objectsConfig
Description: Optional. The objects that need to be migrated.

  • source_objects_config
    Type: STRUCT
    Provider name: sourceObjectsConfig
    Description: The list of the migration job objects.
    • object_configs
      Type: UNORDERED_LIST_STRUCT
      Provider name: objectConfigs
      Description: Optional. The list of the objects to be migrated.
      • object_identifier
        Type: STRUCT
        Provider name: objectIdentifier
        Description: Optional. The object identifier.
        • database
          Type: STRING
          Provider name: database
          Description: Optional. The database name. This will be required only if the object uses a database name as part of its unique identifier.
        • type
          Type: STRING
          Provider name: type
          Description: Required. The type of the migration job object.
          Possible values:
          • MIGRATION_JOB_OBJECT_TYPE_UNSPECIFIED - The type of the migration job object is unknown.
          • DATABASE - The migration job object is a database.
    • objects_selection_type
      Type: STRING
      Provider name: objectsSelectionType
      Description: Optional. The objects selection type of the migration job.
      Possible values:
      • OBJECTS_SELECTION_TYPE_UNSPECIFIED - The type of the objects selection is unknown, indicating that the migration job is at instance level.
      • ALL_OBJECTS - Migrate all of the objects.
      • SPECIFIED_OBJECTS - Migrate specific objects.

oracle_to_postgres_config

Type: STRUCT
Provider name: oracleToPostgresConfig
Description: Configuration for heterogeneous Oracle to Cloud SQL for PostgreSQL and Oracle to AlloyDB for PostgreSQL migrations.

  • oracle_source_config
    Type: STRUCT
    Provider name: oracleSourceConfig
    Description: Optional. Configuration for Oracle source.

    • binary_log_parser
      Type: STRUCT
      Provider name: binaryLogParser
      Description: Use Binary Log Parser.

      • log_file_directories
        Type: STRUCT
        Provider name: logFileDirectories
        Description: Use Oracle directories.
        • archived_log_directory
          Type: STRING
          Provider name: archivedLogDirectory
          Description: Required. Oracle directory for archived logs.
        • online_log_directory
          Type: STRING
          Provider name: onlineLogDirectory
          Description: Required. Oracle directory for online logs.
      • oracle_asm_log_file_access
        Type: STRUCT
        Provider name: oracleAsmLogFileAccess
        Description: Use Oracle ASM.

    • cdc_start_position
      Type: INT64
      Provider name: cdcStartPosition
      Description: Optional. The schema change number (SCN) to start CDC data migration from.

    • log_miner
      Type: STRUCT
      Provider name: logMiner
      Description: Use LogMiner.

    • max_concurrent_cdc_connections
      Type: INT32
      Provider name: maxConcurrentCdcConnections
      Description: Optional. Maximum number of connections Database Migration Service will open to the source for CDC phase.

    • max_concurrent_full_dump_connections
      Type: INT32
      Provider name: maxConcurrentFullDumpConnections
      Description: Optional. Maximum number of connections Database Migration Service will open to the source for full dump phase.

    • skip_full_dump
      Type: BOOLEAN
      Provider name: skipFullDump
      Description: Optional. Whether to skip full dump or not.

  • postgres_destination_config
    Type: STRUCT
    Provider name: postgresDestinationConfig
    Description: Optional. Configuration for Postgres destination.
    • max_concurrent_connections
      Type: INT32
      Provider name: maxConcurrentConnections
      Description: Optional. Maximum number of connections Database Migration Service will open to the destination for data migration.
    • transaction_timeout
      Type: STRING
      Provider name: transactionTimeout
      Description: Optional. Timeout for data migration transactions.

organization_id

Type: STRING

parent

Type: STRING

performance_config

Type: STRUCT
Provider name: performanceConfig
Description: Optional. Data dump parallelism settings used by the migration.

  • dump_parallel_level
    Type: STRING
    Provider name: dumpParallelLevel
    Description: Initial dump parallelism level.
    Possible values:
    • DUMP_PARALLEL_LEVEL_UNSPECIFIED - Unknown dump parallel level. Will be defaulted to OPTIMAL.
    • MIN - Minimal parallel level.
    • OPTIMAL - Optimal parallel level.
    • MAX - Maximum parallel level.

phase

Type: STRING
Provider name: phase
Description: Output only. The current migration job phase.
Possible values:

  • PHASE_UNSPECIFIED - The phase of the migration job is unknown.
  • FULL_DUMP - The migration job is in the full dump phase.
  • CDC - The migration job is CDC phase.
  • PROMOTE_IN_PROGRESS - The migration job is running the promote phase.
  • WAITING_FOR_SOURCE_WRITES_TO_STOP - Only RDS flow - waiting for source writes to stop
  • PREPARING_THE_DUMP - Only RDS flow - the sources writes stopped, waiting for dump to begin
  • READY_FOR_PROMOTE - The migration job is ready to be promoted.

project_id

Type: STRING

project_number

Type: STRING

resource_name

Type: STRING

reverse_ssh_connectivity

Type: STRUCT
Provider name: reverseSshConnectivity
Description: The details needed to communicate to the source over Reverse SSH tunnel connectivity.

  • vm
    Type: STRING
    Provider name: vm
    Description: The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
  • vm_ip
    Type: STRING
    Provider name: vmIp
    Description: Required. The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
  • vm_port
    Type: INT32
    Provider name: vmPort
    Description: Required. The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
  • vpc
    Type: STRING
    Provider name: vpc
    Description: The name of the VPC to peer with the Cloud SQL private network.

satisfies_pzi

Type: BOOLEAN
Provider name: satisfiesPzi
Description: Output only. Reserved for future use.

satisfies_pzs

Type: BOOLEAN
Provider name: satisfiesPzs
Description: Output only. Reserved for future use.

source_database

Type: STRUCT
Provider name: sourceDatabase
Description: The database engine type and provider of the source.

  • engine
    Type: STRING
    Provider name: engine
    Description: The database engine.
    Possible values:
    • DATABASE_ENGINE_UNSPECIFIED - The source database engine of the migration job is unknown.
    • MYSQL - The source engine is MySQL.
    • POSTGRESQL - The source engine is PostgreSQL.
    • SQLSERVER - The source engine is SQL Server.
    • ORACLE - The source engine is Oracle.
  • provider
    Type: STRING
    Provider name: provider
    Description: The database provider.
    Possible values:
    • DATABASE_PROVIDER_UNSPECIFIED - Use this value for on-premise source database instances and ORACLE.
    • CLOUDSQL - Cloud SQL is the source instance provider.
    • RDS - Amazon RDS is the source instance provider.
    • AURORA - Amazon Aurora is the source instance provider.
    • ALLOYDB - AlloyDB for PostgreSQL is the source instance provider.
    • AZURE_DATABASE - Microsoft Azure Database for MySQL/PostgreSQL.

sqlserver_homogeneous_migration_job_config

Type: STRUCT
Provider name: sqlserverHomogeneousMigrationJobConfig
Description: Optional. Configuration for SQL Server homogeneous migration.

  • backup_file_pattern
    Type: STRING
    Provider name: backupFilePattern
    Description: Required. Pattern that describes the default backup naming strategy. The specified pattern should ensure lexicographical order of backups. The pattern must define one of the following capture group sets: Capture group set #1 yy/yyyy - year, 2 or 4 digits mm - month number, 1-12 dd - day of month, 1-31 hh - hour of day, 00-23 mi - minutes, 00-59 ss - seconds, 00-59 Example: For backup file TestDB_20230802_155400.trn, use pattern: (?.)backup(?\d{4})(?\d{2})(?\d{2})_(?\d{2})(?\d{2})(?\d{2}).trn Capture group set #2 timestamp - unix timestamp Example: For backup file TestDB.1691448254.trn, use pattern: (?.).(?\d*).trn or (?.).(?\d).trn
  • database_backups
    Type: UNORDERED_LIST_STRUCT
    Provider name: databaseBackups
    Description: Required. Backup details per database in Cloud Storage.
    • database
      Type: STRING
      Provider name: database
      Description: Required. Name of a SQL Server database for which to define backup configuration.
    • encryption_options
      Type: STRUCT
      Provider name: encryptionOptions
      Description: Optional. Encryption settings for the database. Required if provided database backups are encrypted. Encryption settings include path to certificate, path to certificate private key, and key password.
      • cert_path
        Type: STRING
        Provider name: certPath
        Description: Required. Path to the Certificate (.cer) in Cloud Storage, in the form gs://bucketName/fileName. The instance must have write permissions to the bucket and read access to the file.
      • pvk_password
        Type: STRING
        Provider name: pvkPassword
        Description: Required. Input only. Password that encrypts the private key.
      • pvk_path
        Type: STRING
        Provider name: pvkPath
        Description: Required. Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form gs://bucketName/fileName. The instance must have write permissions to the bucket and read access to the file.
  • promote_when_ready
    Type: BOOLEAN
    Provider name: promoteWhenReady
    Description: Optional. Promote databases when ready.
  • use_diff_backup
    Type: BOOLEAN
    Provider name: useDiffBackup
    Description: Optional. Enable differential backups.

sqlserver_to_postgres_config

Type: STRUCT
Provider name: sqlserverToPostgresConfig
Description: Configuration for heterogeneous SQL Server to Cloud SQL for PostgreSQL migrations.

  • postgres_destination_config
    Type: STRUCT
    Provider name: postgresDestinationConfig
    Description: Optional. Configuration for Postgres destination.
    • max_concurrent_connections
      Type: INT32
      Provider name: maxConcurrentConnections
      Description: Optional. Maximum number of connections Database Migration Service will open to the destination for data migration.
    • transaction_timeout
      Type: STRING
      Provider name: transactionTimeout
      Description: Optional. Timeout for data migration transactions.
  • sqlserver_source_config
    Type: STRUCT
    Provider name: sqlserverSourceConfig
    Description: Optional. Configuration for SQL Server source.
    • cdc_start_position
      Type: STRING
      Provider name: cdcStartPosition
      Description: Optional. The log sequence number (LSN) to start CDC data migration from.
    • max_concurrent_cdc_connections
      Type: INT32
      Provider name: maxConcurrentCdcConnections
      Description: Optional. Maximum number of connections Database Migration Service will open to the source for CDC phase.
    • max_concurrent_full_dump_connections
      Type: INT32
      Provider name: maxConcurrentFullDumpConnections
      Description: Optional. Maximum number of connections Database Migration Service will open to the source for full dump phase.
    • skip_full_dump
      Type: BOOLEAN
      Provider name: skipFullDump
      Description: Optional. Whether to skip full dump or not.

state

Type: STRING
Provider name: state
Description: The current migration job state.
Possible values:

  • STATE_UNSPECIFIED - The state of the migration job is unknown.
  • MAINTENANCE - The migration job is down for maintenance.
  • DRAFT - The migration job is in draft mode and no resources are created.
  • CREATING - The migration job is being created.
  • NOT_STARTED - The migration job is created and not started.
  • RUNNING - The migration job is running.
  • FAILED - The migration job failed.
  • COMPLETED - The migration job has been completed.
  • DELETING - The migration job is being deleted.
  • STOPPING - The migration job is being stopped.
  • STOPPED - The migration job is currently stopped.
  • DELETED - The migration job has been deleted.
  • UPDATING - The migration job is being updated.
  • STARTING - The migration job is starting.
  • RESTARTING - The migration job is restarting.
  • RESUMING - The migration job is resuming.

static_ip_connectivity

Type: STRUCT
Provider name: staticIpConnectivity
Description: static ip connectivity data (default, no additional details needed).

tags

Type: UNORDERED_LIST_STRING

type

Type: STRING
Provider name: type
Description: Required. The migration job type.
Possible values:

  • TYPE_UNSPECIFIED - The type of the migration job is unknown.
  • ONE_TIME - The migration job is a one time migration.
  • CONTINUOUS - The migration job is a continuous migration.

update_time

Type: TIMESTAMP
Provider name: updateTime
Description: Output only. The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC “Zulu” format, accurate to nanoseconds. Example: “2014-10-02T15:01:23.045123456Z”.

vpc_peering_connectivity

Type: STRUCT
Provider name: vpcPeeringConnectivity
Description: The details of the VPC network that the source database is located in.

  • vpc
    Type: STRING
    Provider name: vpc
    Description: The name of the VPC network to peer with the Cloud SQL private network.
PREVIEWING: guacbot/translation-pipeline