Skip to content

MigrateTaskProps

Properties for defining a MigrateTask.

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

Initializer

import ros_cdk_rds
ros_cdk_rds.MigrateTaskProps(
  backup_mode: typing.Union[str, IResolvable],
  db_instance_id: typing.Union[str, IResolvable],
  db_name: typing.Union[str, IResolvable],
  is_online_db: typing.Union[bool, IResolvable],
  check_db_mode: typing.Union[str, IResolvable] = None,
  oss_object_positions: typing.Union[str, IResolvable] = None,
  oss_urls: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
backup_mode typing.Union[str, ros_cdk_core.IResolvable] Property backupMode: The type of the migration task.
db_instance_id typing.Union[str, ros_cdk_core.IResolvable] Property dbInstanceId: The ID of the instance.
db_name typing.Union[str, ros_cdk_core.IResolvable] Property dbName: The name of the database that you want to restore.
is_online_db typing.Union[bool, ros_cdk_core.IResolvable] Property isOnlineDb: Specifies whether to bring the restored database online for user access.
check_db_mode typing.Union[str, ros_cdk_core.IResolvable] Property checkDbMode: The consistency check method of the database.
oss_object_positions typing.Union[str, ros_cdk_core.IResolvable] Property ossObjectPositions: The information of the backup file in the OSS bucket.
oss_urls typing.Union[str, ros_cdk_core.IResolvable] Property ossUrls: The shared URL of the backup file in the OSS bucket.

backup_modeRequired

backup_mode: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.


db_instance_idRequired

db_instance_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property dbInstanceId: The ID of the instance.


db_nameRequired

db_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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


is_online_dbRequired

is_online_db: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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.


check_db_modeOptional

check_db_mode: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.


oss_object_positionsOptional

oss_object_positions: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.


oss_urlsOptional

oss_urls: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.