Skip to content

MigrateTask

This class encapsulates and extends the ROS resource type ALIYUN::RDS::MigrateTask, which is used to create a migration task to restore backup files from an Object Storage Service (OSS) bucket to an ApsaraDB RDS for SQL Server instance.

Initializers 

import ros_cdk_rds
ros_cdk_rds.MigrateTask(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No 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.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

backup_modeRequired

  • 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

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

Property dbInstanceId: The ID of the instance.

db_nameRequired

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

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

is_online_dbRequired

  • 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

  • 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

  • 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

  • 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.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

import ros_cdk_rds
ros_cdk_rds.MigrateTask.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_db_name ros_cdk_core.IResolvable Attribute DBName: The name of the database that you want to restore.
attr_migrate_task_id ros_cdk_core.IResolvable Attribute MigrateTaskId: The ID of the migrate task.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_db_nameRequired 

attr_db_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DBName: The name of the database that you want to restore.

attr_migrate_task_idRequired 

attr_migrate_task_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute MigrateTaskId: The ID of the migrate task.