Skip to content

MigrationJob2

This class encapsulates and extends the ROS resource type ALIYUN::DTS::MigrationJob2, which is used to purchase a data migration instance and configure a data migration task of the new version.

Initializers

import ros_cdk_dts
ros_cdk_dts.MigrationJob2(
  scope: Construct,
  id: str,
  data_initialization: typing.Union[bool, IResolvable],
  data_synchronization: typing.Union[bool, IResolvable],
  db_list: typing.Union[IResolvable, typing.Mapping[typing.Any]],
  destination_endpoint: typing.Union[IResolvable, DestinationEndpointProperty],
  dts_job_name: typing.Union[str, IResolvable],
  source_endpoint: typing.Union[IResolvable, SourceEndpointProperty],
  structure_initialization: typing.Union[bool, IResolvable],
  checkpoint: typing.Union[str, IResolvable] = None,
  data_check_configure: typing.Union[IResolvable, DataCheckConfigureProperty] = None,
  dedicated_cluster_id: typing.Union[str, IResolvable] = None,
  delay_notice: typing.Union[bool, IResolvable] = None,
  delay_phone: typing.Union[str, IResolvable] = None,
  delay_rule_time: typing.Union[typing.Union[int, float], IResolvable] = None,
  dest_primary_vsw_id: typing.Union[str, IResolvable] = None,
  dest_secondary_vsw_id: typing.Union[str, IResolvable] = None,
  disaster_recovery_job: typing.Union[bool, IResolvable] = None,
  dts_bis_label: typing.Union[str, IResolvable] = None,
  dts_instance_id: typing.Union[str, IResolvable] = None,
  dts_job_id: typing.Union[str, IResolvable] = None,
  error_notice: typing.Union[bool, IResolvable] = None,
  error_phone: typing.Union[str, IResolvable] = None,
  file_oss_url: typing.Union[str, IResolvable] = None,
  max_du: typing.Union[typing.Union[int, float], IResolvable] = None,
  min_du: typing.Union[typing.Union[int, float], IResolvable] = None,
  reserve: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  src_primary_vsw_id: typing.Union[str, IResolvable] = None,
  src_secondary_vsw_id: typing.Union[str, IResolvable] = None,
  status: 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.
data_initialization typing.Union[bool, ros_cdk_core.IResolvable] Property dataInitialization: Specifies whether to perform full data migration or full data synchronization.
data_synchronization typing.Union[bool, ros_cdk_core.IResolvable] Property dataSynchronization: Specifies whether to perform incremental data migration or incremental data synchronization.
db_list typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property dbList: The objects that you want to migrate or synchronize.
destination_endpoint typing.Union[ros_cdk_core.IResolvable, DestinationEndpointProperty] Property destinationEndpoint: Destination instance configuration.
dts_job_name typing.Union[str, ros_cdk_core.IResolvable] Property dtsJobName: The name of the DTS instance.
source_endpoint typing.Union[ros_cdk_core.IResolvable, SourceEndpointProperty] Property sourceEndpoint: Source instance configuration.
structure_initialization typing.Union[bool, ros_cdk_core.IResolvable] Property structureInitialization: Specifies whether to perform schema migration or schema synchronization.
checkpoint typing.Union[str, ros_cdk_core.IResolvable] Property checkpoint: The start offset of incremental data migration or synchronization.
data_check_configure typing.Union[ros_cdk_core.IResolvable, DataCheckConfigureProperty] Property dataCheckConfigure: The data verification task for a data migration or synchronization instance.
dedicated_cluster_id typing.Union[str, ros_cdk_core.IResolvable] Property dedicatedClusterId: The ID of the DTS dedicated cluster on which the task runs.
delay_notice typing.Union[bool, ros_cdk_core.IResolvable] Property delayNotice: Specifies whether to monitor the task latency.
delay_phone typing.Union[str, ros_cdk_core.IResolvable] Property delayPhone: The mobile numbers that receive latency-related alerts.
delay_rule_time typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property delayRuleTime: The threshold for latency alerts.
dest_primary_vsw_id typing.Union[str, ros_cdk_core.IResolvable] Property destPrimaryVswId: The primary VSW ID at the destination end of the VPC NAT.
dest_secondary_vsw_id typing.Union[str, ros_cdk_core.IResolvable] Property destSecondaryVswId: The secondary VSW ID at the destination end of the VPC NAT.
disaster_recovery_job typing.Union[bool, ros_cdk_core.IResolvable] Property disasterRecoveryJob: Specifies whether the instance is a disaster recovery instance.
dts_bis_label typing.Union[str, ros_cdk_core.IResolvable] Property dtsBisLabel: The environment tag of the DTS instance.
dts_instance_id typing.Union[str, ros_cdk_core.IResolvable] Property dtsInstanceId: The ID of the DTS instance.
dts_job_id typing.Union[str, ros_cdk_core.IResolvable] Property dtsJobId: The ID of the DTS task.
error_notice typing.Union[bool, ros_cdk_core.IResolvable] Property errorNotice: Specifies whether to monitor the task status.
error_phone typing.Union[str, ros_cdk_core.IResolvable] Property errorPhone: The mobile numbers that receive status-related alerts.
file_oss_url typing.Union[str, ros_cdk_core.IResolvable] Property fileOssUrl: The URL of the Object Storage Service (OSS) bucket that stores the files related to the DTS task.
max_du typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property maxDu: The upper limit of DU.
min_du typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property minDu: The lower limit of DU.
reserve typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property reserve: The reserved parameter of DTS.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group.
src_primary_vsw_id typing.Union[str, ros_cdk_core.IResolvable] Property srcPrimaryVswId: The primary VSW ID at the source end of the VPC NAT.
src_secondary_vsw_id typing.Union[str, ros_cdk_core.IResolvable] Property srcSecondaryVswId: The secondary VSW ID at the source end of the VPC NAT.
status typing.Union[str, ros_cdk_core.IResolvable] Property status: The status of the resource.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

data_initializationRequired

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

Property dataInitialization: Specifies whether to perform full data migration or full data synchronization.

Default value: true. Valid values: true and false.


data_synchronizationRequired

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

Property dataSynchronization: Specifies whether to perform incremental data migration or incremental data synchronization.

Default value: false. Valid values: true and false.


db_listRequired

  • Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property dbList: The objects that you want to migrate or synchronize.


destination_endpointRequired

Property destinationEndpoint: Destination instance configuration.


dts_job_nameRequired

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

Property dtsJobName: The name of the DTS instance.


source_endpointRequired

Property sourceEndpoint: Source instance configuration.


structure_initializationRequired

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

Property structureInitialization: Specifies whether to perform schema migration or schema synchronization.

Default value: true. Valid values: true and false.


checkpointOptional

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

Property checkpoint: The start offset of incremental data migration or synchronization.

This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.


data_check_configureOptional

Property dataCheckConfigure: The data verification task for a data migration or synchronization instance.


dedicated_cluster_idOptional

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

Property dedicatedClusterId: The ID of the DTS dedicated cluster on which the task runs.


delay_noticeOptional

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

Property delayNotice: Specifies whether to monitor the task latency.

Valid values: true and false


delay_phoneOptional

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

Property delayPhone: The mobile numbers that receive latency-related alerts.

Separate multiple mobile numbers with commas (,). You can specify up to 10 mobile numbers. Note: You can also configure alert rules for DTS tasks in the CloudMonitor console.This parameter is available only for users of the China site (aliyun.com). Only mobile numbers in the Chinese mainland are supported. Users of the international site (alibabacloud.com) cannot receive alerts by using mobile numbers.


delay_rule_timeOptional

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

Property delayRuleTime: The threshold for latency alerts.

Unit: seconds. You can set the threshold based on your business requirements. To prevent jitters caused by network and database overloads, we recommend that you set the threshold to more than 10 seconds.


dest_primary_vsw_idOptional

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

Property destPrimaryVswId: The primary VSW ID at the destination end of the VPC NAT.


dest_secondary_vsw_idOptional

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

Property destSecondaryVswId: The secondary VSW ID at the destination end of the VPC NAT.


disaster_recovery_jobOptional

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

Property disasterRecoveryJob: Specifies whether the instance is a disaster recovery instance.

Valid values: true and false


dts_bis_labelOptional

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

Property dtsBisLabel: The environment tag of the DTS instance.

Valid values: normal and online.


dts_instance_idOptional

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

Property dtsInstanceId: The ID of the DTS instance.


dts_job_idOptional

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

Property dtsJobId: The ID of the DTS task.


error_noticeOptional

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

Property errorNotice: Specifies whether to monitor the task status.

Valid values: true and false.


error_phoneOptional

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

Property errorPhone: The mobile numbers that receive status-related alerts.

Separate multiple mobile numbers with commas (,). You can specify up to 10 mobile numbers. Note: You can also configure alert rules for DTS tasks in the CloudMonitor console.This parameter is available only for users of the China site (aliyun.com). Only mobile numbers in the Chinese mainland are supported. Users of the international site (alibabacloud.com) cannot receive alerts by using mobile numbers.


file_oss_urlOptional

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

Property fileOssUrl: The URL of the Object Storage Service (OSS) bucket that stores the files related to the DTS task.


max_duOptional

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

Property maxDu: The upper limit of DU.

This parameter is supported only for serverless instances.


min_duOptional

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

Property minDu: The lower limit of DU.

This parameter is supported only for serverless instances.


reserveOptional

  • Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property reserve: The reserved parameter of DTS.

You can specify this parameter to add more configurations of the source or destination instance to the DTS task. For example, you can specify the data storage format of the destination Kafka database and the ID of the CEN instance.


resource_group_idOptional

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

Property resourceGroupId: The ID of the resource group.


src_primary_vsw_idOptional

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

Property srcPrimaryVswId: The primary VSW ID at the source end of the VPC NAT.


src_secondary_vsw_idOptional

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

Property srcSecondaryVswId: The secondary VSW ID at the source end of the VPC NAT.


statusOptional

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

Property status: The status of the resource.

Valid values:

  • Migrating: Start the task.
  • Suspending: Suspend the task.
  • Stopping: Stop the task.

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.
fetch_condition No description.
fetch_dependency No description.
fetch_resource_desc 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

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

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_dts
ros_cdk_dts.MigrationJob2.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.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
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_dts_instance_id typing.Union[str, ros_cdk_core.IResolvable] Attribute DtsInstanceId: The ID of the DTS instance.
attr_dts_job_id typing.Union[str, ros_cdk_core.IResolvable] Attribute DtsJobId: The ID of the task.
attr_dts_job_name typing.Union[str, ros_cdk_core.IResolvable] Attribute DtsJobName: The name of the DTS job.
props MigrationJob2Props No description.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


envRequired

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.


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_dts_instance_idRequired

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

Attribute DtsInstanceId: The ID of the DTS instance.


attr_dts_job_idRequired

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

Attribute DtsJobId: The ID of the task.


attr_dts_job_nameRequired

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

Attribute DtsJobName: The name of the DTS job.


propsRequired

props: MigrationJob2Props