Skip to content

MigrateTaskProps

Properties for defining a MigrateTask.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-rds-migratetask

Initializer

import { MigrateTaskProps } from '@alicloud/ros-cdk-rds'
const migrateTaskProps: MigrateTaskProps = { ... }

Properties

Name Type Description
backupMode string | @alicloud/ros-cdk-core.IResolvable Property backupMode: The type of the migration task.
dbInstanceId string | @alicloud/ros-cdk-core.IResolvable Property dbInstanceId: The ID of the instance.
dbName string | @alicloud/ros-cdk-core.IResolvable Property dbName: The name of the database that you want to restore.
isOnlineDb boolean | @alicloud/ros-cdk-core.IResolvable Property isOnlineDb: Specifies whether to bring the restored database online for user access.
checkDbMode string | @alicloud/ros-cdk-core.IResolvable Property checkDbMode: The consistency check method of the database.
ossObjectPositions string | @alicloud/ros-cdk-core.IResolvable Property ossObjectPositions: The information of the backup file in the OSS bucket.
ossUrls string | @alicloud/ros-cdk-core.IResolvable Property ossUrls: The shared URL of the backup file in the OSS bucket.

backupModeRequired

public readonly backupMode: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property backupMode: The type of the migration task.

Valid values: FULL: specifies that full backup files are used to restore data. UPDF: specifies that incremental backup files or log files are used to restore incremental data.


dbInstanceIdRequired

public readonly dbInstanceId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbInstanceId: The ID of the instance.


dbNameRequired

public readonly dbName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbName: The name of the database that you want to restore.


isOnlineDbRequired

public readonly isOnlineDb: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property isOnlineDb: Specifies whether to bring the restored database online for user access.

Note The value for SQL Server 2008 R2 is fixed to True.


checkDbModeOptional

public readonly checkDbMode: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property checkDbMode: The consistency check method of the database.

Valid values: SyncExecuteDBCheck: synchronous database check AsyncExecuteDBCheck: asynchronous database check Default value: AsyncExecuteDBCheck (compatible with SQL Server 2008 R2). Note When IsOnlineDB is set to True, this value is valid.


ossObjectPositionsOptional

public readonly ossObjectPositions: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property ossObjectPositions: The information of the backup file in the OSS bucket.

The values consist of three parts that are separated by colons (:): The endpoint of the OSS bucket: oss-ap-southeast-1.aliyuncs.com. The name of the OSS bucket: rdsmssqlsingapore. The key of the backup file in the OSS bucket: autotest_2008R2_TestMigration_FULL.bak. Note This parameter is optional for instances that run SQL Server 2008 R2. This parameter is required for instances that run a database engine later than SQL Server 2008 R2.


ossUrlsOptional

public readonly ossUrls: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property ossUrls: The shared URL of the backup file in the OSS bucket.

The URL must be encoded. If you specify multiple URLs, separate them with vertical bars (|) and then encode them. Note This parameter must be entered for instances that run SQL Server 2008 R2.