MigrateTask

• Implements: IMigrateTask

This class encapsulates and extends the ROS resource type ALIYUN::RDS::MigrateTask.

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
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

backup_mode^Required

• 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_id^Required

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

Property dbInstanceId: The ID of the instance.

db_name^Required

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

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

is_online_db^Required

• 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_mode^Optional

• 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_positions^Optional

• 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_urls^Optional

• 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_constraint^Optional

• Type: bool

Methods

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

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

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

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

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

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

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_db_name^Required

attr_db_name: typing.Union[str, IResolvable]

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

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

attr_migrate_task_id^Required

attr_migrate_task_id: typing.Union[str, IResolvable]

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

Attribute MigrateTaskId: The ID of the migrate task.

props^Required

props: MigrateTaskProps

• Type: MigrateTaskProps