MigrationProperties interface
Migration.
Properties
| cancel | Indicates if cancel must be triggered for the entire migration. |
| current |
Current status of a migration. |
| dbs |
When you want to trigger cancel for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array. |
| dbs |
Names of databases to migrate. |
| dbs |
When you want to trigger cutover for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array. |
| migrate |
Indicates if roles and permissions must be migrated. |
| migration |
Identifier of a migration. |
| migration |
Identifier of the private endpoint migration instance. |
| migration |
Mode used to perform the migration: Online or Offline. |
| migration |
Supported option for a migration. |
| migration |
End time (UTC) for migration window. |
| migration |
Start time (UTC) for migration window. |
| overwrite |
Indicates if databases on the target server can be overwritten when already present. If set to 'False', when the migration workflow detects that the database already exists on the target server, it will wait for a confirmation. |
| secret |
Migration secret parameters. |
| setup |
Indicates whether to setup logical replication on source server, if needed. |
| source |
Fully qualified domain name (FQDN) or IP address of the source server. This property is optional. When provided, the migration service will always use it to connect to the source server. |
| source |
Metadata of source database server. |
| source |
Identifier of the source database server resource, when 'sourceType' is 'PostgreSQLSingleServer'. For other source types this must be set to ipaddress:port@username or hostname:port@username. |
| source |
Source server type used for the migration: ApsaraDB_RDS, AWS, AWS_AURORA, AWS_EC2, AWS_RDS, AzureVM, Crunchy_PostgreSQL, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, EDB, EDB_Oracle_Server, EDB_PostgreSQL, GCP, GCP_AlloyDB, GCP_CloudSQL, GCP_Compute, Heroku_PostgreSQL, Huawei_Compute, Huawei_RDS, OnPremises, PostgreSQLCosmosDB, PostgreSQLFlexibleServer, PostgreSQLSingleServer, or Supabase_PostgreSQL |
| ssl |
SSL mode used by a migration. Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'. Default SSL mode for other source types is 'Prefer'. |
| start |
Indicates if data migration must start right away. |
| target |
Fully qualified domain name (FQDN) or IP address of the target server. This property is optional. When provided, the migration service will always use it to connect to the target server. |
| target |
Metadata of target database server. |
| target |
Identifier of the target database server resource. |
| trigger |
Indicates if cutover must be triggered for the entire migration. |
Property Details
cancel
Indicates if cancel must be triggered for the entire migration.
cancel?: string
Property Value
string
currentStatus
dbsToCancelMigrationOn
When you want to trigger cancel for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array.
dbsToCancelMigrationOn?: string[]
Property Value
string[]
dbsToMigrate
Names of databases to migrate.
dbsToMigrate?: string[]
Property Value
string[]
dbsToTriggerCutoverOn
When you want to trigger cutover for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array.
dbsToTriggerCutoverOn?: string[]
Property Value
string[]
migrateRoles
Indicates if roles and permissions must be migrated.
migrateRoles?: string
Property Value
string
migrationId
Identifier of a migration.
migrationId?: string
Property Value
string
migrationInstanceResourceId
Identifier of the private endpoint migration instance.
migrationInstanceResourceId?: string
Property Value
string
migrationMode
Mode used to perform the migration: Online or Offline.
migrationMode?: string
Property Value
string
migrationOption
Supported option for a migration.
migrationOption?: string
Property Value
string
migrationWindowEndTimeInUtc
End time (UTC) for migration window.
migrationWindowEndTimeInUtc?: Date
Property Value
Date
migrationWindowStartTimeInUtc
Start time (UTC) for migration window.
migrationWindowStartTimeInUtc?: Date
Property Value
Date
overwriteDbsInTarget
Indicates if databases on the target server can be overwritten when already present. If set to 'False', when the migration workflow detects that the database already exists on the target server, it will wait for a confirmation.
overwriteDbsInTarget?: string
Property Value
string
secretParameters
Migration secret parameters.
secretParameters?: MigrationSecretParameters
Property Value
setupLogicalReplicationOnSourceDbIfNeeded
Indicates whether to setup logical replication on source server, if needed.
setupLogicalReplicationOnSourceDbIfNeeded?: string
Property Value
string
sourceDbServerFullyQualifiedDomainName
Fully qualified domain name (FQDN) or IP address of the source server. This property is optional. When provided, the migration service will always use it to connect to the source server.
sourceDbServerFullyQualifiedDomainName?: string
Property Value
string
sourceDbServerMetadata
Metadata of source database server.
sourceDbServerMetadata?: DbServerMetadata
Property Value
sourceDbServerResourceId
Identifier of the source database server resource, when 'sourceType' is 'PostgreSQLSingleServer'. For other source types this must be set to ipaddress:port@username or hostname:port@username.
sourceDbServerResourceId?: string
Property Value
string
sourceType
Source server type used for the migration: ApsaraDB_RDS, AWS, AWS_AURORA, AWS_EC2, AWS_RDS, AzureVM, Crunchy_PostgreSQL, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, EDB, EDB_Oracle_Server, EDB_PostgreSQL, GCP, GCP_AlloyDB, GCP_CloudSQL, GCP_Compute, Heroku_PostgreSQL, Huawei_Compute, Huawei_RDS, OnPremises, PostgreSQLCosmosDB, PostgreSQLFlexibleServer, PostgreSQLSingleServer, or Supabase_PostgreSQL
sourceType?: string
Property Value
string
sslMode
SSL mode used by a migration. Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'. Default SSL mode for other source types is 'Prefer'.
sslMode?: string
Property Value
string
startDataMigration
Indicates if data migration must start right away.
startDataMigration?: string
Property Value
string
targetDbServerFullyQualifiedDomainName
Fully qualified domain name (FQDN) or IP address of the target server. This property is optional. When provided, the migration service will always use it to connect to the target server.
targetDbServerFullyQualifiedDomainName?: string
Property Value
string
targetDbServerMetadata
Metadata of target database server.
targetDbServerMetadata?: DbServerMetadata
Property Value
targetDbServerResourceId
Identifier of the target database server resource.
targetDbServerResourceId?: string
Property Value
string
triggerCutover
Indicates if cutover must be triggered for the entire migration.
triggerCutover?: string
Property Value
string